On Ramp API

This is a more technical integration option, however allows more control of the checkout flow. Banxa offers powerful JSON REST APIs that supports a range of financial, cryptocurrency, and KYC streamlining services. Using the API allows you to build a UI to build a quotation journey for the user before redirecting them to Banxa checkout.

You can either redirect to Banxa Checkout or use an iFrame to embed Banxa Checkout into your application.

Banxa Checkout API endpoints

🔀 Order API

The Order API enables you to securely create orders for your customer from your website/application. By redirecting your customers to Banxa to complete an order, you are leveraging Banxa's powerful KYC, payments and liquidity infrastructure to fulfil customer orders.

🏷️ Quote API

The Prices API enables you to retrieve current quotes for an order. The order can be of any supported cryptocurrency, fiat and payment method. This allows your customers to view the most update to date quote and understand prices paid and amounts received before placing an order.

💳 Payment Methods API

The Payment Methods API enables you to easily retrieve all possible payment methods that is available to your customers. This list will progressively grow bigger as Banxa continues to expand it's geographical footprint and build new partnerships with global and local payment providers!

🌎 Countries API

The Countries API enables you to easily retrieve all possible countries that your customers can create orders from. We are growing this list all the time!

🪙 Currencies API

The Currencies API enables you to easily retrieve all possible fiat currencies and cryptocurrencies that is available to your customers.

🆔 Customer Identity Registration API

The Customer Identity Registration API is a versatile API that allows you more ways to streamline KYC. You will be able to pass through to Banxa, KYC documentation that you have already captured from your customers so that when they enter the Banxa checkout flow, they will not need to upload KYC information again. This improves conversion greatly. Please note that Banxa will continue to verify KYC documentation and request more information from the customer if required by Banxa KYC processes.

If you use Sumsub as your KYC provider, this API will allow you to pass a Sumsub token to us, which will mean that customers will be able to skip KYC entirely!

Onramp Guide

1. Retrieve reference data and build front end UI

Request available Payment Methods, Fiats and Cryptocurrencies available for your account. Use this information to allow your user to view and select order details on your app.

You can check this availability periodically as we will often add new support for more payment methods and currencies.

2. Retrieve quote

On your app, when the user has selected their desired currencies, amounts and payment method, call the Quotes endpoint to retrieve a quotation from Banxa.

📘

Quotes

This will be the best possible price based on the available data passed through in the endpoint. If you pass the user's wallet address, this will allow Banxa to return the most accurate prices based on order history.

3. Redirect to Banxa widget

Using the selected order details, redirect the user to the checkout URL that is returned when you call the Buy endpoint. Banxa will then take care of KYC and payment.

Once complete we will redirect the customer back to your app using the URL you gave us in the Buy endpoint.

4. Retrieve order details

Depending on the payment method chosen, the order will be completed in minutes or up to a few hours. You can check on the progress by calling the Orders endpoint.

Alternative, you may wish to subscribe to webhooks which will notify you of order status changes.