Page Integration

Description

Partner will redirect to Alchemy Pay’s On/Off ramp page, with inserting URL parameters into made of a key and a value separated by an equals sign (=) and joined by an ampersand(&). The first parameter always comes after a question mark in a URL. For example:

Test environment

https://[email protected]mytech.io&crypto=BTC&network=bitcoin&address=xxxxxxx&redirectURL=xxx&callbackUrl=xxx

Prod environment

https://[email protected]h.io&crypto=BTC&network=bitcoin&address=xxxxxxx&redirectURL=xxx&callbackUrl=xxx

Parameters

ElementMandatorySignatureRemarksData Type
appIdYYPartner unique ID, once a merchant has been on-boarded with Alchemy Pay, the merchant will be provided with the credentials with appId and appSecretstring
tokenNNFetch from token API. With accessToken, email’s OTP authentication will skipstring
emailNNEnd user's mail, from Fetch Token APIstring
idNNSession ID from fetch token APIstring
cryptoNNCrypto type, used to define a particular crypto to buystring
networkNNCrypto networkstring
addressNCEnd user's crypto address. it does function only when both crypto and network are defined, besides, it must be compatible with network.string
languageNN zh-HK: Traditional Chinese
en_US: English
string
showTableNN buy: Display on ramp only
sell: Display off ramp only
string
redirectUrlNNRedirect URL after buying crypto succeedstring
callbackUrlNCWebhook URL to get the notify message from Alchemy Paystring
fixedFeeNCmerchant defined fixed fee, two decimals maximum, unit in Dollar, Won, Yen, etc, need to work with feeRate together. this feature is is not available for every partner need a special partner agreement.string
feeRateNCmerchant defined rate, four decimals, need to work with fixedFee together. e.g. 0.03 mean 3%.this feature is is not available for every partner need a special partner agreement.string
networkFeeNCmerchant defined network fee, two decimals maximum, unit in Dollar, Won, Yen, etc.this feature is is not available for every partner need a special partner agreement.string
merchantOrderNoNNmerchant defined order IDstring
countryNNcountry code with two letters defined in ISO 3166-1string
fiatAmountNCfiat amount, unit in Dollar, Won, Yen, etcstring
fiatNCfiat type, char code with ISO4217 encoding(currently there are four currency USD, EUR, JPY, GBP)string
memoNCfor XRP and RNB(BEP2 network) , this is a necessary parameterstring
signYYSignaturestring

Note

  • address/callbackUrl with data set must have signature
  • appSecret is used to sign

Sign demo with appId

appId=jcudotl1hwyvxhdp&sign=e2UZuWKiuxApgQ15wRrfowq5ikX8S8AJwLr%2Bg3ttd44%3D

Sign demo with appId and callbackUrl

appId=jcudotl1hwyvxhdp&callbackUrl=https://www.amazon.com&sign=e2UZuWKiuxApgQ15wRrfo1Ps%2BQ%2BNHn%2Bwz6jfKD5VqcYb1l87WDDQnwtcALpd3ZfGPCvSSvPNjPoMj%2BlBBvne1A%3D%3D *

Sign demo with appId and address

appId=jcudotl1hwyvxhdp&address=0xEd04915c23f00A313a544955524EB7DBD823143d&sign=pDZv9gpreYXn%2F04yMTw3UTyNXFjhs%2FHAguZOZfRNxV2vM5aqvTTUtqByY%2BpZkN0GZe0jqGKvMq76LkGs6R4kw3StSdVxSXu%2FRD3wHVRQ6CA%3D *

Sign demo with appId, address and callbackUrl

appId=jcudotl1hwyvxhdp&address=0xEd04915c23f00A313a544955524EB7DBD823143d&callbackUrl=https://www.amazon.com&sign=pDZv9gpreYXn%2F04yMTw3UTyNXFjhs%2FHAguZOZfRNxV2vM5aqvTTUtqByY%2BpZkN0GZe0jqGKvMq76LkGs6R4kw%2FyVf9qTLdXO9N8K%2FFaj6eziblI%2FpsQz9lOIT5ZdZDJXGOUPptbXH2buUy9kAN5EGA%3D%3D