Query Order
Introduction
After user pay for order, merchant can update order status by using this interface.
API Description
Request Method:POST
Request Path:open/api/payment/query
Request Parameter
| Parameter | Sign | Mandatory | Type | Length | Remarks |
|---|---|---|---|---|---|
| appId | Y | Y | string | 64 | merchant appid |
| merchantOrderNo | Y | Y | string | 64 | merchant order number |
| sign | N | Y | string | 256 | sign |
{
"appId": "TEST000001",
"sign": "TEST000001",
"merchantOrderNo": "11126"
}Response Parameter
| Parameter | Type | Length | Remarks |
|---|---|---|---|
| success | boolean | / | Mark of success |
| error | boolean | / | Mark of error |
| code | long | / | Response code |
| msg | string | / | Response message |
| traceId | String | / | TraceId |
| model | object | / | Response content |
| └─orderNo | String | 64 | AEON order number |
| └─orderStatus | String | 32 | Order status |
| └─userId | String | 128 | User ID(email or phone number) |
| └─userIp | String | 128 | User IP address |
| └─usdAmount | String | 32 | Order amount count as USD |
| └─fiatAmount | String | 32 | Order amount count as local fiat |
| └─fiatCurrency | String | 32 | Fiat currency of user paid |
| └─fiatRate | String | 16 | Fiat currency exchange rate to USD |
| └─fee | String | 16 | Transaction fee count as USD (retains eight digits ) |
| └─qrCode | String | 128 | QRcode address |
| └─merchantOrderNo | String | 64 | Merchant order number (uniqle) |
| └─failReason | string | 256 | Failure reason |
| └─orderTime | string | 64 | UTC+8 time zone, formatted as yyyy-MM-dd hh:mm:ss |
| └─productInfo | object | 512 | Product information( USD order) |
Productinfo(USD order) Example
{
"bankCode": "CT000000002936",
"pin": "07345498",
"imageUrl": "https://xxxxxxxxxxxx.us-west-2.amazonaws.com/merchant/spiderman/1htf5d8ik_7a33m2_r45un9_aeh7mo_Target%C3%A5%C2%8D%C2%A1%C3%A6%C2%A8%C2%A1%C3%A7%C2%89%C2%88.png",
"cardCode": "044600035655732",
"priceStart": "10",
"priceEnd": "2000",
"bankName": "XXXXXXXXXXXXXXXXXXXX",
"barcode": "https://xxxxxxxxxxxxxxx.com?q=%7BAES-EG-V1%7D102102215179242104096235186163013203094017214138198043034122194093074150108113202121074122036088246185004190031248040007209068104066066124238032239217025245156141135053065061168070211118055206",
"logoUrl": "https://xxxxxxxxxxxx.us-west-2.amazonaws.com/merchant/spiderman/1htf5d8ik_7a33m2_r45un9_aeh7mo_Target%C3%A5%C2%8D%C2%A1%C3%A6%C2%A8%C2%A1%C3%A7%C2%89%C2%88.png"
}Order Status
| Code | Details |
|---|---|
| INIT | Order Created Successfully |
| PENDING | Processing Order |
| SUCCESS | Payment success |
| FAIL | Payment failure |
| ERROR | Order Creation Failed |
| TIMEOUT | TIMEOUT |
| COLLECTION_FAILED | Channel payment failure (for MXN,NGN) |
Success Example:
{
"code": "0",
"msg": "success",
"model": {
"orderNo": "31313131311111",
"orderStatus": "SUCCESS",
"userId": "[email protected]",
"userIp": "127.0.0.1",
"usdAmount": "10.01",
"fiatAmount": "100001",
"fiatCurrency": "VND",
"fiatRate": "2111",
"fee": "2.1",
"qrCode": "00020101021138580010A000000727012800069704070114190360421800120208QRIBFTTA53037045802VN830084006304EDC5",
"merchantOrderNo": "313131",
"failReason": "",
"orderTime": "2023-12-09 18:34:26"
},
"traceId": "66cff1bec8a8a398c1c8e80e38e7572e",
"success": true,
"error": false
}Updated 17 days ago
