Guides

Off Ramp API

Suggest Edits

Use this guide if you want to implement crypto sell functionality in your application. This solution requires that you to facilitate crypto transfers on your customer's behalf.

Off-Ramp Integration using API


Quotation

If you have an interface for your customer to choose the cryptocurrency, fiat and amounts they wish to sell, follow the steps below:

  1. Call the Get Quotes endpoint for the chosen crypto, fiat and amount to get a quote value from Banxa. Continue with steps 2 onwards.

If you do not have an interface to display prices on your applications, start at step 2 below.

Order Initiation

  1. Create an Order using the Post Sell endpoint.

Note. You are required to provide a Customer walletAddress so that Banxa is able to process a refund if this is required.

Once the Customer enters Banxa's checkout flow, they will be guided through the process for Banxa to collect and verify their personal details, KYC documents, and the nominated bank account details for the fiat payout.

Order Finalisation

After the user has submitted their KYC and payout details, we will provide you a deeplink after the user has completed submitting their payment details. We will use the returnUrl request parameter that you provided in the POST Sell, and we will append to it the deposit address as well as other details.

  1. You are now responsible for facilitating the crypto transfer to this wallet address with your Customer. The exact coin amount referenced in the order should be sent as soon as possible.

Example Deeplink

https://example.com/?orderId=64c50959eb5eec88039dk2ed1487b722c&providerWalletAddress=tb1qmszc3uatmwe3c7y0kme2c2r5za78mzjyw0gdef&blockchain=BTC&coinType=BTC&coinAmount=0.00179857&customerWalletAddress=1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rf

  1. Once the coin has been sent, you must now notify Banxa that the cyrpto amount has been sent by sending a request to Confirm Sell Order endpoint.

It is important that this information is sent to Banxa as soon as the coin transfer is executed to prevent the Sell Order from expiring.

Once Banxa receives the crypto transfer it will be reconciled to the Sell Order and the fiat currency amount will immediately be sent to the Customer's nominated bank account to complete the process. The Order will then progress to COMPLETED.

Updated 4 months ago