Skip to content

Query Pay-out Order ​

Merchants query the status and detailed information of a pay-out order via this interface.


Interface Info ​

  • Endpoint: /payout/query
  • HTTP Method: POST
  • Content-Type: application/json; charset=utf-8

Request Header Parameters ​

ParameterRequiredTypeDescription
merchantNoYesstringMerchant Number
signYesstringRSA Signature (Refer to Global Specification)

Request Body Parameters ​

ParameterRequiredTypeDescription
timestampYesLongMillisecond timestamp
merchantOrderNoYesstringMerchant order number (Unique, letters + numbers, max length 32)

Response Examples ​

json
{
  "code": 1,
  "msg": "success",
  "data": {
    "merchantNo": "M1639466186292",
    "merchantOrderNo": "202112151143188593456",
    "platOrderNo": "876324486452871168",
    "amount": "220.00",
    "fee": "220.00",
    "status": "3",
    "dfpz": "https://example.com/voucher/876324486452871168.png"
  }
}
json
{
  "code": 0,
  "msg": "param merchant error"
}

Response Parameter Description ​

ParameterTypeDescription
codestring / number1 for Success, 0 for Failure
msgstringMessage explanation
dataobjectReturned data payload
└ merchantNostringMerchant Number
└ merchantOrderNostringMerchant Order Number
└ platOrderNostringPlatform Order Number
└ amountstringAmount
└ feestringService Fee
└ statusstringStatus: 0 Created, 1 Processing, 2 Failed, 3 Success
└ dfpzstringPayout voucher URL. Only present when the payment is successful