Referral vs API

This decision determines how your backend communicates with Banxa. It is independent of your checkout visualisation choice (iFrame vs. Redirect).

Referral

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 access to webhooks for order status notifications.
• No ability to show a quote comparison within your own UI before the customer enters the checkout.
• No KYC sharing.

→ See Referral Integration.

API

You make server-to-server REST API 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 from there.

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 supported 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.

Comparison

Decision guide

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.

Both methods can be used with either Redirect or iFrame checkout visualisation.