widget configuration
The following parameters can be used to customize the user journey in the widget.
| Parameter | Description |
|---|---|
| apiKey required | Your publishable API key. This is used to assign customers and transactions to your BlockATM account. |
| custNo | Your customer code, when orderNo is empty, custNo cannot be empty. Note '.' cannot be included. |
| orderNo | Your order code,Your orderNo and custNo cannot be empty at the same time. Note that "." cannot be included. |
| chainId | When a chainId is specified, customers will not be able to view or switch to other chains at the Cashier web. |
| defaultChainId | You can specify the chain displayed by default at the Cashier web, but customers can still choose other chains. Note: This field will be invalid when the chainId is specified. |
| lang | The BCP 47 standard language code representing the language the widget should use. If you pass a code for a language we do not support, the widget will remain in the current default language. This is usually the language of the customer's browser; if we do not offer that language, the widget will use English (en-US). |
| currency | The code of the cryptocurrency (e.g., USDT, USDC, DAI,supported-cryptocurrencies ) you want the customer to pay. The customer will not be able to select another currency. To differentiate between networks, use the currency codes listed in the BlockATM Dashboard. |
| defaultCurrency | The code of the cryptocurrency you would prefer the customer to pay. The customer can still select another currency. If both currencyCode and defaultCurrencyCode are passed, currencyCode will take precedence. You can change the list of stablecoins displayed on the checkout page by accessing the "TOKENS" option in your admin dashboard settings. |
| amount | A positive num representing how much cryptocurrency the customer wants to pay. Best used together with the currency parameters. |
| redirectURL | A URL you'd like to redirect the customer to after they complete the pay flow in the widget. We will append the transaction's ID and status as query parameters to your URL. BlockATM will add txId={{transactionId}}&status=pending to the redirectURL. |
| signature | All query parameter values (not the entire query string) need to be URL encoded before generating the signature in order for it to be valid.you need to enable it in the backend control panel. |
| minAmount | The minimum payment amount allowed for user input. This only applies when the amount field is not specified. |
| maxAmount | The maximum payment amount allowed for user input. This only applies when the amount field is not specified. |