Referral Method

A referral URL can be used to link customers out to Banxa order checkout without the need to make API calls. You can implement this simply by directing the customer to a blank order form with the base URL, or by constructing a URL that contains the parameters needed to populate the Banxa order form. Your customer will be directed to the Banxa order form which will be pre-filled with any parameters that were contained in the URL.

Use this integration option if you do not require webhooks, HMAC message encryption and quote comparison within your site.

Before you begin

  • We will provide you with a Referral URL which will be unique to you
  • If you wish to embed the Banxa checkout as an iFrame, you will need to provide us with the full domain that you will be using to host the iFrame so that we can conduct whitelisting

Parameters

Here are the supported parameters that can be passed in the URL. All of these parameters are optional, however we recommend that you pass through as many values as possible for better conversion.

👍

The exact name and case of the parameter must be used.

URL Parameter

Description

sellMode

Indicates whether the customer wants to sell. The customer will be shown the Sell Order Form when they are redirected to the Banxa cart. This will depend on whether you have implemented the option to sell. If this parameter is not passed, then the order will default to buyMode

fiatType

Fiat currency code that the customer wants to exchange e.g USD

fiatAmount

Fiat amount that the customer wants to exchange e.g. 500. If both a fiatAmount and coinAmount are passed, then the fiatAmount will be used

coinType

Coin currency code that the customer wants to exchange e.g. ETH

coinAmount

Coin amount that the customer wants to exchange e.g. 800. If both a fiatAmount and coinAmount are passed, then the fiatAmount will be used

blockchain

Blockchain network code that is selected by the customer. If this parameter is not passed, the default blockchain configured for the coinType selected will apply

walletAddress

Customer’s wallet address

walletAddressTag

Customer’s wallet tag or memo. This is required for transacting on certain blockchains such as BNB and XRP

code

Only required if you implement an iFrame approach. Your unique iFrame code that Banxa has issued you with. This will return HTML that can be embedded into your site

UI approaches

There are two UI approaches available for directing the customer to the Banxa checkout flow.

1. Redirect to Banxa checkout

This will redirect the customer to the Banxa checkout flow in another tab to complete their order. The customer’s order page will be pre-filled with the order details that have been passed through to Banxa via the referral URL.

Example of a redirect URL

https://{yourCompany}.banxa.com/?coinType=ETH&fiatType=USD&fiatAmount=500&blockchain=ETH

2. Widget / iFrame (Beta)

This will host the Banxa site in an iFrame and allow customers to complete the checkout process within this iFrame. This can be done by including the code parameter and your unique code as part of the URL.

Please contact your dedicated Customer Success Manager for this information.

Example of an iFrame URL

https://{yourCompany}.banxa.com/iframe?code=xxxxxxxxxxx?coinType=ETH&fiatType=USD&fiatAmount=500&blockchain=ETH

If you have any questions or would like to connect with our team, please do so via [email protected] or our Discord community.