Fiat Parameters
There are several optional filtering mechanisms available to limit the available fiat currencies in the Onramper widget.
Onramp
| Option | Type | Description |
|---|---|---|
defaultAmount | number | Default fiat amount to display when the widget loads (must be used with defaultFiat) |
defaultFiat | string | Default fiat currency to display when the widget loads |
isAmountEditable | boolean | Parameter to prevent the amount from being changed by the end-user |
onlyFiats | string | Select the specific fiat currencies to display |
excludeFiats | string | Select the specific fiat currencies to exclude |
defaultFiat | defaultAmount
The default behavior of the Onramper Widget utilizes country detection to automatically recommend the local fiat currency and fiat amount for each individual end-user.
This behavior can be customized by supplying the defaultFiat and defaultAmount parameters by adding it to your integration URL.
The defaultFiat can be supplied by itself, however the defaultAmount requires defaultFiat to also be added.
https://buy.onramper.com/?defaultAmount=5000&defaultFiat=PHP
onlyFiats | excludeFiats
The default behavior of the Onramper Widget is to show all available fiat currencies based on available Onramps and Payment Methods for each individual end-user.
This behavior can be customized by adding the excludeFiats parameter to exclude specific fiat currencies.
https://buy.onramper.com/?excludeFiats=USD,EUR
By utilizing the onlyFiats parameter you can select the specific fiat currencies to display in the Onramper Widget.
https://buy.onramper.com/?onlyFiats=USD
Offramp
| Option | Type | Description |
|---|---|---|
sell_defaultAmount | number | Default crypto amount to display when the widget loads (must be used with sell_defaultCrypto) |
sell_defaultFiat | string | Default fiat currency to display when the widget loads |
sell_isAmountEditable | boolean | Parameter to prevent the amount from being changed by the end-user |
sell_onlyFiats | string | Select the specific fiat currencies to display |
sell_excludeFiats | string | Select the specific fiat currencies to exclude |
sell_defaultFiat | sell_defaultAmount
The default behavior of the Onramper Widget utilizes country detection to automatically recommend the local fiat currency and fiat amount for each individual end-user.
This behavior can be customized by supplying the sell_defaultFiat and sell_defaultAmount parameters by adding it to your integration URL.
The sell_defaultFiat can be supplied by itself, however the sell_defaultAmount requires sell_defaultCrypto to also be added.
https://buy.onramper.com/?mode=sell&sell_defaultAmount=0.05sell_defaultCrypto=BTC
onlyFiats | excludeFiats
The default behavior of the Onramper Widget is to show all available fiat currencies based on available Onramps and Payment Methods for each individual end-user.
This behavior can be customized by adding the sell_excludeFiats parameter to exclude specific fiat currencies.
https://buy.onramper.com/?mode=sell&sell_excludeFiats=USD,EUR
By utilizing the sell_onlyFiats parameter you can select the specific fiat currencies to display in the Onramper Widget.
https://buy.onramper.com/?mode=sell&sell_onlyFiats=USD