For the complete documentation index, see llms.txt. Append
.mdto any page URL for its markdown version.
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.
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, e.g. 500. Buy: the amount the customer spends. Sell: the amount the customer receives. 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, e.g. 0.5. Buy: the amount the customer receives. Sell: the amount the customer sells. 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 | Buy only. Customer's receiving wallet address. Pre-populates the wallet field in checkout. |
walletAddressTag | string | Buy only. 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. Contact Banxa to confirm that off-ramp is enabled for your partner account.
https://yourpartner.banxa.com?orderType=sell&coinType=ETH&fiatType=EUR&coinAmount=0.5In sell mode:
fiatType,fiatAmount,coinTypeandcoinAmountpre-fill the sell form.coinAmountis the crypto the customer sells;fiatAmountis the fiat they receive.walletAddressandwalletAddressTagare not used. Banxa issues a deposit address for the order after the customer submits their payout details.- The customer chooses the payout method in the checkout. See Supported Payment Methods for the payout methods by currency.
- How the customer sends the crypto depends on the fulfilment flow set on your account. See Custodial vs. Non-Custodial.
To set the customer's sending wallet, an externalOrderId or a per-order redirectUrl, create the order with POST /v2/sell instead.