Query Order

Introduction

Merchant call this api for query order status and order information. This API can only be invoked on the server side.

Domains

Test Environment: https://openapi-test.alchemypay.org/open/api/v4/merchant/query/trade

Prod Environment: https://openapi.alchemypay.org/open/api/v4/merchant/query/trade

API Description

Request Method: GET

Content-Type: application/json

Request Parameters

Header Parameters:

ElementMandatoryData TypeRemarks
appidYstringPartner unique ID; once a merchant has been on-boarded with Alchemy Pay, the merchant will be provided with the credentials with appId and appSecret
timestampYstringUTC time with 13 digits to represent time in milliseconds, the expiration period is 5 minutes.
signYstringSignature, you can refer to the signature here

Url Parameters:

ElementMandatoryData TypeRemarks
orderNoNstringAlchemyPay order No.
merchantOrderNoNstringMerchant defined order No.
sideYstringBUY/SELL

Request Parameter Example:

https://openapi-test.alchemypay.org/merchant/query/trade?orderNo=1028577684629876736&side=BUY

Response Parameters

Order Status Details:Order Status List

Response Parameter Example (onramp):

{
    "payTime": "2025-04-28 12:29:01",
    "txTime": "2025-04-28 12:35:06",
    "signature": "c85ac601fdbcd0e032995bcd1480998ade4647d10",
    "networkFee": "0.0418105",
    "rawRampFee": "1.999999",
    "fiatInUSD": "63.84",
    "network": "XMR",
    "cryptoPrice": "418.1045000",
    "payType": "bank transfer",
    "rampFee": "1.9888548",
    "appId": "8H98QYvuFx2XXXXG6",
    "fiat": "AUD",
    "newSignature": "kr0Ovkr2lLkCETKJ6SE3gj4fE0me2/oQ+TXXXXXxXC6Q=",
    "txHash": "3320d66dda0f0056bd3fbbd5fca2b2XXXXXXXXX1936fee386d8a594db",
    "email": "[email protected]",
    "rampFeeInUSD": "1.27",
    "amount": "99.99000000",
    "orderNo": "13662567157700006624",
    "address": "85Hn6hGPeugMiEM3xPYw5wXD5d6aUXwbsA8ykdUs84LNdrRfsRzcUDmXXXXXXXXXXamTR6RHiF9RedXsSVCVm3RBdFXdii",
    "cryptoNetworkFee": "0.0024597",
    "networkFeeInUSD": "0.65",
    "cryptoAmountInUSDT": "61.91330172",
    "merchantOrderNo": "01JSX7D7FCS6DXXXXXXXXX",
    "crypto": "XMR",
    "rampFeeUnit": "AUD",
    "cryptoQuantity": "0.2319",
    "status": "FINISHED" //PENDING, PAY_FAIL, PAY_SUCCESS, TRANSFER, CANCEL, FINISHED
}

Response Parameter Example (offramp):

{
  "orderNo": "1080106145537236992", 
  "address": "dev03dc84dbfeb74853aa91154efa9b7a13", // wallet address user need to transfer
  "payTime": "2023-02-28 20:44:46", // transfer fiat start time
  "completeTime": "2023-02-28 20:41:08", // block confirm time
  "merchantOrderNo": "kvhl6zvvrg", 
  "crypto": "USDT",
  "network": "TRX", 
  "cryptoPrice": "1.0000000000", // fiat
  "cryptoAmount": "100.0000000000",
  "fiatAmount": "100.0000000000", //fiat amount contains ramp fee
  "appId": "ahzxh0klegv1fzol",
  "fiat": "USD", 
  "txHash": "sdasdasdasdasdasdsad",
  "email": "[email protected]", 
  "signature": "9aa9b34e950061f1bb1e9ccd6fadcedab8e354f6",
  "status": "4",  // 1:order create success  2:user transfered token  3:start to pay fiat to user  4:payment success 5:payment fail 6:refund success 7:order expired
  "orderAddress": "https://ramp-dev.alchemytech.cc/#/sellOrder?sellOrderId\u003d1080106145537236992", // order detail page
  "cryptoActualAmount": "100.0000000000", // 
  "rampFee": "1.7500000000", // fiat
  "receiptTime": "2023-02-28 20:45:22", //transfer fiat success time
  "paymentType": "10001", //  10001 banktransfer
  "name": "asdfsfsd", // account name
  "account": "******4567", // account number
  "card": "", // card No 
  "failReason": "" // failReason
}