All parameters are optional. Any value not provided will default to customer preferences or the defaults configured in your Partner Dashboard. We recommend passing through as many values as possible, as this significantly improves conversion.
Parameter names are case-sensitive
The exact name and case of the parameter must be used.
| Parameter | Type | Description |
|---|---|---|
orderType | string | Pass sell to open the checkout in off-ramp (sell) mode. If not passed, the order defaults to buy. |
fiatType | string | Fiat currency code the customer wants to exchange, e.g. USD. Pre-selects the fiat currency. |
fiatAmount | number | Fiat amount the customer wants to exchange, e.g. 500. If both fiatAmount and coinAmount are passed, fiatAmount is used. |
coinType | string | Coin currency code the customer wants to exchange, e.g. ETH. Pre-selects the crypto asset. |
coinAmount | number | Coin amount the customer wants to exchange, e.g. 0.5. If both fiatAmount and coinAmount are passed, fiatAmount is used. |
blockchain | string | Blockchain network code selected by the customer, e.g. ETH. If not passed, the default blockchain configured for the selected coinType applies. |
walletAddress | string | Customer's wallet address. Pre-populates the wallet field in checkout. |
walletAddressTag | string | Customer's wallet tag or memo. Required for transacting on certain blockchains such as BNB and XRP. |
returnUrl | string | URL the customer is redirected to when they complete or cancel the order process. Must be URL-encoded. |
backgroundColor | string | A solid background colour. Overrides Banxa's custom themes. Takes a hex value without the hash (#), e.g. ffffff. |
primaryColor | string | The colour used for active buttons. Hex value without the hash (#). |
secondaryColor | string | The colour used for button hover effects. Hex value without the hash (#). |
textColor | string | The colour used for all text in the checkout flow. Hex value without the hash (#). |
theme | string | light or dark. Applies the correct contrast for the selected background colour. For dark backgrounds, use a dark theme so input fields contrast correctly. |
Available payment methods are determined by your partner configuration and the customer's country, and are shown to the customer in the checkout. Payment method cannot be pre-selected via a referral URL parameter.
To open the checkout in sell mode, pass orderType=sell. All other parameters apply. Contact Banxa to confirm that off-ramp is enabled for your partner account.