On Ramp Custom Parameters
Introduction:
- By using page mode, you can pass parameters to replace user input and simplify the user flow.
- If you cannot confirm the user's email, please do not use the
email
parameter. If you have not verified the user's email, please do not use thetoken
parameter. - The link will take effect only after the mandatory parameters are sent.
Example link:
https://ramptest.alchemypay.org?appId=f83Is2y7L425rxl8&crypto=USDT&network=ETH&showTable=buy&fiat=USD&fiatAmount=30×tamp=1538054050234&sign=JY9JcOwBosncT19Nn9DIfTH%2BvfSt6xL%2BI%2BRVCl9YGgE%3D](https://ramptest.alchemypay.org?appId=f83Is2y7L425rxl8&crypto=USDT&network=ETH&showTable=buy&fiat=USD&fiatAmount=30×tamp=1538054050234&sign=JY9JcOwBosncT19Nn9DIfTH%2BvfSt6xL%2BI%2BRVCl9YGgE%3D
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 |
merchantOrderNo | Y | string | Merchant Order Number, unique order number provided by merchant.This parameter will carry in the webhook, allowing you to track order information through this parameter. The merchantOrderNo cannot be duplicated. |
sign | Y | string | Refer to this link for the sign generation rules Click Here.URL encoding is required when concatenating to the request URL. |
fiat | N | string | The fiat currency to be paid by the user (must be in uppercase),You can check the list of fiat currencies supported by Alchemy PayClick Here If passed, the user will not be able to change the fiat currency |
fiatAmount | N | string | The fiat currency amount that the user needs to pay If passed, the user will not be able to modify the order amount. When passing fiatAmount, it is necessary to simultaneously include the fiat parameter; otherwise, it will be meaningless. |
crypto | N | string | The cryptocurrency that the user wants to purchase. You can check the supported cryptocurrencies by Alchemy Pay Click Here. If passed, the user will not be able to change the cryptocurrencies. 'crypto' and 'network' must match; if they don't match, the parameter will not take effect. |
network | N | string | The cryptocurrency network that the user is allowed to use. It is recommended to pass 'network' and 'crypto' together to accurately limit the cryptocurrency the user can purchase. You can check the supported networks by Alchemy Pay Click Here. If passed, the user will not be able to change the network. 'crypto' and 'network' must match; if they don't match, the parameter will not take effect. |
address | N | string | The wallet address where the user wants to receive the cryptocurrency. If passed, the user will not be able to change the wallet address. The 'address' must match the 'network'; otherwise, the passed parameter will not take effect. Additionally, when passing 'address', make sure it is an address owned by the user. |
memo | N | string | Note: some networks require the memo field to be uploaded. Please refer Click Here |
N | string | The user's email. If you pass this parameter, we will automatically pre-fill the email. However, the user still needs to enter an email verification code to verify the email. | |
token | N | string | If you have already verified the user's email and want to skip the email verification process in AlchemyPay's experience, you can pass this parameter. Refer to this link for the token generation rules.Click Here If the token parameter is uploaded, the email parameter does not need to be uploaded. |
language | N | string | The language of the ramp page opened by the user. Spanish: es Traditional Chinese: zh-HK English: en-US Vietnamese: vi Indonesian: id eg:language=en-US |
showTable | N | string | If you want to display only the on-ramp options on the ramp page, you can pass this parameter. Use 'showTable=buy'. |
redirectUrl | N | string | The URL of the web page where the user will be redirected after a successful/failed purchase.URL encoding is required when concatenating to the request URL. |
callbackUrl | N | string | After a successful/failed purchase, Alchemy Pay will notify you of the payment result at this address. Refer to this link for the specific notification content.Click Here.URL encoding is required when concatenating to the request URL. |
merchantName | N | string | When merchants pass this custom name, the merchant name displayed on the order completion page will be shown according to this parameter. |
displayAddress | N | string | Fixed: true If the address parameter is uploaded along with this parameter, it will redirect to the "Confirm wallet address page". |
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.
- Please refer to this:https://alchemypay.readme.io/v4.0.2/docs/google-pay-android-adaptation-solution
- Official documentation for Google Pay: https://developers.google.com/pay/api/web/support/faq
Updated 1 day ago