Skip to content

PayIn Order Query

Use this API to query PayIn order status. It is recommended when no callback is received or status is unclear.

1. Endpoint

ItemDescription
HTTP MethodPOST
URL/payIn/orders/query
Content-Typeapplication/json
AuthMerchant signature (X-Merchant-Id / X-Timestamp / X-Nonce / X-Sign)

Signing rules: Signing and Verification.

2. Request

2.1 Top-level fields

FieldTypeRequiredDescription
merchantOrderNoStringYesMerchant order number

Example:

json
{
  "merchantOrderNo": "M202412220001"
}

3. Response

Unified response:

json
{
  "success": true,
  "data": {
    "payNo": "P202412220001",
    "merchantOrderNo": "M202412220001",
    "tradeNo": "T202412220001",
    "status": "SUCCESS",
    "amount": 100.00,
    "currency": "USD",
    "createdAt": 1734921000000,
    "updatedAt": 1734921005000,
    "expireAt": 1734922800000
  },
  "errCode": null,
  "errMsg": null
}

data fields

FieldTypeDescription
payNoStringPlatform order number
merchantOrderNoStringMerchant order number
tradeNoStringPlatform trade number
statusStringOrder status (see below)
amountDecimalOrder amount
currencyStringCurrency
createdAtLongCreated time (ms timestamp, UTC)
updatedAtLongUpdated time (ms timestamp, UTC)
expireAtLongExpire time (ms timestamp, UTC)
actionObjectPayment action (returned only when payment is in progress and requires redirect/QR)

Status meanings

StatusMeaning
INITOrder created, not yet in payment flow
SUCCESSPayment succeeded
FAILPayment failed
EXPIREDOrder expired
CLOSEDOrder closed
USER_PAYINGPayment in progress

action fields

FieldTypeDescription
typeStringREDIRECT / QR
urlStringRedirect URL when type=REDIRECT
qrContentStringQR content when type=QR
expiresAtLongExpire time (ms timestamp, UTC)