URL Format
URL Parameters
The following table outlines parameters to generate the Offramp URL| Parameter | Req’d | Type | Description |
|---|---|---|---|
sessionToken | Yes | String | Token generated by the Session Token API. |
redirectUrl | Yes | String | URL to redirect the user to after they send crypto. Production URLs must be added to your domain allowlist (see Security Requirements). Use Offramp Transaction Status API to fetch the send to_address details. |
partnerUserRef | Yes | String | Unique ID representing the end-user. Must be less than 50 chars. Use with the Offramp Transaction Status API to retrieve transactions made during the session. |
defaultNetwork | No | String | Default network that should be selected when multiple networks are present |
defaultAsset | No | String | Default asset that should be selected when multiple assets are present |
presetCryptoAmount | No | Number | Preset crypto amount value |
presetFiatAmount | No | Number | Preset fiat amount value (for USD, CAD, GBP, EUR only). Ignored if presetCryptoAmount is also set. |
defaultCashoutMethod | No | String | Default payment method to cashout fiat (“FIAT_WALLET”, “CRYPTO_ACCOUNT”, “ACH_BANK_ACCOUNT”, “PAYPAL”) |
fiatCurrency | No | String | e.g: USD, CAD, GBP, etc. |
disableEdit | No | Boolean | If set to true, prevents users from editing their order in the One-Click Sell flow. By default, this is set to false. |
Example
All transactions made during the session are linked to
partnerUserRef which can be used with the Transaction Status API to retrieve transactions later.Creating Session Tokens
To get asessionToken, call the Session Token API from your backend: