Parameters

Here is a list of the available configuration parameters. With these parameters, you can set what users see when they open the widget.

Paremeter	Required	Description
env	true	This differentiates between the PRODUCTION environment and the SANDBOX environment. The options are production or sandbox.
action	true	A parameter to choose between the buy or sell mode of the widget. Options are buy - for buying crypto and sell - for selling crypto. Please note: This parameter is not relevant for redirect integration. Instead, the base URL must point to the correct action, being either https://widget.paychant.com/buy or https://widget.paychant.com/sell
partnerApiKey	true	Your Paychant Partner API Key. If you don't have one, please Fill out this form to request your Key.
listedAsset	false	This is an optional string parameter in a comma-separated list, it allows you to sets a list of available crypto assets for users to choose from. Only the crypto assets you set will be shown in the widget. This will be a string of comma-separated values, for example (listedAsset=ethereum_dai,polygon_matic,celo_cusd). If this parameter is not set, the user will select an asset on their own from all available assets. The list of the available crypto assets can be found here.
fiatAmount	false	fiatAmount is an integer parameter, that allows you to set the fiat amount of either buy or sell that will be presented to the user.
assetAmount	false	This is an integer optional parameter that represents the amount of crypto your user wants to buy or sell. If this is not set, the user will choose the amount on their own, but if it's set, users can't change the amount.
walletAddress	false	The blockchain address of the user's wallet where crypto will be sent to. This is an optional string parameter, If this parameter is not set, the user will be prompted to manually enter a wallet address.
selectedAsset	false	This is an optional string parameter that pre-selects a crypto asset that will be shown to the user when they are on the widget.
partnerLogoUrl	false	A hosted image URL of your brand logo. This will appear as the widget logo in your integration.
paymentMethod	false	This is an optional string parameter that pre-select the payment method type, If this parameter is not set, the user will be required to select the payment method. List of supported payment methods id can be found here
userEmailAddress	false	This is an optional string parameter that pre-sets the email address of your user to make the buy or sell process quicker. If this parameter is not set, the user will be prompted to enter their email
webhookStatusUrl	false	This is an optional parameter that allows you to subscribe to events via webhooks. More information about webhooks can be found here.
partnerThemeColor	false	This is an optional parameter to sets the theme color for the widget. If this parameter is set, Its changes the color of buttons, links, and highlighted text in the widget. Only hexadecimal codes are accepted but do not include the #. For example (2a1f63).
selectedFiatCurrency	false	An optional parameter that allows you to pre-set the code of the fiat currency you want the user to use in buying or selling crypto. A list of supported fiat currencies can be found here.
successUrl	false	This is an optional string parameter that allows you to provide a link that the user will be redirected to after completing the transaction. Please note: this parameter is only available for the Redirect integration.