On Ramp Custom Parameters
Introduction:
- Simplify user flow: you can pass parameters to replace user input.
- Please verify the user's email address before use the
emailparameter. - Skip login page by use
tokenparameter. - All the parameter sent need to be signature.
Request Parameters
Parameter description:
Element | Mandatory | Data Type | Remarks |
|---|---|---|---|
appId | Y | string | Unique identifier assigned by Alchemy Pay. |
timestamp | Y | string | Thirteen-digit timestamp |
merchantOrderNo | Y | string | The merchantOrderNo cannot be duplicated. |
sign | Y | string | Sign rules. |
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 |
fiatAmount | N | string | The fiat currency amount that the user needs to pay
|
crypto | N | string | The cryptocurrency that the user wants to purchase. You can check
|
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.
|
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. |
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 | |
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 |
language | N | string | The language of the ramp page opened by the user. |
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: |
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 5 days ago