On Ramp Custom Parameters

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

Attention: only appId is required for the following parameters, and all other parameters are optional.

Example link:

https://ramptest.alchemypay.org/?crypto=USDT&network=BSC&appId=f83Is2y7L425rxl8&sign=TUqyu6jxuhLsO7qtJmGplbI3CSGHNyvrETmlWDagGytpQio3VWFgGUcOxW2Ts6TQX3lyDQTwj%2F96uqSPXxQtieX2bZ2ddWacM3tIA%2Fo58Mc%3D&address=0xeaf936e4bd0cf40958e74fce896e976459a83b90

appId

📘

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

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.

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

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

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

Note: The memo parameter is required for BNB, EOS, SEI, XLM, and XRP networks.

🚧

When you pass in the address parameter, you must add sign, otherwise it will not take effect

sign

This parameter is mandatory when address is passed in. In other cases, no input is required.

Parameters required to signature including "address" and "appId". Here is an example of splicing:

address=0xeaf936e4bd0cf40958e74fce896e976459a83b90&appId=f83Is2y7L425rxl8

Regarding the sign generation rules, refer to 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]

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 on-ramp option, you can pass in this parameter.

eg:showTable=buy

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

After the user's purchase is successful/failed and receives the crypto, Alchemy Pay will notify you of the payment result to this address, you can refer the result to here.

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.

🚧

Implementing Google Pay on Android

Currently Google Pay cannot be used as a webview within Android apps. This is because pop-up blockers are built into the webviews, preventing Google Pay to be displayed. As a result, in order to allow your customers to purchase crypto using Google Pay, you will need to redirect the customer to the browser.

For more information: https://developers.google.com/pay/api/web/support/faq