Off Ramp Custom Parameters

In the web docking, you can pass the following parameters to reduce user input, which will simplify the user's workflow and improve conversion rate.

Please note that the parameters marked as "Y" in the required column must be submitted, while all other parameters are optional.

Parameter description:

Element	Mandatory	Data Type	Remarks
appId	Y	string	Unique identifier assigned by Alchemy Pay. You can find it in the merchant backend
timestamp	Y	string	Thirteen-digit timestamp
type	Y	string	Fixed value: sell
merchantOrderNo	Y	string	Merchant order number, Alchemy Pay will carry this parameter in the webhook, allowing you to track order information using this parameter.
country	Y	string	Country where the user's bank account is located The country needs to match the fiat currency, otherwise it will not take effect
sign	Y	string	For the generation rules of the sign, please refer to this Click Here.
fiat	N	string	The fiat currency denomination that the user wants to exchange. You can check the supported fiat currencies by Alchemy Pay Click Here. If passed, users will not be able to modify the fiat currency denomination
cryptoAmount	N	string	The quantity of the cryptocurrency that the user wishes to sell. If passed, users will be unable to modify the cryptocurrency quantity. When passing cryptoAmount, crypto must be passed simultaneously, otherwise it will be meaningless.
crypto	N	string	The cryptocurrency that the user wants to sell. You can check the supported cryptocurrency denominations by Alchemy Pay Click Here. If passed, users will not be able to select other cryptocurrencies.
network	N	string	The cryptocurrency network that the user wants to sell. It is recommended to pass both the network and crypto parameters together to accurately limit the cryptocurrency the user can sell. You can check the supported networks Click Here. If passed, users will not be able to modify the network. The crypto and network parameters must match; otherwise, the passed parameters will not take effect.
email	N	string	Email used by the user. When you pass this parameter, we will pre-fill this email, but the user still needs to enter an email verification code to validate the email.
token	N	string	If you have already verified the email of your user and wish to skip the email verification process during the Alchemy Pay experience, you can pass this parameter. For the token generation rules, please refer to Click Here.
language	N	string	Language of the ramp page opened by the user.
showTable	N	string	If you want the ramp page to only display the off-ramp option, you can pass this parameter: showTable=sell
redirectUrl	N	string	The webpage link where the user will be redirected after selling. You can customize this page.
callbackUrl	N	string	After the user sells, Alchemy Pay will notify you of the payment result at this address.
withdrawUrl	N	string	If you wish for the user to go to your website for withdrawal after creating an order, you can pass this parameter. You can carry your order information in the withdrawUrl, so when Alchemy Pay redirects to this page, you can retrieve the corresponding information for the order.
urlType	N	string	Only "app" or "web" can be passed. This represents the type of the withdrawUrl that the user will be redirected to.
merchantName	N	string	Merchant custom name, when merchants pass this name, the merchant name on the order completion page will be displayed according to this parameter.

🚧

Do not use this parameter if you cannot verify the user's email address. If you have already generated a token, you only need to pass in the token in the link, and you don't need to pass in the email.