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:
Element | Mandatory | Data Type | Remarks |
---|---|---|---|
appid | Y | string | 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 |
timestamp | Y | string | UTC time with 13 digits to represent time in milliseconds, the expiration period is 5 minutes. |
sign | Y | string | Signature, you can refer to the signature here |
Url Parameters:
Element | Mandatory | Data Type | Remarks |
---|---|---|---|
orderNo | N | string | AlchemyPay order No. |
merchantOrderNo | N | string | Merchant defined order No. |
side | Y | string | BUY/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-09-19 15:07:07",
"txTime": "2025-09-19 15:09:06",
"networkFee": "0",
"rebateFiatAmount": "",
"rawRampFee": "67.500000",
"fiatInUSD": "52.52",
"network": "TRX",
"tokenAddress": "",
"cryptoPrice": "57.97340000",
"payType": "GCASH",
"rampFee": "67",
"appId": "Y0Bo*************4d9",
"fiat": "PHP",
"txHash": "13528*******************20",
"rampFeeInUSD": "1.18",
"side": "BUY",
"amount": "3000.00000000",
"orderNo": "1418493255*******368",
"address": "33************402",
"cryptoNetworkFee": "0",
"networkFeeInUSD": "0",
"cryptoAmountInUSDT": "51.3387",
"rebateUsdAmount": "",
"crypto": "USDT",
"rampFeeUnit": "PHP",
"cryptoQuantity": "50.58",
"createTime": "2025-09-19 15:05:46",
"alpha2": "PH",
"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
}
Updated 17 days ago