# URL Parameters

### List of parameters <a href="#list-of-parameters" id="list-of-parameters"></a>

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

| Parameter       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| address         | <p>Address of the wallet you want to receive crypto to<br><mark style="color:orange;"><strong>\[Warning]</strong></mark> 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.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| network         | Wallet network. Supported values: POLYGON, ETHEREUM, STELLAR, AVALANCHE, SOLANA,  CELO, BASE, LISK                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| asset           | Wallet asset. Supported values: **USDC**, **CUSD**, **USDT**, **USDC\_E, CKES** depending on network. The default value is **USDC** for all networks that support it except CELO, for CELO it's **CUSD**. Supported network/asset pairs: AVALANCHE (USDC), POLYGON (USDC, USDC\_E, USDT), CELO (CUSD, USDC, USDT, CKES), STELLAR (USDC), SOLANA (USDC),  BASE (USDC), ETHEREUM (USDC),  LISK (USDT)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| memo            | Memo for the transaction                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| amount          | If a currency is not provided, it will be an amount of crypto received after fees. If currency is **airtime,** it will be the amount of airtime a user should spend.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| minAmount       | Minimum amount of order in crypto                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| currency        | Currency of the amount. Supported values: **airtime** or **usdc**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| 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    | <p>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.<br><mark style="color:orange;"><strong>\[Warning]</strong></mark> 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.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| provider        | Default user funds source to select, supported values: **carrier**, **mpesa**, **mobile\_money**, **bank\_transfer**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| carrier         | id of a mobile carrier to select by default                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| callbackUrl     | <p>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: <strong><code>{orderId}</code></strong>, <strong><code>{transactionHash}</code></strong>, <strong><code>{usdcAmount}</code></strong>, <strong><code>{airtimeAmount}</code></strong>, <strong><code>{network}</code></strong>, <strong><code>{address}</code></strong>. For example the next URL <code><https://example.com/success/{orderId}/{usdcAmount}></code> will be converted to something like <code><https://example.com/success/648b3095a9f38d8b7b2da748/5.45></code>.<br><mark style="color:orange;"><strong>\[Warning]</strong></mark> provided URL should be encoded, <a href="https://meyerweb.com/eric/tools/dencoder/">example</a></p>                                                                                                                                                                                                                                                                                                                        |
| callbackBtnText | Text of the button that is displayed when **callbackUrl** is provided. Default is: "Back to website"                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| email           | user's email                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| closeBtn        | 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     | <p>if present, user will be redirected to this URL on order fail or success. It supports placeholders which will be replaced by order data: <strong><code>{orderId}</code></strong>, <strong><code>{transactionHash}</code></strong>, <strong><code>{usdcAmount}</code></strong>, <strong><code>{airtimeAmount}</code></strong>, <strong><code>{network}</code></strong>, <strong><code>{address}</code></strong>, <strong><code>{status}</code></strong>, <strong><code>{failReason}</code></strong>. <strong><code>{status}</code></strong> placeholder can the next values: <strong><code>success</code></strong> or <strong><code>fail</code></strong>. Fail reason placeholder can the next values: <strong><code>transaction\_failure</code></strong> or <strong><code>agent\_rejected</code></strong>. For example the next URL <code><https://example.com/success/{orderId}/{usdcAmount}></code> will be converted to something like <code><https://example.com/success/648b3095a9f38d8b7b2da748/5.45></code>.<br><mark style="color:orange;"><strong>\[Warning]</strong></mark> provided URL should be encoded, <a href="https://meyerweb.com/eric/tools/dencoder/">example</a></p> |
| quoteId         | id of a quote returned from the [price API request](https://docs.fonbnk.com/docs/pay-widget/merchant-api#get-expected-price).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| hideSwitch      | if present, hides the Buy/Sell switch at the top                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

Parameters allowed only for [registered merchants](https://docs.fonbnk.com/docs/pay-widget/use-cases#registered-merchant-integration-with-webhooks):

| Parameter   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| orderParams | This parameter will be sent to a merchant webhook after the success of the crypto transfer.                                                                                                                                                                                                                                                                                                                                                                                    |
| source      | <p>parameter used to match an order to a merchant if the merchant operates by a huge amount of wallets and can't provide them in the merchant dashboard. Merchants should request our support to assign a source to their accounts.<br><mark style="color:orange;"><strong>\[Warning]</strong></mark> 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.</p> |

Here is an example of a URL with parameters:

{% code overflow="wrap" %}

```
https://pay.fonbnk.com?amount=1&network=POLYGON&asset=USDT
```

{% endcode %}

[<br>](https://docs.fonbnk.com/docs/pay-widget/integration-guide)