API Integration Overview

For the complete documentation index, see llms.txt. Append .md to any page URL for its markdown version.

The API integration gives you full programmatic control over the Banxa checkout experience. You make server-to-server REST API calls to fetch quotes, create orders, and manage your integration. The checkout URL is returned in the order response, and you redirect or embed it from there.

Choose API integration if you need any of the following:

• Webhooks — real-time order status notifications pushed to your endpoint.
• Quote UI — show customers a price comparison within your own interface before they enter checkout.
• KYC sharing — pass verified customer identity data to Banxa to reduce checkout friction.
• Order history — look up past orders programmatically.
• Programmatic control — control which payment methods, currencies, and crypto assets are presented to each customer.

The Banxa v2 API is organised into the following groups:

Create buy and sell orders from your backend. Returns a checkout URL to redirect or embed for the customer.

POST /{partnerRef}/v2/buy · POST /{partnerRef}/v2/sell

Retrieve current pricing for any combination of crypto, fiat, and payment method. Call this before every order to ensure customers see accurate pricing.

GET /{partnerRef}/v2/quotes/{orderType}

Retrieve the payment methods (buy) or payout methods (sell) available to your customers.

GET /{partnerRef}/v2/payment-methods/{orderType}

Retrieve supported countries, fiat currencies, and cryptocurrencies.

GET /{partnerRef}/v2/countries · GET /{partnerRef}/v2/fiats/{orderType} · GET /{partnerRef}/v2/crypto/{orderType}

{orderType} is buy or sell. If you leave it out, these endpoints and the Quote API return buy data, so always pass sell when you build a sell flow. The countries list is the same for buy and sell.

Share verified KYC data with Banxa before order creation to streamline the checkout experience for returning customers.

POST /{partnerRef}/v2/identities/token/share

1. GET  /v2/quotes/buy      → Show customer a price
2. POST /v2/buy             → Create order, receive checkoutUrl
3. Redirect customer        → To checkoutUrl (redirect or iFrame)
4. Webhook notification     → Banxa POSTs order status to your endpoint

→ Detailed steps: Get a Quote · Create Buy Order · IP Binding · Redirecting to Checkout

1. GET  /v2/quotes/sell     → Show customer a price
2. POST /v2/sell            → Create order, receive checkoutUrl
3. Redirect customer        → To checkoutUrl (redirect or iFrame)
4. Crypto is sent to Banxa  → By the customer, your wallet app, or your platform,
                              depending on your account's fulfilment flow
5. Webhook notification     → Banxa POSTs order status to your endpoint

In the custodial flow, step 4 is your platform: get the deposit address from GET /v2/orders/{orderId}, send the crypto, then call POST /v2/orders/{orderId}/confirm. → See Custodial vs. Non-Custodial.

→ Detailed steps: Get a Quote · Create Sell Order · IP Binding · Redirecting to Checkout

Both directions use the same authentication, checkout URL handling and webhooks. These are the differences:

→ Statuses: Order Statuses · Referral sell links: Supported Parameters

All v2 API requests require your API key in the request header:

x-api-key: YOUR_API_KEY

The identity endpoint uses HMAC authentication. → See Authentication & Environments.