URL params
Here's a list of URL params that allow you to configure the Pay Widget.
address
on-ramp
Address of the wallet you want to receive crypto to [Warning] In production, you must be a verified merchant to use this parameter, also a valid signature parameter should be present. Please contact our team for a KYB process.
network
on-ramp / off-ramp
Wallet network. Supported values: ARBITRUM, AVALANCHE, BASE, BNB, CELO, ETHEREUM, LISK, OPTIMISM, POLYGON, SOLANA, STELLAR, TON, TRON
asset
on-ramp / off-ramp
Wallet asset. 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)
memo
on-ramp
Memo for the Stellar, TON and other networks transactions that support it
amount
on-ramp / off-ramp
If a currency is not provided, it will be an amount of crypto received after fees. If currency is local, it will be the amount of local currency a user should spend.
currency
on-ramp / off-ramp
Currency of the amount. Supported values: local or crypto
countryIsoCode
on-ramp / off-ramp
default selected country iso code, example: KE for Kenya, NG for Nigeria
currencyIsoCode
on-ramp / off-ramp
currency iso code, example: KES for Kenya, NGN for Nigeria. Acts like a country parameter.
freezeAmount
on-ramp / off-ramp
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
on-ramp
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. [Warning] In production, you must be a verified merchant to use this parameter, also a valid signature parameter should be present. Please contact our team for a KYB process.
paymentChannel
on-ramp / off-ramp
Default user funds source to select, supported values: airtime, mobile_money, bank
carrierCode
on-ramp / off-ramp
The code of a mobile carrier to select by default. Examples: ng_mtn, ke_safaricom etc.
callbackUrl
on-ramp
if present, "Back to website" link will be displayed on the success page. When a user clicks on it, we will redirect him to the provided URL. It supports placeholders which will be replaced by order data: {orderId}, {transactionHash}, {usdcAmount}, {airtimeAmount}, {network}, {address}. For example the next URL https://example.com/success/{orderId}/{usdcAmount} will be converted to something like https://example.com/success/648b3095a9f38d8b7b2da748/5.45.
[Warning] provided URL should be encoded, example
callbackBtnText
on-ramp
Text of the button that is displayed when callbackUrl is provided. Default is: "Back to website"
on-ramp / off-ramp
user's email
closeBtn
on-ramp
text of the button that will be displayed on the success page. If not provided, the button will not be displayed. On click, it will send a close-iframe iframe event, so an integrator can close the widget.
redirectUrl
on-ramp
if present, user will be redirected to this URL on order fail or success. It supports placeholders which will be replaced by order data: {orderId}, {transactionHash}, {usdcAmount}, {airtimeAmount}, {network}, {address}, {status}, {failReason}. {status} placeholder can the next values: success or fail. Fail reason placeholder can the next values: transaction_failure or agent_rejected. For example the next URL https://example.com/success/{orderId}/{usdcAmount} will be converted to something like https://example.com/success/648b3095a9f38d8b7b2da748/5.45.
[Warning] provided URL should be encoded, example
hideSwitch
on-ramp / off-ramp
if present, hides the Buy/Sell switch at the top
orderParams
on-ramp / off-ramp
This parameter will be sent to a merchant webhook after the success of the crypto transfer.
source
on-ramp / off-ramp
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
on-ramp / off-ramp
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.
Last updated