{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API 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":"api-integration-overview","__idx":0},"children":["API Integration Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use-api-integration","__idx":1},"children":["When to use API integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Choose API integration if you need any of the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}," — real-time order status notifications pushed to your endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Quote UI"]}," — show customers a price comparison within your own interface before they enter checkout."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["KYC sharing"]}," — pass verified customer identity data to Banxa to reduce checkout friction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Order history"]}," — look up past orders programmatically."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Programmatic control"]}," — control which payment methods, currencies, and crypto assets are presented to each customer."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-groups","__idx":2},"children":["API groups"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Banxa v2 API is organised into the following groups:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"order-api","__idx":3},"children":["Order API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create buy and sell orders from your backend. Returns a checkout URL to redirect or embed for the customer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /{partnerRef}/v2/buy"]}," · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /{partnerRef}/v2/sell"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"quote-api","__idx":4},"children":["Quote API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve current pricing for any combination of crypto, fiat, and payment method. Call this before every order to ensure customers see accurate pricing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/quotes/{orderType}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"payment-methods-api","__idx":5},"children":["Payment Methods API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the full list of payment methods available to your customers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/payment-methods"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"countries--currencies-api","__idx":6},"children":["Countries & Currencies API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve supported countries, fiat currencies, and cryptocurrencies."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/countries"]}," · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/fiats"]}," · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/crypto"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"identity-api","__idx":7},"children":["Identity API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Share verified KYC data with Banxa before order creation to streamline the checkout experience for returning customers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /{partnerRef}/v2/identities/token/share"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-buy-on-ramp-flow","__idx":8},"children":["Typical buy (on-ramp) flow"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"1. GET  /v2/quotes          → Show customer a price\n2. POST /v2/buy             → Create order, receive checkoutUrl\n3. Redirect customer        → To checkoutUrl (redirect or iFrame)\n4. Webhook notification     → Banxa POSTs order status to your endpoint\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ Detailed steps: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/get-a-quote"},"children":["Get a Quote"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/create-buy-order"},"children":["Create Buy Order"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/redirecting-to-checkout"},"children":["Redirecting to Checkout"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-sell-off-ramp-flow","__idx":9},"children":["Typical sell (off-ramp) flow"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"1. GET  /v2/quotes          → Show customer a price\n2. POST /v2/sell            → Create order, receive checkoutUrl\n3. Redirect customer        → To checkoutUrl (redirect or iFrame)\n4. Webhook notification     → Banxa POSTs order status to your endpoint\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ Detailed steps: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/create-sell-order"},"children":["Create Sell Order"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":10},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All v2 API requests require your API key in the request header:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"x-api-key: YOUR_API_KEY\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The identity endpoint uses HMAC authentication. → See ",{"$$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":"base-urls","__idx":11},"children":["Base URLs"]},{"$$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":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.banxa-sandbox.com/{partnerRef}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.banxa.com/{partnerRef}"]}]}]}]}]}]}]},"headings":[{"value":"API Integration Overview","id":"api-integration-overview","depth":1},{"value":"When to use API integration","id":"when-to-use-api-integration","depth":2},{"value":"API groups","id":"api-groups","depth":2},{"value":"Order API","id":"order-api","depth":3},{"value":"Quote API","id":"quote-api","depth":3},{"value":"Payment Methods API","id":"payment-methods-api","depth":3},{"value":"Countries & Currencies API","id":"countries--currencies-api","depth":3},{"value":"Identity API","id":"identity-api","depth":3},{"value":"Typical buy (on-ramp) flow","id":"typical-buy-on-ramp-flow","depth":2},{"value":"Typical sell (off-ramp) flow","id":"typical-sell-off-ramp-flow","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Base URLs","id":"base-urls","depth":2}],"frontmatter":{"title":"Banxa REST API Integration Overview | Banxa Docs","description":"Integrate Banxa via REST API for full control over quotes, orders, webhooks, and KYC sharing. Covers all v2 endpoint groups and typical buy/sell flows.","seo":{"title":"API Integration Overview"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/api-integration/api-integration-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}