{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"On-Ramp Overview","description":"Official Banxa API documentation – on-ramp and off-ramp transfers with identity verification and compliance.","llmstxt":{"title":"Banxa Developer Documentation","description":"Integrate crypto-fiat exchange with Banxa's licensed infrastructure: payments, KYC, compliance, and settlement handled. 150+ countries, 45 global licences.","details":{"content":"Two integration products: **Banxa Native API** for partners who manage their own KYC and want full UX control (headless, HMAC server-to-server, no Banxa-hosted screens); **Banxa Hosted Checkout** for partners who want Banxa to handle KYC and payments (three paths: Referral URL, API, or React Native SDK). Both use the same sandbox and production environments at `https://api.banxa-sandbox.com` and `https://api.banxa.com`.\n\n## Constraints\n\n- **Authentication**: HMAC credentials must be stored server-side only, never expose in frontend, mobile, or client-side code. HMAC is required for all Native API calls and for KYC sharing in Hosted Checkout; `x-api-key` is used for all other Hosted Checkout endpoints.\n- **`externalCustomerId`**: Required on every buy and sell order. Use a stable opaque identifier, never PII.\n- **`identityReference`**: Must remain constant for the same user across all requests. Must not contain PII. If you attempt to create an identity for an email that already exists, you will receive a 422 / code 81, so retrieve the existing record rather than retrying creation. Use `GET /eapi/v0/identities/{identityReference}?email=user@example.com` to look up the real `identityReference` linked to an email.\n- **`quoteId`**: Only supported by `POST /eapi/v0/ramps` (bank transfer). The React Native SDK and Embedded Payment Button do not accept a `quoteId`, so use indicative pricing (`GET /eapi/v0/price`) for SDK and Embedded Payment Button flows.\n- **Quotes**: Indicative prices are not rate-locked, so refresh close to order creation to minimise rate drift. Locked quotes (`GET /eapi/v0/quote`) expire after approximately 3 minutes and are only valid for bank transfer ramp creation.\n- **Eligibility gate**: Never create a ramp or invoke the SDK when `paymentReady` is `false`. Always check eligibility and satisfy all requirements before payment execution.\n- **Webhooks**: Verify all inbound webhook signatures with HMAC-SHA256 before processing. Return HTTP 200 immediately and process asynchronously.\n- **Product selection**: Banxa Native is for partners who manage their own KYC. Banxa Hosted Checkout is for partners who do not do KYC. These are separate products with separate flows: do not mix endpoints across products.\n- **SDK scope**: The React Native SDK has no `banxa.customerIdentity` module. Identity and KYC are handled through the Native API only. `primerCallbacks` and `primerSettings` are Native context only and must not be referenced in Hosted Checkout integrations.\n- **Payment method naming**: Never use \"eAPI\" or \"EAPI\" as a product name. The correct name is \"Banxa Native API\". The URL path prefix `/eapi/` is correct and should not be changed.\n"},"hide":false,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"on-ramp-overview","__idx":0},"children":["On-Ramp Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On-ramp refers to the process of converting fiat currency into cryptocurrency. Banxa acts as the payment processor and crypto exchange, handling payments, compliance, and crypto delivery on your behalf."]},{"$$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 TD\n A([Customer initiates buy]) --> B[\"GET /v2/quotes/{orderType}
Fetch live quote\"]\n B --> C[\"POST /v2/buy
Create order → checkoutUrl\"]\n C --> D[Redirect or embed checkoutUrl]\n D --> E[Customer completes checkout
KYC + payment]\n E --> F[Banxa processes payment
and delivers crypto to wallet]\n F --> G[Customer redirected to redirectUrl]\n G --> H([Webhook: order status updates])\n","diagramHtml":"

Customer initiates buy

GET /v2/quotes/{orderType}
Fetch live quote

POST /v2/buy
Create order → checkoutUrl

Redirect or embed checkoutUrl

Customer completes checkout
KYC + payment

Banxa processes payment
and delivers crypto to wallet

Customer redirected to redirectUrl

Webhook: order status updates

","diagramHtmlDark":"

Customer initiates buy

GET /v2/quotes/{orderType}
Fetch live quote

POST /v2/buy
Create order → checkoutUrl

Redirect or embed checkoutUrl

Customer completes checkout
KYC + payment

Banxa processes payment
and delivers crypto to wallet

Customer redirected to redirectUrl

Webhook: order status updates

"},"children":["flowchart TD\n A([Customer initiates buy]) --> B[\"GET /v2/quotes/{orderType}
Fetch live quote\"]\n B --> C[\"POST /v2/buy
Create order → checkoutUrl\"]\n C --> D[Redirect or embed checkoutUrl]\n D --> E[Customer completes checkout
KYC + payment]\n E --> F[Banxa processes payment
and delivers crypto to wallet]\n F --> G[Customer redirected to redirectUrl]\n G --> H([Webhook: order status updates])\n"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your customer selects a crypto asset and enters the amount they want to spend in their local currency."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["They complete identity verification (KYC) if required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["They pay using their preferred payment method (card, bank transfer, Apple Pay, etc.)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Banxa processes the payment and delivers the purchased crypto to the customer's wallet address."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The customer's wallet address is provided at order creation — either by you (via the API or referral URL) or by the customer in the checkout flow."]},{"$$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":"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":"Responsibility"},"children":["Responsibility"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card, bank transfers, Apple Pay, Google Pay, and local payment methods"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["KYC / AML compliance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identity verification, document collection, sanctions screening"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Crypto liquidity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exchange rate sourcing and crypto delivery"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Regulatory coverage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Licences and compliance obligations in supported jurisdictions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer support"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction disputes, payment issues, and KYC queries"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-payment-methods","__idx":3},"children":["Supported payment methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment method availability depends on the customer's country and your partner configuration. Retrieve the full list of available methods using:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{partnerRef}/v2/payment-methods\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Common methods include: debit/credit card, Apple Pay, Google Pay, SEPA, GBP bank transfer, ACH, PayID, UPI, PIX, and PayPal."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-currencies-and-crypto","__idx":4},"children":["Supported currencies and crypto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the full lists from the API:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{partnerRef}/v2/fiats → supported fiat currencies\nGET /{partnerRef}/v2/crypto → supported cryptocurrencies\nGET /{partnerRef}/v2/countries → supported countries\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration","__idx":5},"children":["Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/create-buy-order"},"children":["API Integration: Create Buy Order"]}," ","→ ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/referral-integration/overview"},"children":["Referral Integration"]}]}]},"headings":[{"value":"On-Ramp Overview","id":"on-ramp-overview","depth":1},{"value":"How it works","id":"how-it-works","depth":2},{"value":"What Banxa handles","id":"what-banxa-handles","depth":2},{"value":"Supported payment methods","id":"supported-payment-methods","depth":2},{"value":"Supported currencies and crypto","id":"supported-currencies-and-crypto","depth":2},{"value":"Integration","id":"integration","depth":2}],"frontmatter":{"title":"Crypto On-Ramp Integration Overview | Banxa Docs","description":"How Banxa's fiat-to-crypto on-ramp works: payment processing, KYC/AML compliance, liquidity handling, and supported currencies and payment methods by region.","seo":{"title":"On-Ramp Overview"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/on-ramp-off-ramp/on-ramp-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}