Connect your AI assistant

Use an AI assistant to inspect your NexPay records and ask questions about the API. The connection acts as your signed-in account and uses its current permissions.

Server URL

https://api.nexpay.com.au/v2/mcp

Choose OAuth authentication. Customers do not need to create an API key, paste credentials or supply OAuth client credentials. Sign in with your normal NexPay account when prompted, then review and approve the connection.

Claude

In Claude, open Settings → Customize → Connectors.
Choose Add connector → Add custom connector.
Enter NexPay as the name and paste the server URL, then choose Continue.
On the second screen, select Sign in now and Register automatically. Leave request headers empty, then choose Add.
Sign in to NexPay, review the account and read access, and approve the connection.
Start a conversation with NexPay enabled and ask: Show my payment-intent status counts.

Workspace administrators may need to enable custom connectors. See Claude’s current setup guide.

ChatGPT

In ChatGPT, open Settings → Apps → Advanced settings → Developer mode, then create an app using the NexPay server URL and OAuth. Complete the NexPay sign-in and consent screen. Availability depends on your plan and workspace permissions. See OpenAI’s current setup guide.

Other assistants

Choose Other in the NexPay setup modal for general connection steps. Your assistant must support remote MCP servers using Streamable HTTP and OAuth sign-in.

Find custom connectors or MCP servers in your assistant’s settings.
Add a remote server named NexPay using the server URL above.
Choose OAuth or secure sign-in. If prompted for a client registration method, select automatic registration; NexPay supports dynamic client registration.
Complete NexPay sign-in, review the account and read access, and approve.
Enable the connection in your assistant. Exact labels vary by assistant.

Available tools

The launch catalog covers payment-intent lists, details and status counts; students, employees, payers and payees; commissions and outstanding totals; settlements and inbound payments; conversations; existing reports; organization profiles; FX rates; country and payment-method lookups; and sourced API documentation.

Report lists and downloads require a linked organization account. Individual accounts retain their owner-scoped records and cannot read organization exports.

Integrators can read the standard server descriptor. MCP initialization also advertises the NexPay logo as public 192px and 512px PNGs on the API's own origin. Logo display depends on the assistant's support for icon metadata. The descriptor does not imply a listing in any assistant's directory.

The connection cannot create, submit or cancel payments, request withdrawals, send messages or change customer records. Payment-intent detail reads may refresh status from the connector. Bearer payment links, bank-routing details and execution plans are excluded from conversational results.

Amount values retain NexPay’s REST major units, such as 99.99; recipient shares use basis points (10000 means 100%). List count is the current page size. Use total when provided, or aggregate tools for totals.

Disconnect

Open Claude & ChatGPT from your NexPay profile menu, or choose Claude & ChatGPT in the homepage’s Others section. Under Connected assistants, choose Disconnect. Access and refresh tokens for that connection are immediately revoked. You can also remove the connector from your assistant.

Developer access

The same endpoint accepts X-API-Key: clientId:secret for developer clients. This keeps the API key’s existing identity and permissions. MCP bearer tokens are restricted to this MCP endpoint and cannot authenticate ordinary REST calls.

The transport is stateless: POST handles JSON-RPC and GET/DELETE return 405. GET /v2/mcp/health returns health and the registered tool count. Clients send Accept: application/json, text/event-stream and Content-Type: application/json.

Troubleshooting

No sign-in window: reconnect the assistant and ensure custom connectors are enabled.
Expired connection: restart sign-in. Reused refresh tokens revoke their whole connection.
No records: verify the connected account and its permissions. Results remain account-scoped.
Documentation unavailable: retry; the tool reports an outage separately from no matching pages.
Too many requests: retry after one minute.

Agents can use the connection prompt, model instructions, and documentation corpus.