Supported offramp parameters

Parameter	Type	Description
offrampCashoutRedirectUrl	boolean	If the offrampCashoutRedirectUrl is passed in the widget, the system will use the Wallet Initiation flow, allowing the partner system to programmatically handle the crypto transfer process.
sell_defaultFiat	string	The default fiat currency is to be displayed.
sell_onlyFiats	string	The only fiat currencies to be displayed.
sell_excludeFiats	string	Fiat currencies that are to be excluded.
sell_defaultCrypto	string	The default cryptocurrency is to be displayed.
sell_excludeCryptos	string	Cryptocurrencies to be excluded.
sell_defaultAmount	number	The default amount to be displayed (must be used with `sell_defaultFiat`).
sell_onlyCryptos	string	The only cryptocurrencies to be displayed.
sell_excludeCryptoNetworks	string	Blockchain networks to be excluded.
sell_onlyCryptoNetworks	string	Limit the blockchain networks to be displayed.
sell_defaultPaymentMethod	string	The default payment method is to be displayed.
sell_excludePaymentMethods	string	Payment Methods to be excluded.
onlyOfframps	string	Limit the offramps to be displayed.
sell_isAmountEditable	boolean	Determine whether crypto amount should be editable.
sell_recommendation	string	Override default ranking engine with specific offramp.
sell_popularCryptos	string	A comma-separated list of crypto ids to be displayed at the top of the source (crypto) selection dropdown-list. The order is preserved.

Wallet initiation flow (offrampCashoutRedirectUrl)

Initiate your wallet's in-built flow to send (read:sell) crypto instead of showing a QR code in the offramp flow.

At the point in the offramp-flow where the user needs to send crypto, the user will be redirected to your system. This redirect happens to the URL defined in the offrampCashoutRedirectUrl parameter.

Learn more about the QR and wallet initiation flow here.

https://buy.onramper.com?offrampCashoutRedirectUrl=example.com

Default Fiat (offramp)

Set a default fiat currency to be displayed using thesell_defaultFiat

https://buy.onramper.com?sell_defaultFiat=USD

Only Fiats (offramp)

Force one or multiple fiat currencies in your widget using sell_onlyFiats:

https://buy.onramper.com?sell_onlyFiats=USD,EUR

Exclude Fiats (offramp)

Omit certain fiat currencies with sell_excludeFiats:

https://buy.onramper.com?sell_excludeFiats=USD,EUR

Default Amount (Offramp)

When used in conjunction with sell_defaultFiat, sell_defaultAmount will pre-populate the fiat currency input with your desired amount.

The URL below will default to a EUR amount of €125 whenever a user accesses your widget:

https://buy.onramper.com?sell_defaultFiat=EUR&selldefaultAmount=125

Default Crypto

By default, the widget will use its recommendation algorithm to set the input currency, based on the most-used crypto in the user’s country.

However, you can override this with sell_defaultCrypto. Check out Crypto currencies to find your desired ID (please use the value from the Onramper ID column).

https://buy.onramper.com/?sell_defaultCrypto=ETH

Exclude Cryptos (offramp)

Right out of the box, the Onramper widget makes all cryptocurrencies available.

Use sell_excludeCryptos if you want to remove some from your widget. Check out Crypto currencies to find your desired IDs (please use the values from the Onramper ID column).

For instance, the example below makes ether and bitcoin unavailable to sell:

https://buy.onramper.com?sell_excludeCryptos=BTC,ETH

Only Cryptos (offramp)

If you only want a specific set of cryptos to be displayed, use sell_onlyCryptos. Check out Crypto currencies to find your desired IDs (please use the values from the Onramper ID column).

The string below ensures that only BTC and ETH can be sold through your widget:

https://buy.onramper.com?sell_onlyCryptos=ETH,BTC

Exclude Crypto Networks (offramp)

Similar to sell_excludeCryptos, sell_excludeCryptoNetworks allows you to remove entire crypto networks from the widget. Network IDs can be found from Crypto networks - please use the values from the Onramper ID column.

https://buy.onramper.com?sell_excludeCryptoNetworks=bitcoin,ethereum

Only Crypto Networks (offramp)

sell_onlyCryptoNetworks enables you to force the use of certain networks. Network IDs can be found from Crypto networks - please use the values from the Onramper ID column.

https://buy.onramper.com/?sell_onlyCryptoNetworks=ethereum,polygon

Default Payment Method (offramp)

Load your preferred payout method with sell_defaultPaymentMethod. You can find their Onramper IDs under Payment methods.

Below is an example of a URL that loads Bank Transfer:

https://buy.onramper.com/?sell_defaultFiat=EUR&sell_defaultAmount=200&sell_defaultPaymentMethod=banktransfer

Exclude Payment Methods (offramp)

Don’t want to show your users certain payment methods? Add sell_excludePaymentMethods to your string:

https://buy.onramper.com/?sell_defaultFiat=EUR&sell_excludePaymentMethods=creditcard

Only Offramps

Limit the offramps to be displayed to your selection by usingsell_onlyOfframps. Note: new offramps added by Onramper will not being added to your integration automatically as a result.

https://buy.onramper.com?onlyOfframps=Transfi

is Amount Editable (offramps)

Set whether users can edit the amount using thesell_isAmountEditable to true or false. Amount is editable by default.

https://buy.onramper.com?sell_isAmountEditable=false

Sell Recommendation

Override the onramp that is recommended by our default ranking engine with an offramp of your choice using sell_recommendation.

https://buy.onramper.com?sell_recommendation=transfi

Popular cryptos

sell_popularCryptos enables you to pass a comma-separated list of crypto tokens to be displayed at the top of the source (crypto) token selection dropdown list and marked as 'Popular'. Check out Crypto currencies to find your desired IDs (please use the values from the Onramper ID column).

The order of the popular tokens is preserved.

https://buy.onramper.com/?sell_popularCryptos=eth,btc,sol