Payout Query API

Tips

• All requests are Post requests, and the data format is json

API Documentation for Querying PayOut Result

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	-

Request Body Parameters

Name	Required	Type	Description
tradeNo	Yes	string	The transaction number provided by the merchant during payout
timestamp	Yes	string	Timestamp
sign	Yes	string	Encrypted signature

Request Example

{
  "sign": "ee5c512fe36fed2afe2d36ab248e0eb8",
  "timestamp": "1728613320708",
  "tradeNo": "test_00000002"
}

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.tradeNo	Yes	string	Transaction number returned by the merchant
data.platFormTradeNo	Yes	string	PayPro transaction number
data.orderAmount	Yes	float	Order amount
data.payAmount	Yes	float	Payment 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	Error description
data.successTime	Yes	string	Transaction success time (local time)

Successful Response Example**:

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728613339884,
    "success": true,
    "data": {
        "platFormTradeNo": "63mz9aepqczdw280",
        "tradeNo": "test_00000002",
        "orderAmount": "300.00",
        "payAmount": "200.00",
        "status": "0015",
        "message": "Processing",
        "successTime": "2024-10-12 12:59:32"
    }
}

---