Crypto Parameters
There are several optional filtering mechanisms available to limit the available crypto currencies in the Onramper widget.
Onramp
| Option | Type | Description |
|---|---|---|
defaultCrypto | string | Default crypto currency to display when the widget loads |
excludeCryptos | string | Parameter to exclude specific crypto currencies |
onlyCryptos | string | Select the specific crypto currencies to display |
excludeCryptoNetworks | string | Parameter to exclude specific crypto networks |
onlyCryptoNetworks | string | Select the specific crypto networks to display |
defaultCrypto
The default behavior of the Onramper Widget utilizes our recommendation algorithm to show the currently most-used currency for the end-user country.
This behavior can be customized by supplying the defaultCrypto parameter by adding it to your integration URL.
https://buy.onramper.com/?defaultCrypto=ETH
excludeCryptos | onlyCryptos
The default behavior of the Onramper Widget is to show all available crypto currencies based on available Onramps, Fiat Currencies and Payment Methods for each individual end-user.
This behavior can be customized by adding the excludeCryptos parameter to exclude specific crypto currencies.
https://buy.onramper.com/?excludeCryptos=BTC,ETH
By utilizing the onlyCryptos parameter you can select the specific crypto currencies to display in the Onramper Widget.
https://buy.onramper.com/?onlyCryptos=ETH
excludeCryptoNetworks | onlyCryptoNetworks
The default behavior of the Onramper Widget is to show all available crypto currencies based on available Onramps, Fiat Currencies and Payment Methods for each individual end-user.
This behavior can be customized by adding the excludeCryptoNetworks parameter to exclude specific crypto networks.
https://buy.onramper.com/?excludeCryptoNetworks=BITCOIN
By utilizing the onlyCryptoNetworks parameter you can select the specific crypto networks to display in the Onramper Widget.
https://buy.onramper.com/?onlyCryptoNetworks=ETHEREUM,POLYGON
Offramp
| Option | Type | Description |
|---|---|---|
sell_defaultCrypto | string | Default crypto currency to display when the widget loads |
sell_excludeCryptos | string | Parameter to exclude specific crypto currencies |
sell_onlyCryptos | string | Select the specific crypto currencies to display |
sell_excludeCryptoNetworks | string | Parameter to exclude specific crypto networks |
sell_onlyCryptoNetworks | string | Select the specific crypto networks to display |
sell_defaultCrypto
The default behavior of the Onramper Widget utilizes our recommendation algorithm to show the currently most-used currency for the end-user country.
This behavior can be customized by supplying the sell_defaultCrypto parameter by adding it to your integration URL.
https://buy.onramper.com?mode=sell&sell_defaultCrypto=ETH
sell_excludeCryptos | sell_onlyCryptos
The default behavior of the Onramper Widget is to show all available crypto currencies based on available Onramps, Fiat Currencies and Payment Methods for each individual end-user.
This behavior can be customized by adding the sell_excludeCryptos parameter to exclude specific crypto currencies.
https://buy.onramper.com/?mode=sell&sell_excludeCryptos=BTC,ETH
By utilizing the sell_onlyCryptos parameter you can select the specific crypto currencies to display in the Onramper Widget.
https://buy.onramper.com/?mode=sell&sell_onlyCryptos=ETH
sell_excludeCryptoNetworks | sell_onlyCryptoNetworks
The default behavior of the Onramper Widget is to show all available crypto currencies based on available Onramps, Fiat Currencies and Payment Methods for each individual end-user.
This behavior can be customized by adding the sell_excludeCryptoNetworks parameter to exclude specific crypto networks.
https://buy.onramper.com/?mode=sell&sell_excludeCryptoNetworks=BITCOIN
By utilizing the sell_onlyCryptoNetworks parameter you can select the specific crypto networks to display in the Onramper Widget.
https://buy.onramper.com/?mode=sell&sell_onlyCryptoNetworks=ETHEREUM,POLYGON