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
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.
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. The merchantOrderNo cannot be duplicated. |
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. Upload this field, users cannot modify the fiat currency. If use this field, uploading country field is a must. |
country | N | string | Required when uploading the fiat field.Must correspond to the fiat field to be valid.Follow the ISO 3166-1 alpha-2 standard. |
cryptoAmount | Y | string | The quantity of the cryptocurrency that the user wishes to sell. If passed, users will be unable to modify the cryptocurrency quantity. When passing cryptoAmount, crypto must be passed simultaneously, otherwise it will be meaningless. |
crypto | Y | string | The cryptocurrency that the user wants to sell. You can check the cryptocurrencies supported by Alchemy Pay Click Here. If passed, users will not be able to select other cryptocurrencies. |
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. If passed, users will not be able to modify the network. The crypto and network parameters must match; otherwise, the passed parameters will not take effect. |
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. For the token generation rules, please refer to Click Here. If the token parameter is uploaded, the email parameter does not need to be uploaded. |
language | N | string | 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 the ramp page to only display the off-ramp option, you can pass this parameter: showTable=sell |
redirectUrl | N | string | The webpage link where the user will be redirected after selling. You can customize this page.URL encoding is required when concatenating to the request URL. |
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. |
Updated 18 days ago