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

ParameterTypeLengthRemarks
successboolean/Mark of success
errorboolean/Mark of error
codelong/Response code
msgstring/Response message
traceIdString/TraceId
modelobject/Response content
└─orderNoString64AEON order number
└─orderStatusString32Order status
└─userIdString128User ID(email or phone number)
└─userIpString128User IP address
└─usdAmountString32Order amount count as USD
└─fiatAmountString32Order amount count as local fiat
└─fiatCurrencyString32Fiat currency of user paid
└─fiatRateString16Fiat currency exchange rate to USD
└─feeString16Transaction fee count as USD (retains eight digits )
└─qrCodeString128QRcode address
└─merchantOrderNoString64Merchant order number (uniqle)
└─failReasonstring256Failure reason
└─orderTimestring64UTC+8 time zone, formatted as yyyy-MM-dd hh:mm:ss
└─productInfoobject512Product 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

CodeDetails
INITOrder Created Successfully
PENDINGProcessing Order
SUCCESSPayment success
FAILPayment failure
ERROROrder Creation Failed
TIMEOUTTIMEOUT
COLLECTION_FAILEDChannel 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
}