On Ramp Custom Parameters

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

-- appId

The unique ID assigned to you by Alchemy Pay can view it in the merchant background.

This parameter is required.

-- secret

The appid needs to match the secret, you can check it in the merchant background.

This parameter is required.

-- environment

TEST： Open the test environment link（ramptest.alchemypay.org）

PROD： Open the production environment link（ramp.alchemypay.org）

This parameter is required.

-- containerNode

-- language

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

es Spanish
zh-HK Traditional Chinese
en-US English

示例：language=en-US

-- 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

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

It is recommended that you can intercept the first two digits of the legal currency as the country parameter, except EUR (you can pass in FR for EUR)

eg：country=US

-- fiat

This represents the fiat currency that the user needs to pay. 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

-- fiatAmount

This represents the amount of fiat currency the user needs to pay. If passed in, the user will not be able to modify the order amount.

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

eg：fiatAmount=100

-- crypto

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

eg：crypto=USDT

-- network

This represents the digital currency network that the user is allowed to use. It is recommended to pass in both network and crypto so that the digital currency purchased 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.

eg：crypto=ETH

-- address

This represents the user's wallet address to receive digital currency. If passed in, the user will not be able to modify the wallet address.

The address needs to match the network. If the address you pass in does not match the network, all the parameters you pass in will not take effect.

When you pass in address, you need to ensure that address is an address owned by the user.

eg：address=0xf220caa5053fc9f81a968489e46b086ae907b6c9

-- memo

For some special networks, you need to pass in this field. For memo generation rules, you can refer to them here.

-- 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]

-- authentication

If you have verified your user's mailbox, you can pass in this parameter and specify it as Y, otherwise pass it as N.

🚧

Do not use this parameter if you cannot verify the user's email address. This will affect the user's payment success rate

-- redirectUrl

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

-- callbackUrl

After the user's purchase is successful/failed, Alchemy Pay will notify you of the payment result to this address. You can refer to here for the specific content of the notice.

-- 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.