Choose Your Integration Method

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

There are three ways to integrate Banxa Hosted Checkout. The right choice depends on your platform, backend capability, and which features you need.

You construct a Banxa URL with query parameters and redirect the customer to it. No API calls required.

Best for:

• Teams that want to integrate quickly with minimal backend work.
• Use cases where you don't need real-time order status in your own system.
• Integrations where KYC sharing is not required.

What you get:

• A Banxa-hosted checkout pre-populated with your parameters (wallet address, crypto, fiat, amount, etc.).
• Co-branding and customisation via dashboard settings.

Limitations:

• No webhooks for order status notifications.
• No quote comparison within your own UI before checkout.
• No KYC sharing.

→ See Referral Integration.

You make server-to-server calls to Banxa to fetch quotes, create orders, and receive webhook notifications. The checkout URL is returned in the order creation response, and you redirect or embed it.

Best for:

• Teams that need real-time order status updates via webhooks.
• Integrations that want to display a quote comparison within their own UI before checkout.
• Use cases where KYC sharing would improve conversion.
• Integrations needing programmatic control over payment methods, fiat/crypto options, and customer data.

What you get:

• Full access to all Banxa APIs: Quote, Order, Payment Methods, Countries, Currencies, and Identity.
• Webhooks for real-time order status updates.
• KYC sharing to reduce friction for returning customers.
• Ability to build a pre-checkout quote flow within your own UI.

Considerations:

• Your API key must be kept secret — avoid exposing it in client-side code or public repositories.
• More implementation effort than Referral.

→ See API Integration.

Three mobile SDKs wrap Banxa Hosted Checkout: React Native, iOS, and Android. Each is configured with your API key and presents the checkout in-app, with no backend required for core flows.

Best for:

• Mobile apps on React Native, native iOS, or native Android.
• Teams that want faster integration than wiring up API calls manually.
• Apps where you want the SDK to handle checkout presentation and return URL detection.

What you get:

• Typed methods for quotes, payment methods, currencies, and countries.
• Checkout presentation handled for you. React Native gives you a CheckoutWebView component to render; iOS and Android are headless and present checkout internally.
• Same x-api-key auth as the API, so no backend is required.

Limitations:

• Mobile only. For web, use Referral or API.
• No KYC sharing. That requires HMAC authentication, which the SDKs do not use.
• Order lookup is limited. React Native supports lookup by id or customer; iOS and Android do not expose order lookup at all. Use the API or webhooks.
• Buy orders only. Sell orders go through the API.

→ See SDK Integration.

Choose Referral if you want the fastest possible integration and don't need webhooks or in-app quotes.

Choose API if you need webhooks, want to show customers a quote before checkout, or have an existing KYC process you want to share with Banxa.

Choose a mobile SDK if you're building a React Native, iOS, or Android app and want a typed interface without wiring up API calls manually.

All three methods can be used with either Redirect or iFrame checkout visualisation, except the SDKs, which handle checkout presentation themselves.