Skip to content

Query Payment Order

Updated: 7/26/26, 9:23:52 PM

Description

Query system order details by order number, including current payment status and amount.

Request

POST /unipay/query/pay-order

  • Auth: RSA signature (@PaymentVerify)
  • Response: DaxResult<NormalPayOrderResult>

Parameters

Common params same as Pay - Common Parameters. Business parameters:

ParameterTypeRequiredMaxDescription
orderNostringNo*100Platform order number
bizOrderNostringNo*100Merchant order number

*At least one required. Priority: orderNo > bizOrderNo

Example

json
{
  "mchNo": "M200000001",
  "appId": "APP001",
  "reqId": "REQ20241201003",
  "reqTime": "2024-12-01 12:10:00",
  "sign": "Base64Signature",
  "orderNo": "P2024120112345700001"
}

Response

DaxResult<NormalPayOrderResult>, data fields:

FieldTypeDescription
orderNostringPlatform order number
bizOrderNostringMerchant order number
tradeNostringFund trade number
outOrderNostringChannel order number
titlestringOrder title
descriptionstringOrder description
channelstringPayment channel (ChannelEnum)
methodstringPayment method (PayMethodEnum)
limitPaystringRestricted payment type (PayLimitPayEnum)
amountlongAmount (cents)
realAmountlongActual paid amount (cents)
refundableBalancelongRefundable balance (cents)
statusstringPay status (PayStatusEnum)
refundStatusstringRefund status (PayRefundStatusEnum)
providerstringPayment provider (PayProviderEnum, e.g., WECHAT/ALIPAY)
payTimestringPayment time (UTC)
closeTimestringClose time (UTC)
expiredTimestringExpiry time (UTC)
terminalNostringTerminal device code
storeNostringStore number
buyerIdstringBuyer user ID
attachstringCustom data (returned as-is)
errorMsgstringError message

Refund Status (PayRefundStatusEnum)

Refund marker on the payment order:

refundStatusDescription
no_refundNo refund
refundingRefund processing
partial_refundPartially refunded
refundedFully refunded

Example

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "orderNo": "P2024120112345700001",
    "bizOrderNo": "ORDER20241201001",
    "tradeNo": "T2024120112345700001",
    "outOrderNo": "WX2024120100001",
    "title": "Test Product",
    "channel": "wechat",
    "method": "wechat_qr",
    "amount": 100,
    "realAmount": 100,
    "refundableBalance": 100,
    "status": "success",
    "refundStatus": "no_refund",
    "provider": "WECHAT",
    "payTime": "2024-12-01T04:00:00Z",
    "expiredTime": "2024-12-01T04:30:00Z",
    "attach": "{\"orderId\": 123}"
  },
  "sign": "Base64Signature",
  "resTime": "2024-12-01T04:10:00Z",
  "reqId": "REQ20241201003"
}

Released under the GNU LGPL v3.0