Skip to content
Last updated

Changelog


2026-07-08

Banxa Hosted Checkout

Added

  • FAQ page — Answers to the most common integration questions raised by partners: credential types, sandbox behaviour, order finality, fee model, externalCustomerId semantics, and webhook handling. → FAQ
  • Error code reference — Documents 4002, 4005, 5034, 422 code 81, common 401 causes, and checkout errors, none of which were previously documented. → Error Codes
  • Sandbox limitations — The Testing Overview now lists what sandbox does not do: no on-chain transactions, no Sumsub connection, manual order fulfilment, no failure simulation, stale pricing, no emails, no Apple Pay or Google Pay. → Testing Overview
  • Order identifiers section — Order Statuses now defines the customer-facing numeric order ID vs the API order key, and which to reconcile on. → Order Statuses
  • JS Native Payments SDK now available (web): The Banxa JS Native Payments SDK (@banxa-official/javascript-native-payments-sdk, v1.0.0) is now available for web apps. A Node-safe BanxaApiClient handles order creation and quotes server-side, and the <banxa-hosted-checkout> web component embeds the checkout in an iframe. A web integration guide and full SDK reference are now published. → JS Native Payments SDK (Web) Guide

Changed

  • Webhook signing secret clarified — The Securing Webhooks section now states explicitly that webhook signatures are verified with the HMAC key pair, not the v2 x-api-key. Previous wording implied a v2 secret that does not exist. Non-breaking, docs only. → Webhooks
  • Order finality warning — Order Statuses now warns that paymentReceived is not a settlement guarantee and that partners must settle on complete. → Order Statuses
  • Quote usage notes expanded — Get a Quote now states there is no quote ID or validity window, explains the spread-in-rate fee model and why processingFee can be 0, and notes sandbox pricing staleness. → Get a Quote

2026-05-11

Added

  • React Native SDK now available — The Banxa React Native SDK (@banxa-official/react-native-sdk) is now available. Install a single package to get typed methods for quotes, order creation, and in-app checkout presentation — no backend required for core flows. → SDK Integration
  • Sumsub Copy Applicant support — A second Sumsub integration approach is now available alongside Reusable KYC. Copy Applicant retrieves name, DOB, selfie, document, address, and TIN directly from your Sumsub account, reducing the amount of data that needs to be collected separately. Copy Applicant is a separate Sumsub product and must be configured by Banxa — contact Banxa to have it enabled on your account. → Sumsub Integration

2026-05-04

Added

  • KYC status webhooks — Banxa now sends a webhook when a customer's identity verification status changes. The payload includes kyc.status with values PENDING, UNDER_REVIEW, ACTION_REQUIRED, VERIFIED, and REJECTED. Use this to track verification progress without polling for order status. → Webhooks

Changed

  • mobileNumber now optional on KYC token share — Previously required on POST /v2/identities/token/share. Note: Interac (Canada) requires a mobile number — if not provided, Banxa collects it from the customer during checkout.

2026-02-08

Added

  • partnerFee now included in Quote and Order responses — Quote and order responses now include partnerFee, providing direct visibility of partner fees during pricing and reconciliation.
  • KYC token sharing via Sumsub addedPOST /v2/identities/token/share is now supported. Share a verified customer's Sumsub token with Banxa to pre-populate KYC and reduce friction at checkout. → KYC Sharing

Improved

  • Webhook payloads now include full order context — Webhooks now include full order context for all status transitions, removing the need for a follow-up Get Order call for reporting and reconciliation.

2025-05-08

Improved

  • Base64-encoded images now accepted for identity documents — Identity document images can now be submitted as Base64-encoded strings in addition to secure HTTPS URLs.

2025-01-08

Added

  • Automated webhook retries — If Banxa does not receive a 200 OK response, the webhook is automatically retried. The payload remains unchanged across retry attempts.

2024-05-08

Added

  • contract_id added to Get Coins and Get Order(s) responses — Enables additional reporting on cryptocurrency/blockchain smart contract values.

Improved

  • Webhooks Version 2 — Webhooks are now sent for all order status transitions. Payloads include full order context — no follow-up Get Order call required.

2024-01-08

Added

  • Discount code support — Available via Get Prices and Create Order endpoints. Commission rate can now be adjusted on a per-quote or per-order basis.
  • X-Request-Id response header — Included in all Banxa API responses. Use this value when troubleshooting with Banxa support.

Improved

  • Referral URL theme parameters added — New URL parameters for visual customisation: theme, primaryColor, secondaryColor, backgroundColor, textColor.