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 the user will send crypto.Supported values: USDC, CUSD, USDT, CKES, CGHS, depending on the network. The default value is USDC for all networks that support it, except CELO, which is CUSD for CELO. Supported network/asset pairs: AVALANCHE (USDC/USDT), POLYGON (USDC, USDT), CELO (CUSD, USDC, USDT, CKES, CGHS), STELLAR (USDC), SOLANA (USDC, USDT), BASE (USDC), ETHEREUM (USDC, USDT), LISK (USDT), OPTIMISM (USDC, USDT), BNB (USDC, USDT), ARBITRUM (USDC, USDT), TRON (USDT), TON (USDT, USDE)
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.
currency
Currency of the amount. Supported values: crypto or local
paymentChannel
Type of the off-ramp: bank, airtime, mobile_money, paybill
countryIsoCode
default selected country iso code, example: KE for Kenya, NG for Nigeria
currencyIsoCode
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.
hideSwitch
if present, hides Buy/Sell switch at the top
Parameters allowed only for registered merchants:
orderParams
This parameter will be sent to a merchant webhook with order status changes
source
parameter used to match an order to a merchant
[Warning] In production, you must be a verified merchant to use this parameter. Please contact our team for a KYB process.
signature
A JWT token (HS256 encryption algorithm) is generated using the "URL signature secret" value as a secret. You must add some unique value to the token payload to make each token unique because we don't allow creating more than one order using the same signature.
[Warning] In production, you must be a verified merchant to use this parameter. Please contact our team for a KYB process.
Here is an example of a URL with parameters:
https://pay.fonbnk.com/offramp?amount=1&network=POLYGON&asset=USDTLast updated