Widget Parameters
QuickPay provides a comprehensive range of customization options for the widget, facilitated through parameters added as query strings to the widget integration URL.
| Parameter | Type | Description |
|---|---|---|
| apiKey | string | The unique API key for your merchant account. |
| amount | number | The default payment amount to be displayed. |
| currency | string | The default fiat currency to be displayed. |
| crypto | string | The default cryptocurrency to be displayed. |
| language | string | The language for the widget interface. |
| layout | string | The layout mode of the widget (modal, inline, popup). |
| network | string | The default blockchain network for crypto payments. |
| callbackUrl | string | Webhook URL for payment completion notifications. |
| successUrl | string | Redirect URL for successful transactions. |
| cancelUrl | string | Redirect URL for cancelled transactions. |
| autoRedirect | boolean | Automatically redirect after payment completion. |
API Key
Your API key uniquely identifies your account and is essential for configuring features like payment processing, webhook support, and other important settings.
With your API key added, your URL will look something like this:
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxxhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxxAmount
The amount parameter sets the default payment amount to be displayed in the widget. This amount will be pre-filled in the payment form.
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&amount=99.99https://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&amount=99.99Currency
The currency parameter sets the default fiat currency to be displayed. If not specified, the widget will default to CNY.
Supported Fiat Currencies
| Currency | Code | Country/Region | Description |
|---|---|---|---|
| Chinese Yuan | CNY | 🇨🇳 中国 | Chinese Yuan Renminbi |
| Vietnamese Dong | VND | 🇻🇳 Việt Nam | Vietnamese Dong |
| Indian Rupee | INR | 🇮🇳 भारत | Indian Rupee |
| Thai Baht | THB | 🇹🇭 ประเทศไทย | Thai Baht |
| Indonesian Rupiah | IDR | 🇮🇩 Indonesia | Indonesian Rupiah |
| Philippine Peso | PHP | 🇵🇭 Pilipinas | Philippine Peso |
| Malaysian Ringgit | MYR | 🇲🇾 Malaysia | Malaysian Ringgit |
| South Korean Won | KRW | 🇰🇷 대한민국 | South Korean Won |
| Japanese Yen | JPY | 🇯🇵 日本 | Japanese Yen |
| Hong Kong Dollar | HKD | 🇭🇰 香港 | Hong Kong Dollar |
| Pakistani Rupee | PKR | 🇵🇰 پاکستان | Pakistani Rupee |
| Bangladeshi Taka | BDT | 🇧🇩 বাংলাদেশ | Bangladeshi Taka |
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx¤cy=KRWhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx¤cy=KRWCrypto
The crypto parameter sets the default cryptocurrency to be displayed. If not specified, the widget will use its recommendation algorithm based on the user's location and preferences.
Supported Cryptocurrencies
| Crypto | Code | Network | Description |
|---|---|---|---|
| Bitcoin | BTC | Bitcoin | Bitcoin (BTC) |
| Ethereum | ETH | Ethereum | Ethereum (ETH) |
| USDC | USDC | Ethereum | USD Coin |
| USDT | USDT | Ethereum | Tether |
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&crypto=ETHhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&crypto=ETHLanguage
The language parameter sets the interface language for the widget.
Supported Languages
| Language | Code | Description |
|---|---|---|
| English | en | English (default) |
| Chinese | zh | 中文 |
| Vietnam | vn | Tiếng Việt |
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&language=zhhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&language=zhLayout
The layout parameter controls how the widget is displayed on your website.
Available Layouts
| Layout | Description |
|---|---|
| modal | Opens in a modal overlay (default) |
| inline | Embeds directly in your page |
| popup | Opens in a popup window |
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&layout=inlinehttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&layout=inlineNetwork
The network parameter sets the default blockchain network for cryptocurrency payments.
Supported Networks
| Network | Code | Description |
|---|---|---|
| Bitcoin | bitcoin | Bitcoin Network |
| Ethereum | ethereum | Ethereum Network |
| Polygon | polygon | Polygon Network |
| BNB Smart Chain | bsc | BNB Smart Chain |
| Arbitrum | arbitrum | Arbitrum Network |
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&network=ethereumhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&network=ethereumCallback URL
The callbackUrl parameter specifies a webhook URL that will receive payment completion notifications. The URL should be URL-encoded.
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&callbackUrl=http://your-site.com/webhookhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&callbackUrl=http://your-site.com/webhookSuccess URL
The successUrl parameter specifies a redirect URL for successful transaction completion.
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&successUrl=http://your-site.com/successhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&successUrl=http://your-site.com/successCancel URL
The cancelUrl parameter specifies a redirect URL for cancelled transactions.
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&cancelUrl=http://your-site.com/cancelhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&cancelUrl=http://your-site.com/cancelAuto Redirect
The autoRedirect parameter controls whether users are automatically redirected after payment completion.
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&autoRedirect=falsehttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&autoRedirect=falseTransaction Timeout
The transactionTimeout parameter sets the timeout duration for transactions in seconds (60-3600).
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&transactionTimeout=600https://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&transactionTimeout=600Complete Examples
Basic Payment Widget
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&amount=99.99¤cy=CNY&theme=darkhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&amount=99.99¤cy=CNY&theme=darkCryptocurrency Payment
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&amount=0.01&crypto=BTC&network=bitcoin&gasStrategy=fasthttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&amount=0.01&crypto=BTC&network=bitcoin&gasStrategy=fastInline Widget with Callbacks
https://widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&layout=inline&callbackUrl=http://your-site.com/webhook&successUrl=http://your-site.com/success&cancelUrl=http://your-site.com/cancelhttps://sandbox-widget.quickpay.best/?apiKey=xxxxxxxxxxxxxxxx&layout=inline&callbackUrl=http://your-site.com/webhook&successUrl=http://your-site.com/success&cancelUrl=http://your-site.com/cancelUpdated 24 days ago