Access & Setup
Getting Access
What you get
When you begin your Banxa integration, you'll receive access to two things:
- Partner Dashboard — your self-service portal for configuring your integration, managing users, monitoring orders, and switching between environments.
- Sandbox environment — a fully functional test environment where you can build and validate your integration before going live. No real transactions are processed.
Your sandbox credentials are separate from production credentials. Production access is enabled by Banxa once you have completed testing and received approval.
Two decisions before you build
Before writing any code, you need to make two independent decisions. Each one can be changed later, but will require rework.
Decision 1 — Checkout display
iFrame embeds the Banxa checkout flow directly inside your application. The customer never leaves your product.
Redirect opens the Banxa checkout in a new tab or browser window. Banxa hosts the page, which can be co-branded with your styling.
→ See Checkout Visualisation: iFrame vs. Redirect for a full comparison.
Decision 2 — Integration method
API integration gives you full control. You call Banxa's REST APIs to fetch quotes, create orders, and receive webhook notifications. This approach supports KYC sharing and lets you build a quote experience within your own UI.
Referral integration is URL-based. You construct a Banxa URL with parameters and redirect the customer to it. No server-to-server calls required. Best for teams who want to move fast without backend complexity.
→ See Integration Method: API vs. Referralfor a full comparison.
Your path from sandbox to production
| Stage | What happens |
|---|---|
| Sandbox access | Banxa provides your sandbox credentials and dashboard access |
| Dashboard setup | Configure webhooks, supported crypto/blockchains, and UI settings |
| Build & integrate | Implement your chosen integration method and checkout visualisation |
| Add Banxa disclosure | Display required branding and disclaimer in your UI |
| End-to-end testing | Complete a full test purchase using sandbox test credentials |
| Production launch | Notify Banxa to enable your production environment and receive production credentials |
Note: Changes made in the dashboard take approximately 15 minutes to propagate to your integration.
Updated about 18 hours ago
