Off Ramp Custom Parameters

In the webpage docking, you can pass in the following parameters to reduce user input, which will simplify the user's operation process and improve the conversion rate.

The parameters with "involve in sign" need to be signed as a string.

Sample Link：https://ramptest.alchemypay.org?appId=f83Is2y7L425rxl8&showTable=sell&type=sell

appId Involve in the sign

📘

AppId is required, you must pass in appId to make the following parameters take effect

type Must have

When you are in Off Ramp, this parameter must be passed.

eg：type=sell

merchantOrderNo

The merchant order number you generated for this order, Alchemy Pay will carry this parameter in the webhook, so you can track the order information through this parameter.

country Must have

This represents the country where the user's bank account is located. The country needs to match the fiat, otherwise, it will not take effect.

eg：country=US

fiat Involve in the sign

This represents the fiat currency that the user wants to exchange. If passed in, users will not be able to modify the fiat currency. The fiat currencies supported by Alchemy Pay can be check here.

eg：fiat=USD

cryptoAmount Involve in the sign/Must have

This represents the amount of digital currency the user wishes to sell. If passed in, the user will not be able to modify the amount of digital currency.

When you pass in cryptoAmount, you need to pass in crypto at the same time, otherwise, it will be meaningless.

eg：cryptoAmount=100

crypto Must have

This represents the digital currency that the user wants to sell. If passed in, users will not be able to purchase other digital currencies. The digital currencies supported by Alchemy Pay can be check here.

示例：crypto=USDT

network Must have

This represents the digital currency network that the user wants to sell. It is recommended to pass in both network and crypto so that the digital currency sold by the user can be accurately restricted. If passed in, the user will not be able to modify the network. The network can be viewed here.

The crypto and network parameters should match. If the crypto and network parameters you pass in do not match, the parameters you pass in will not take effect.

eg：network=ETH

email

This represents the email address used by the user. When you pass in this parameter, we will bring in this email address by default, but the user still needs to enter the email verification code to verify the secondary email address.

eg：email=[email protected]

token

If you have verified your user's email address and want the user to skip the email verification link in the AlchemyPay experience, you can pass in this parameter.

For token generation rules, refer to here.

🚧

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.

language

This represents the language of the ramp page opened by the user.

es Spanish
zh-HK Traditional Chinese
en-US English

eg：language=en-US

showTable

If you want the opened ramp page to only display the off-ramp option, you can pass in this parameter.

eg：showTable=sell

redirectUrl

This represents the link to the web page that the user is redirected to after a successful/failed purchase. You can customize this page.

callbackUrl Involve in the sign

After the status of the transaction changes, Alchemy Pay will notify you of the payment result to this address.

withdrawUrl Involve in the sign

If you want the user to go to your website to withdraw cash after creating an order, you can pass in this parameter. You can carry your order information in withdrawal so that when Alchemy Pay jumps to this page, you can get the information corresponding to the order.

urlType Involve in the sign

Can only be passed to the app or the web. This represents the type of withdrawal that the user jumps to.

merchantName

Merchant custom name, When the merchant passes in this name, the merchant name on the order completion page will be displayed according to this parameter.

sign

This parameter is mandatory.

Regarding the sign generation rules, refer to here.