URL Parameters
Off-ramp URL
Production
List of parameters
Here is the list of parameters that can be added to the URL:
network
Wallet network from which user will send crypto. Supported values: POLYGON, AVALANCHE, CELO, ETHEREUM
asset
Wallet asset from which user will send crypto. Supported values: USDC,CUSD depending on network. Supported network/asset pairs: AVALANCHE (USDC, USDT), POLYGON (USDC, USDT), CELO (CUSD, USDT, USDC), ETHEREUM(USDC, USDT)
amount
If a currency is not provided, it will be an amount of crypto user wants to exchange. If currency is local it will be the amount of local currency user wants to receive.
offrampCurrency
Currency of the amount. Supported values: usd or local
offrampType
Type of the off-ramp: bank, airtime, mobile_money, paybill
country
default selected country iso code, example: KE for Kenya, NG for Nigeria
currencyIso
currency iso code, example: KES for Kenya, NGN for Nigeria. Acts like a country parameter.
freezeAmount
Freezes the amount of order for the user, the user will not be able to change it. The amount is required in the URL for this parameter to work.
freezeWallet
Freezes the wallet of order for the user, the user will not be able to change it. The wallet is required in the URL for this parameter to work.
orderParams
This parameter will be sent to a merchant webhook with order status changes
source
parameter used to match an order to a merchant
hideSwitch
if present, hides Buy/Sell switch at the top
Last updated