Page Integration
Description
Web integration is the most and simplest way to add AlchemyPay Ramp into your application, you only need to do is redirecting the user to our website:
Add Your Parameter
If you want to add some custom parameters when user redirect, such as user's address for purchasing crypto, amount of the crypto, you can add some parameters with values into the redirection URL. But you need to take appId and sign at least. Appid is your identity mark, and the sign is your signature, which are used for us to verify your parameters. You can view the available account information for the test environment here.
If the appid and sign you pass in can not match, the parameters you pass in will not be brought into the redirection.
Here is an example for using USD to buy USDT:
Test environment
Prod environment
Parameters
| Element | Mandatory | Signature | Remarks | Data Type |
|---|---|---|---|---|
| appId | Y | Y | Partner unique ID, once a merchant has been on-boarded with Alchemy Pay, the merchant will be provided with the credentials with appId and appSecret | string |
| token | N | N | Fetch from token API. With accessToken, email’s OTP authentication will skip. Processed by URLencode. | string |
| N | N | End user's mail, get from Fetch Token API with token if user want to skip the authentication. Processed by URLencode. Otherwise, just pass the email in plaintext. | string | |
| id | N | N | Session ID from fetch token API, pass with email and token. Processed by URLencode. | string |
| crypto | N | N | Crypto type, used to define a particular crypto to buy. | string |
| cryptoAmount | N | C | Crypto currency quantity for selling. Required for off-ramp | string |
| network | N | N | Crypto network | string |
| address | N | C | End user's crypto wallet address. it does function only when both crypto and network are defined, besides, it must be compatible with network. | string |
| language | N | N | zh-HK: Traditional Chinese en-US: English * es: Spanish | string |
| showTable | N | N | buy: Display on ramp only sell: Display off ramp only | string |
| redirectUrl | N | N | Redirect URL after buying crypto succeed | string |
| callbackUrl | N | C | Webhook URL to get the notify message from Alchemy Pay | string |
| merchantOrderNo | N | N | Merchant defined order ID | string |
| merchantName | N | N | Merchant defined name | string |
| country | N | N | Country code with two letters defined in ISO 3166-1 | string |
| fiatAmount | N | C | Fiat amount, unit in Dollar, Won, Yen, etc (VND and IDR must be integer) | string |
| fiat | N | C | Fiat type, char code with ISO4217 encoding（currently there are four currency USD, EUR, JPY, GBP) | string |
| memo | N | C | For XRP and RNB(BEP2 network) , this is a necessary parameter | string |
| urlType | N | C | Types of redirection to merchant page app/web | string |
| withdrawUrl | N | C | url to redirect merchant payment page | string |
| sign | Y | N | Signature,URLencode | string |
| type | C | N | 🔥Only for sale crypto, value = sell | string |
Note
- The test env does not support the whole process of off-ramp, you can test off-ramp in the prod env!
- address/callbackUrl with data set must have signature
- appSecret is used to sign
- You need to sort all parameters in ascending order according to parameter names to generate a signature string
Updated 9 days ago