Off 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
emailparameter. If you have not verified the user's email, please do not use thetokenparameter. - The link will take effect only after the mandatory parameters are sent.
- All the parameter sent need to be signature.
- Order timeout in 48 hours.
- If you want to transfer crypto to Alchemy Pay for user, please check Hiding Receiving Address Page.
Request Parameters
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 |
type | Y | string | Fixed value: sell |
merchantOrderNo | Y | string | Merchant order number, Alchemy Pay will carry this parameter in the webhook, allowing you to track order information using this parameter. |
sign | Y | string | For the generation rules of the sign, please refer to this Click Here.URL encoding is required when concatenating to the request URL. |
fiat | N | string | Fiat currency user received, check the supported fiat currencies by Alchemy Pay Click Here. |
country | N | string | Required when uploading the |
cryptoAmount | Y | string | The quantity of the cryptocurrency that the user wishes to sell.
|
crypto | Y | string | The cryptocurrency that the user wants to sell. You can check the cryptocurrencies supported by Alchemy Pay Click Here. |
network | Y | string | The cryptocurrency network that the user wants to sell. It is recommended to pass both the network and crypto parameters together to accurately limit the cryptocurrency the user can sell. You can check the supported networks Click Here.
|
N | string | Email used by the user. When you pass this parameter, we will pre-fill this email, but the user still needs to enter an email verification code to validate the email. | |
token | N | string | If you have already verified the email of your user and wish to skip the email verification process during the Alchemy Pay experience, you can pass this parameter. |
language | N | string | Language of the ramp page opened by the user. |
showTable | N | string | If you want the ramp page to only display the off-ramp option, you can pass this parameter: showTable=sell |
callbackUrl | N | string | After the user sells, Alchemy Pay will notify you of the payment result at this address.URL encoding is required when concatenating to the request URL. |
merchantName | N | string | Merchant custom name, when merchants pass this name, the merchant name on the order completion page will be displayed according to this parameter. |
withdrawUrl | N | string | If you wish for the user to go to your website for withdrawal after creating an order, you can pass this parameter. You can carry your order information in the withdrawUrl, so when Alchemy Pay redirects to this page, you can retrieve the corresponding information for the order. |
urlType | N | string | APP: |
Updated 25 days ago