Skip to main content

Using Hubpay docs with AI coding tools

AI coding tools can help scaffold a Hubpay integration, but they need the current API contract and the guide for the product area you are building. Do not rely on endpoint names or request fields recalled from model training.

Ask from any documentation page​

Use the Ask AI button in the bottom-right corner of any page to open a page-aware prompt in ChatGPT, Claude, Perplexity or Gemini, or copy it for another assistant. The prompt includes the current public page plus the sources below, asks the assistant to recommend the right Hubpay product area, and requests a practical implementation and testing checklist.

Only the canonical public page URL, title and description are included. Query strings, page content, form values, credentials, account data and payment data are never added to the prompt.

Give the tool these sources​

Start with:

  1. llms.txt for a concise map of the documentation
  2. The OpenAPI 3.1 specification for endpoints, request fields and response schemas
  3. Get started for environments, authentication and the first sandbox request
  4. The guide for the relevant area: payments, accounts and onboarding, banking and money movement, or connected apps

The OpenAPI document is the authoritative source for the API contract. The guides explain product flows, security decisions and the order in which calls should be made.

Prompt for Claude Code​

Replace the bracketed values and paste this into Claude Code from your application repository:

Implement a Hubpay Connect integration for [describe the customer journey].

Read these sources before changing code:
- https://docs.hubpay.io/llms.txt
- https://docs.hubpay.io/openapi.json
- https://docs.hubpay.io/docs/guides/intro/
- [paste the relevant Hubpay product guide URL]

Use https://sandbox-api.hubpay.io while developing. Keep the client secret and
bearer token in server-side code. Follow the OpenAPI request and response schemas
exactly. Verify webhook signatures and confirm final state from the API before
triggering fulfilment. Do not invent endpoints, fields or grant scopes.

First explain the proposed flow and list the Hubpay endpoints it needs. Then
implement it using this repository's existing conventions and add tests for
authentication failures, validation errors, webhook verification and retries.

Review generated code​

Before using generated code, check that it:

  • Exchanges credentials from a trusted backend
  • Never exposes a client secret or bearer token to a browser or mobile client
  • Uses the correct sandbox base URL and account context
  • Matches the current OpenAPI request and response schemas
  • Verifies webhook signatures before processing an event
  • Handles duplicate events, retries, pagination and 429 responses
  • Confirms payment or onboarding state before updating your own system

Use the API reference to check every endpoint used by the implementation.