{"templateId":"openapi_docs","versions":[{"version":"v0-beta","label":"Beta (v0)","link":"/products/native-api/openapi/configuration","default":true,"active":true,"folderId":"e4cb5a06"}],"sharedDataIds":{"openAPIDocsStore":"oas-products/native-api/@v0-beta/openapi.json","sidebar":"sidebar-products/native-api/@v0-beta/sidebars.yaml"},"props":{"definitionId":"products/native-api/@v0-beta/openapi.json","dynamicMarkdocComponents":[],"baseSlug":"/products/native-api/openapi","seo":{"title":"Configuration","description":"**Configuration Endpoints** - Retrieve supported payment methods, fiat currencies, countries, crypto currencies, and other configuration data required to build onboarding and transaction flows.\n\n**Key Operations**:\n- List supported fiat currencies for on-ramp and off-ramp transactions\n- Retrieve available payment methods for a given transaction direction\n- Get supported countries and any required states or provinces\n- List supported crypto currencies for transaction setup\n- Use configuration data to pre-fill forms before pricing or ramp creation\n\n**Use Cases**:\n- Populate dropdowns and selectors in your UI\n- Filter valid options based on customer choices\n- Validate transaction parameters before submission\n- Display supported onboarding and payout options","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":[]}},"itemId":"configuration","disableAutoScroll":true,"metadata":{"subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.banxa.com","port":4000,"ipAddress":"216.73.217.131"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/products/native-api/openapi/configuration","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}