{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Referral Integration Overview","description":"Official Banxa API documentation – on-ramp and off-ramp transfers with identity verification and compliance.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"referral-integration-overview","__idx":0},"children":["Referral Integration Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Referral integration is the fastest way to embed Banxa into your product. You construct a URL with parameters, redirect your customer to it, and Banxa handles the entire checkout experience."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no server-to-server API calls. No backend is required."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":1},"children":["How it works"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n A([Customer ready\\nto transact]) --> B[Partner constructs\\nreferral URL]\n B --> C[Redirect customer\\nto URL]\n C --> D[Banxa-hosted checkout\\nKYC + payment]\n D --> E([Customer redirected\\nto redirectUrl])\n","diagramHtml":"

Customer ready
to transact

Partner constructs
referral URL

Redirect customer
to URL

Banxa-hosted checkout
KYC + payment

Customer redirected
to redirectUrl

","diagramHtmlDark":"

Customer ready
to transact

Partner constructs
referral URL

Redirect customer
to URL

Banxa-hosted checkout
KYC + payment

Customer redirected
to redirectUrl

"},"children":["flowchart LR\n A([Customer ready\\nto transact]) --> B[Partner constructs\\nreferral URL]\n B --> C[Redirect customer\\nto URL]\n C --> D[Banxa-hosted checkout\\nKYC + payment]\n D --> E([Customer redirected\\nto redirectUrl])\n"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Banxa provides you with a base referral URL tied to your partner account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You append query parameters to pre-populate the checkout state (wallet address, crypto, fiat, amount, etc.)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When a customer is ready to transact, redirect them to the constructed URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The customer completes their transaction on the Banxa-hosted checkout."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On completion, the customer is returned to your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUrl"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can display this checkout as a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["full redirect"]}," (new tab or same window) or within an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["iFrame"]}," embedded in your application."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use-referral","__idx":2},"children":["When to use Referral"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Choose Referral if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You want to go live quickly with minimal backend work."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You don't need real-time order status notifications (webhooks)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You don't need to show a quote comparison within your own UI."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["KYC sharing is not required."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If any of those are requirements, use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/api-integration-overview"},"children":["API integration"]}," instead."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":3},"children":["Limitations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Feature"},"children":["Feature"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Referral"},"children":["Referral"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quote UI in your app"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["KYC sharing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order history lookup"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Backend required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":4},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/referral-integration/constructing-referral-urls"},"children":["Constructing Referral URLs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/referral-integration/supported-parameters"},"children":["Supported Parameters"]}]}]}]},"headings":[{"value":"Referral Integration Overview","id":"referral-integration-overview","depth":1},{"value":"How it works","id":"how-it-works","depth":2},{"value":"When to use Referral","id":"when-to-use-referral","depth":2},{"value":"Limitations","id":"limitations","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Banxa Referral Integration Overview | Banxa Docs","description":"Integrate Banxa with no backend required. Construct a partner URL with query parameters and redirect customers to the Banxa-hosted checkout flow.","seo":{"title":"Referral Integration Overview"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/referral-integration/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}