Payout Query API
Tips
- All requests are
Post
requests, and the data format isjson
- API Documentation for Querying Payment Results
Brief Description
- The business party can actively query the payment results.
Request URL
/v1/paypro/queryPayOutResult
Request Method
- POST
Header
Name | Required | Type | Description |
---|---|---|---|
merchantNo | Yes | string | - |
sign | Yes | string | Encrypted value |
Request Body Parameters
Name | Required | Type | Description |
---|---|---|---|
tradeNo | Yes | string | Transaction number passed by the merchant during the payout |
timestamp | Yes | string | Timestamp |
Request Example
{
"tradeNo": "1000002",
"timestamp": "1724142308374"
}
Successful Response Example
Parameter Name | Required | Type | Description |
---|---|---|---|
msg | Yes | string | Request result (Returning "success" only indicates the request was successful; it should not be used for merchant-side logic) |
code | Yes | string | Request response code (Returning "0000" only indicates the request was successful; it should not be used for merchant-side logic) |
timestamp | Yes | string | Timestamp (e.g., 1715941383720) |
success | Yes | string | Transaction result |
data | Yes | Object | Response object |
data.platFormTradeNo | Yes | string | PayPro transaction number |
data.tradeNo | Yes | string | Merchant transaction number returned |
data.amount | Yes | string | Transaction amount |
data.status | Yes | string | Request result. The merchant can use this for logical processing. "0000" indicates transaction success, "0015" indicates processing, and other codes are error codes that can be treated as failures. |
data.message | Yes | string | Status description |
data.successTime | Yes | string | Transaction success time (local time) |
Successful Response Example
{
"msg": "success",
"code": "0000",
"timestamp": 1719830071094,
"success": true,
"data": {
"platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
"tradeNo": "00000020",
"amount": "30000",
"status": "00029",
"message": "REJECTED_TRANSACTION",
"successTime": "2024-07-01 18:34:31"
}
}