{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["cards","card","admonition","code-group"]},"type":"markdown"},"seo":{"title":"Banxa Hosted Checkout","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":"banxa-hosted-checkout","__idx":0},"children":["Banxa Hosted Checkout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Banxa handles KYC, payment processing, and regulatory compliance — your platform redirects users to the Banxa checkout or embeds it. Three integration paths, from a simple URL redirect to a full React Native SDK."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Best for:"]}," Wallets, dApps, gaming platforms, and any team where time-to-market is the priority."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-paths","__idx":1},"children":["Integration paths"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Three ways to integrate. Choose based on your platform and how much backend work you want to do."]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Referral","icon":"solid link","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"elevated","to":"/products/hosted-checkout/docs/referral-integration/overview"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Construct a Banxa URL with your parameters and redirect the customer — or embed as an iFrame. No backend required. Pre-fills crypto, fiat, amount, and wallet address."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Best for simple integrations, browser extensions, or any scenario without a backend."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"API","icon":"solid server","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"elevated","to":"/products/hosted-checkout/docs/api-integration/api-integration-overview"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create orders server-side. Fetch live quotes in your own UI, create buy or sell orders, and redirect the customer to the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["checkoutUrl"]},". Receive order updates via webhooks."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Best for integrations that need quote visibility, webhook-driven tracking, or KYC sharing."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"React Native SDK","icon":"solid mobile-screen","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"elevated","to":"/products/hosted-checkout/docs/sdk-integration/overview"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A React Native wrapper around the Checkout API. Handles WebView configuration, return URL detection, and error handling. No backend required for core flows."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Best for mobile apps that want Banxa checkout embedded in-app."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-banxa-handles","__idx":2},"children":["What Banxa handles"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":280},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"KYC & Identity","icon":"solid id-card","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Document verification, liveness checks, and returning customer recognition — handled inside the Banxa checkout flow."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Payments","icon":"solid credit-card","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card, bank transfer, Apple Pay, Google Pay, and local payment methods across global markets."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Compliance & AML","icon":"solid shield-halved","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sanctions screening, transaction monitoring, and ongoing compliance — Banxa's obligation, not yours."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Settlement","icon":"solid rotate","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fiat purchase and crypto delivery managed by Banxa. Your platform receives the confirmed transaction result."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-start","__idx":3},"children":["Before you start"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"What you need from Banxa"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A partner ID (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerRef"]},") used in all API endpoint paths, an API key for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}," authentication, and a separate set of sandbox credentials. → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/getting-started/access-and-setup"},"children":["Access & Setup"]}]}]},{"$$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":{"align":"left","data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.banxa-sandbox.com/{partnerRef}/v2/"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.banxa.com/{partnerRef}/v2/"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always build and test against sandbox before going live. → ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/getting-started/authentication-and-environments"},"children":["Authentication & Environments"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference","__idx":4},"children":["Reference"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"API Reference","icon":"solid book","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost","to":"/products/hosted-checkout/openapi"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full endpoint reference — request schemas, response shapes, error codes."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Supported Payment Methods","icon":"solid wallet","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost","to":"/products/hosted-checkout/docs/reference/supported-payment-methods"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All supported payment methods by country and transaction type."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Supported Crypto & Blockchains","icon":"solid cubes","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost","to":"/products/hosted-checkout/docs/reference/supported-cryptocurrencies-and-blockchains"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All supported cryptocurrencies and blockchain networks."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Integration Best Practices","icon":"solid list-check","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"start","variant":"ghost","to":"/products/hosted-checkout/docs/getting-started/integration-best-practices"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Error handling, idempotency, webhook validation, and production checklist."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-start","__idx":5},"children":["Quick start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a buy order and redirect the customer to the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["checkoutUrl"]},". Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCustomerId"]}," to enable returning customer recognition."]},{"$$mdtype":"Tag","name":"CodeGroup","attributes":{"mode":"tabs"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Create a buy order","header":{"title":"Create a buy order","controls":{"copy":{}}},"source":"curl -X POST \"https://api.banxa.com/{partnerRef}/v2/buy\" \\\n  -H \"x-api-key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"crypto\": \"ETH\",\n    \"fiat\": \"USD\",\n    \"fiatAmount\": \"100\",\n    \"walletAddress\": \"0xe3BDEFdAeFF070925eB7FfC49F9B30c647Cb751e\",\n    \"redirectUrl\": \"https://yourapp.com/success\",\n    \"externalCustomerId\": \"user-abc123\"\n  }'\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redirect the customer to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["checkoutUrl"]}," in the response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"3b7f1c9d2b4a8e6f5d0c7a2b3f9e1d4c\",\n  \"checkoutUrl\": \"https://pay.banxa.com/checkout/3b7f1c9d...\",\n  \"externalCustomerId\": \"user-abc123\",\n  \"fiat\": \"USD\",\n  \"fiatAmount\": \"100.00\",\n  \"crypto\": \"ETH\",\n  \"blockchain\": \"ETHEREUM\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/api-integration-overview"},"children":["Full API Integration guide"]}]}]},"headings":[{"value":"Banxa Hosted Checkout","id":"banxa-hosted-checkout","depth":1},{"value":"Integration paths","id":"integration-paths","depth":2},{"value":"What Banxa handles","id":"what-banxa-handles","depth":2},{"value":"Before you start","id":"before-you-start","depth":2},{"value":"Reference","id":"reference","depth":2},{"value":"Quick start","id":"quick-start","depth":2}],"frontmatter":{"title":"Banxa Hosted Checkout","description":"Hosted checkout infrastructure for partners who want to go live quickly without building compliance or payment infrastructure.","seo":{"title":"Banxa Hosted Checkout"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}