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

ParameterSignMandatoryTypeLengthRemarks
appIdYYstring64merchant appid
merchantOrderNoYYstring64merchant order number
signNYstring256sign
{ "appId": "TEST000001", "sign": "TEST000001", "merchantOrderNo": "11126" }

Response Parameter

ParameterSignTypeLengthRemarks
successYboolean/Mark of success
errorYboolean/Mark of error
codeYlong/Response code
msgYstring/Response message
traceIdYString/TraceId
modelYobject/Response content
└─orderNoYString64AEON order number
└─orderStatusYString32Order status
└─userIdYString128User ID(email or phone number)
└─userIpYString128User IP address
└─usdAmountYString32Order amount count as USD
└─fiatAmountYString32Order amount count as local fiat
└─fiatCurrencyYString32Fiat currency of user paid
└─fiatRateYString16Fiat currency exchange rate to USD
└─feeYString16Transaction fee count as USD
└─qrCodeYString128QRcode address
└─merchantOrderNoYString64Merchant order number (uniqle)
└─failReasonYstring256Failure reason
└─orderTimeNstring64UTC+8 time zone, formatted as yyyy-MM-dd hh:mm:ss

Order Status

CodeDetails
COMPLETEDPayment success
FAILEDPayment failure

Example:

{ "code": "0", "msg": "success", "model": { "orderNo": "31313131311111", "orderStatus": "COMPLETED", "userId": "12313131@121.com", "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 }

Did this page help you?