{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Partner Dashboard","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":"partner-dashboard","__idx":0},"children":["Partner Dashboard"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Partner Dashboard gives you self-service control over your Banxa integration. Use it to manage team access, configure your checkout experience, set up webhooks, and look up orders to support your customers."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environments","__idx":1},"children":["Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The dashboard supports both ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]}," environments. Use the environment toggle at the top of the page to switch between them."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always configure and validate settings in Sandbox before applying them to Production. Configuration changes take approximately ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["15 minutes"]}," to take effect on the live checkout."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/enviornment-toggle.4ffb69eadd92afe10c08d2687dd6cb381b28d372c3cf37a80d162be5ff2741fe.d7ea94e8.png","alt":"enviornment toggle.png","withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"user-management","__idx":2},"children":["User management"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-roles","__idx":3},"children":["Creating roles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before adding team members, create roles with the appropriate permission sets. Permissions are set at the page level — a user without \"Read\" permission for a given page will not be able to view it."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Profile"]}," page via the top-right dropdown menu."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create New Role"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Name the role — for example: \"Developer\", \"Customer Operations\", or \"Admin\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Assign permissions to the role."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},"."]}]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/create-role.24d8014352d777c2388e1dc5380111cd2188e6ebde1003f78ad1773e8331470d.d7ea94e8.png","alt":"create-role.png","withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-users","__idx":4},"children":["Creating users"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create New User"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the user's name, email address, and role."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submit"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The user receives a registration email with instructions to set up their account. When they log in they will have the permissions assigned to their role."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/create-new-user.55969af2e7869a8993038d727f35ca2cbeab94f17d31e31f895ffccc7902faed.d7ea94e8.png","alt":"create-new-user.png","withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-configuration","__idx":5},"children":["Integration configuration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-credentials","__idx":6},"children":["API credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your API key and sandbox credentials are available from the dashboard. Use the environment toggle to view credentials for each environment separately."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"webhook-url","__idx":7},"children":["Webhook URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter the endpoint URL where Banxa should send order status notifications. You can set separate webhook URLs for Sandbox and Production."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once saved, use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]}," button to test the webhook — Banxa will send a test payload to the configured URL and display the result."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For payload structure and verification, see the Webhooks article in this documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"return-url","__idx":8},"children":["Return URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The URL the user will be redirected to after the buy flow has been completed. In the case of an order failure or cancellation, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUrl"]}," will be appended with the status, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/?status=failure"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/?status=cancel"]},". If you pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUrl"]}," in your API request, that value takes precedence over the dashboard setting."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"dynamic-callback-url-parameters","__idx":9},"children":["Dynamic callback URL parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a Return URL is configured, enable this setting to have Banxa append order details to the return URL as query parameters. This lets you read the outcome without an additional API call and deep-link customers to specific pages in your application."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parameters appended on return:"]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Banxa order ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderRef"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Banxa internal order reference"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Overall status of the order"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fulfillmentStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sub-status for the progress of crypto transfer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sub-status for the progress of fiat payment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identityStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sub-status for the progress of the customer's KYC"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fiatAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Fiat amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fiat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Fiat currency code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coinAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Crypto amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Cryptocurrency code"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"checkout-configuration","__idx":10},"children":["Checkout configuration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"coins-and-blockchains","__idx":11},"children":["Coins and blockchains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select which cryptocurrencies and blockchain networks are available to your customers. All options are enabled by default — deselect any you do not want to offer. Native tokens for a blockchain cannot be deselected."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/assets-management.f3a1d2f9641eeb3f231a361ebe6dcf3e8f7d65d1900a6dc3c043c90bcb452767.d7ea94e8.png","alt":"Assets management — coin and blockchain selector","withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"default-cryptocurrency","__idx":12},"children":["Default cryptocurrency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sets the pre-selected cryptocurrency shown to customers when they arrive at the checkout."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"read-only-fiat-cryptocurrency-and-amounts","__idx":13},"children":["Read-only fiat, cryptocurrency and amounts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the fiat currency, cryptocurrency, and amount fields passed via the API are displayed as read-only in the checkout. Customers cannot change these values. When disabled, customers can edit these selections."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"display-wallet-address","__idx":14},"children":["Display wallet address"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the customer's wallet address (and memo/tag if provided) is displayed in the checkout. When disabled, these are hidden."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hide-return-button","__idx":15},"children":["Hide return button"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the return button on the order summary page is hidden. Use this if you want to render your own close or return control over the Banxa screen."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"disable-walletconnect-and-metamask-connection","__idx":16},"children":["Disable WalletConnect and MetaMask connection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls whether customers can connect their wallet directly on the Banxa checkout using MetaMask or WalletConnect."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"branding-and-appearance","__idx":17},"children":["Branding and appearance"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"upload-logo","__idx":18},"children":["Upload logo"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The logo displayed on all pages of the Banxa checkout flow. Upload an image with a maximum height of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["70 pixels"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"primary-colour","__idx":19},"children":["Primary colour"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your brand colour, used for buttons, highlighted text, and checkboxes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"secondary-colour","__idx":20},"children":["Secondary colour"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The colour used for button hover effects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"theme","__idx":21},"children":["Theme"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sets the default checkout theme to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Light"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dark"]}," mode. If the customer changes the theme from their browser settings, their preference overrides this default."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hide-banxa-logo","__idx":22},"children":["Hide Banxa logo"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, hides both the Banxa logo and your partner logo on all pages of the checkout journey."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"background-colour","__idx":23},"children":["Background colour"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applies a custom solid background colour to all pages of the checkout journey."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"order-management","__idx":24},"children":["Order management"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"looking-up-orders","__idx":25},"children":["Looking up orders"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Orders page to view the live status of customer orders. You can search by:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Email address"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Wallet address"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Order ID"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Order Reference"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click any result to view the full order detail and status history. Use the environment toggle to switch between Sandbox and Production orders."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/orders.c4349ed01f2c6aae58ed611adbed707627ff036140fe1b2f356fdff82180b82e.d7ea94e8.png","alt":"orders.png","withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"order-statuses-and-customer-responses","__idx":26},"children":["Order statuses and customer responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the table below to understand each order status and respond to customer support queries."]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Suggested customer response"},"children":["Suggested customer response"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pendingPayment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Order created, awaiting KYC and payment submission."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Banxa has received your KYC information and is awaiting your payment to complete the order."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["waitingPayment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Payment has not yet been received — either not yet made or still in transit."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your payment has not yet been received by Banxa. If you have already made the payment, it may still be in transit. Once received, your order will be processed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentReceived"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Payment received and confirmed. Order is being processed."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your payment has been received by Banxa and confirmed. We are now processing your order."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coinTransferred"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cryptoTransferred"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Crypto transaction submitted to the blockchain."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your cryptocurrency transaction has been submitted to the blockchain and is awaiting confirmation, at which point you will receive your funds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["complete"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Order fulfilled."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Buy:"]}," Your order is complete. Your cryptocurrency is now available on the blockchain — check the transaction hash for details. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sell:"]}," Your order is complete. Payment has been sent to your bank account. Allow up to 3 business days for it to appear."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraVerification"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Additional identity or address verification required."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your order requires additional verification. Banxa's support team will contact you by email shortly to help complete the process."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Payment declined by the customer's bank."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your order was declined by your financial institution. Please contact your bank's support team for further assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Payment cancelled by the customer."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your payment was cancelled. Please create a new order if you wish to proceed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Order not completed — KYC incomplete, payment failed, or order abandoned."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your order has expired because it was not completed within the required timeframe, or your KYC or payment was unsuccessful. Please create a new order to proceed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refunded"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Order refunded by Banxa — at customer request or due to a rejected payment (e.g. third-party payment)."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Buy:"]}," Your order has been refunded. Allow up to 14 days for the amount to appear in your account. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sell:"]}," Your order has been refunded — check the transaction hash for details."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"analytics","__idx":27},"children":["Analytics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Analytics page gives you visibility into your integration's transaction volume and customer activity over time. Use it to monitor performance trends and export data for reporting."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/analytics_dashboard.2fd7e6373eb7f85d126704ac6aa40b41e11bf1c7c82a55ebce9d614b6682352d.d7ea94e8.png","alt":"Analytics dashboard showing key metrics","withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filtering-data","__idx":28},"children":["Filtering data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Choose a date range using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Relative"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Absolute"]}," toggle:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Relative"]}," — preset windows of 1, 3, 6, or 12 months from today, or a custom duration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Absolute"]}," — set a specific start and end date."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Apply Filter"]}," to refresh the metrics and charts. Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Export CSV"]}," to download the filtered dataset."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-metrics","__idx":29},"children":["Key metrics"]},{"$$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":"Metric"},"children":["Metric"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Average Order Value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Mean transaction value across all orders in the selected period."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Total Transaction Value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sum of all transaction values in the selected period."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Commission"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Total commission earned in the selected period."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Average Orders Per Customer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Mean number of orders per unique customer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Total Number of Orders"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Count of all orders in the selected period."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Customers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Count of first-time customers in the selected period."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each metric shows the percentage change versus the previous equivalent period."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"charts","__idx":30},"children":["Charts"]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/analytics_charts.ac2ec21adb43a8710c27d36ebfe6b2250b378791703ff83335f4b9f82fc23363.d7ea94e8.png","alt":"Analytics charts showing customer type, payment method, and country breakdowns","withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customers By User Type"]}," — breakdown of new vs. returning customers in the selected period."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Volume By Payment Method"]}," — share of transaction volume across card, Apple Pay, and Google Pay."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Orders By KYC Country"]}," — geographic distribution of orders by country of KYC verification."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"moving-to-production","__idx":31},"children":["Moving to production"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have completed end-to-end testing in Sandbox, contact Banxa to enable your Production environment. You will receive production credentials and can update your integration accordingly."]}]},"headings":[{"value":"Partner Dashboard","id":"partner-dashboard","depth":1},{"value":"Environments","id":"environments","depth":2},{"value":"User management","id":"user-management","depth":2},{"value":"Creating roles","id":"creating-roles","depth":3},{"value":"Creating users","id":"creating-users","depth":3},{"value":"Integration configuration","id":"integration-configuration","depth":2},{"value":"API credentials","id":"api-credentials","depth":3},{"value":"Webhook URL","id":"webhook-url","depth":3},{"value":"Return URL","id":"return-url","depth":3},{"value":"Dynamic callback URL parameters","id":"dynamic-callback-url-parameters","depth":3},{"value":"Checkout configuration","id":"checkout-configuration","depth":2},{"value":"Coins and blockchains","id":"coins-and-blockchains","depth":3},{"value":"Default cryptocurrency","id":"default-cryptocurrency","depth":3},{"value":"Read-only fiat, cryptocurrency and amounts","id":"read-only-fiat-cryptocurrency-and-amounts","depth":3},{"value":"Display wallet address","id":"display-wallet-address","depth":3},{"value":"Hide return button","id":"hide-return-button","depth":3},{"value":"Disable WalletConnect and MetaMask connection","id":"disable-walletconnect-and-metamask-connection","depth":3},{"value":"Branding and appearance","id":"branding-and-appearance","depth":2},{"value":"Upload logo","id":"upload-logo","depth":3},{"value":"Primary colour","id":"primary-colour","depth":3},{"value":"Secondary colour","id":"secondary-colour","depth":3},{"value":"Theme","id":"theme","depth":3},{"value":"Hide Banxa logo","id":"hide-banxa-logo","depth":3},{"value":"Background colour","id":"background-colour","depth":3},{"value":"Order management","id":"order-management","depth":2},{"value":"Looking up orders","id":"looking-up-orders","depth":3},{"value":"Order statuses and customer responses","id":"order-statuses-and-customer-responses","depth":3},{"value":"Analytics","id":"analytics","depth":2},{"value":"Filtering data","id":"filtering-data","depth":3},{"value":"Key metrics","id":"key-metrics","depth":3},{"value":"Charts","id":"charts","depth":3},{"value":"Moving to production","id":"moving-to-production","depth":2}],"frontmatter":{"title":"Partner Dashboard","description":"Manage your Banxa integration, configure checkout settings, handle user access, and monitor orders from the Partner Dashboard.","seo":{"title":"Partner Dashboard"}},"lastModified":"2026-06-18T06:12:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/getting-started/partner-dashboard","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}