Skip to main content

URL Parameters

Off-ramp URL

EnvironmentURL
Sandboxhttps://sandbox-pay.fonbnk.com/offramp
Productionhttps://pay.fonbnk.com/offramp

List of parameters

Here is the list of parameters that can be added to the URL:

ParameterDescription
networkWallet network from which user will send crypto. Supported values: POLYGON, AVALANCHE, CELO, ETHEREUM
assetWallet 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)
amountIf 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.
offrampCurrencyCurrency of the amount. Supported values: usd or local
offrampTypeType of the off-ramp: bank, airtime, mobile_money, paybill
countrydefault selected country iso code, example: KE for Kenya, NG for Nigeria
currencyIsocurrency iso code, example: KES for Kenya, NGN for Nigeria. Acts like a country parameter.
freezeAmountFreezes 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.
freezeWalletFreezes 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.
orderParamsThis parameter will be sent to a merchant webhook with order status changes
sourceparameter used to match an order to a merchant