Introduction

You may receive all transaction-related updates on your server without constantly triggering query order in Initiate API mode. Additionally, in Page mode, there is no query order functionality so you can set up a callback with a http endpoint that receives notifications.

Notify type

  • Fiat payment succeed
  • Received crypto
  • Fiat payment failed

Http method

  • POST
  • Content-Type: application/json

Notify payload

ElementMandatoryData TypeRemarks
appIdpartner unique ID, once a merchant has been on-boarded with Alchemy Pay, the merchant will be provided with the credentials with appId and appSecret
orderNoAlchemy Pay order ID
emailend user's email
cryptocrypto type
cryptoPricecrypto price
cryptoQuantitycrypto amount
payTyefiat payment method
fiatfiat type
amountfiat amount
payTimefiat payment time
networkcrypto network
addresscrypto address
txTimecrypto received time
txHashcrypto hash ID
statusPAY_FAIL, PAY_SUCCESS, FINISHED
messagefait payment failed cause
merchantOrderNomerchant order ID
networkFeecrypto network fee
rampFeeramp fee

Sample - Fiat payment failed

{
   "amount":"311.00000000",
   "orderNo":"1004509256035020800",
   "address":"0xdc8853549de541909cbedb8c55be4******eec5",
   "payTime":"2022-08-04 06:30:03",
   "txTime":"",
   "networkFee":"",
   "message":"Declined by 3-D Secure",
   "merchantOrderNo":"",
   "crypto":"USDC",
   "network":"MATIC",
   "cryptoPrice":"",
   "payType":"CREDIT_CARD",
   "rampFee":"12.89064997",
   "cryptoQuantity":"",
   "appId":"jcudotl1hwyvxhdp",
   "fiat":"EUR",
   "txHash":"",
   "email":"[email protected]",
   "status":"PAY_FAIL"
}

Sample - Received crypto

{
   "amount":"476.00000000",
   "orderNo":"1004435154356088832",
   "address":"0xdc8853549de541909cbedb8c55be41******eec5",
   "payTime":"2022-08-04 01:13:09",
   "txTime":"2022-08-04 01:19:00",
   "networkFee":"0.99980000",
   "message":"",
   "merchantOrderNo":"",
   "crypto":"USDC",
   "network":"MATIC",
   "cryptoPrice":"0.99990000",
   "payType":"CREDIT_CARD",
   "cryptoQuantity":"462.00000000",
   "appId":"jcudotl1hwyvxhdp",
   "fiat":"EUR",
   "txHash":"0x54c71c2910bfc26b4820f3ef3bf4ee7966be39fb422e7305432ccb******2bb3",
   "email":"[email protected]",
   "status":"FINISHED"
}

Sample - Fiat payment succeed

{
   "amount":"476.00000000",
   "orderNo":"1004435154356088832",
   "address":"0xdc8853549de541909cbedb8c55be41******eec5",
   "payTime":"2022-08-04 01:13:09",
   "txTime":"",
   "networkFee":"",
   "message":"",
   "merchantOrderNo":"",
   "crypto":"USDC",
   "network":"MATIC",
   "cryptoPrice":"0E-8",
   "payType":"CREDIT_CARD",
   "cryptoQuantity":"0E-8",
   "appId":"jcudotl1hwyvxhdp",
   "fiat":"EUR",
   "txHash":"",
   "email":"[email protected]",
   "status":"PAY_SUCCESS"
}