Onboard Connect allows you to customize your users’ trading experience by embedding specific trade parameters within the redirect link’s query parameters. The table below describes these parameters.

ParamTypeRequiredDescription
tradeTypeStringYesSpecify the type of order you want to initiate.

Available options:
Buy (onramp) or Sell (offramp)
fiatStringYesISO code alpha 3 that specifies the fiat currency for the trade.

Use the trade options endpoint to get the list of available fiat currencies
tokenStringYesToken symbol for the crypto asset to be traded.

Use the trade options endpoint to get the list of available tokens.
fiatAmountNumberConditionalAmount to be traded,, expressed in its fiat value.

Either one of fiatAmount or tokenAmount must be provided.
tokenAmountNumberConditionalAmount to be traded, expressed in its crypto value.

Either one of fiatAmount or tokenAmount must be provided.
networkIdStringYesThe blockchain network identifier or chain ID for the trade.

Use the trade options endpoint to get the list of available networks.
paymentChannelStringNoThe preferred payment channel for the trade.

Use the trade options endpoint to get the list of supported payment channels.
addressStringNoThe blockchain address to be credited with token for Buy (onramp) trades.

If not provided, the customer will be required to connect their wallet to complete the trade.

For Sell (offramp) trades, users are always required to connect their wallets if not already connected.
emailStringNoYour customer’s email address.
orderIdNumber / StringNoUnique ID that enables you track the order easily on your platform.

This ID maps to the thirdPartyInfo.externalOrderReference property within the webhook payload.
autoselectBooleanNoProvide this flag to indicate if the best offer should be selected, or if a list of offers matching your trade parameters should be returned.

Defaults to true.