Payout Query API

Tips

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

Brief Description

None

Request URL

/v1/payproPK/queryPayOutResult

Request Method

POST

Name	Required	Type	Description
merchantNo	Yes	string	None

Request Body Parameters

Name	Required	Type	Description
tradeNo	Yes	string	Transaction number passed when the merchant collects on behalf for outbound payments
timestamp	Yes	string	Timestamp
sign	Yes	string	Encryption

Request Example

{
    "tradeNo": "PKFORM_out002",
    "timestamp": "1724142308374",
    "sign": "000000000"
}

Success Response Example

Parameter Name	Required	Type	Description
msg	Yes	string	Request result (when returning "success", it only indicates the success of this request and cannot be used for merchant-side logical judgment)
code	Yes	string	Request response code (when returning "0000", it only indicates the success of this request and cannot be used for merchant-side logical judgment). For specific error codes, please refer to the business error code enumeration
timestamp	Yes	string	Timestamp (e.g., 1715941383720)
success	Yes	string	Transaction result
data	Yes	Object	Returned object
data.platFormTradeNo	Yes	string	Platform order number
data.tradeNo	Yes	string	Merchant order number
data.amount	Yes	string	Actual payment amount, which may include partial payments
data.status	Yes	string	Request result, which merchants can use for logical processing. "0000" indicates a successful transaction, "0015" indicates processing, and others are error codes, which can be treated as failures.
data.message	Yes	string	Error description
data.successTime	Yes	string	Transaction success time (local time)

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1719830071094,
    "success": true,
    "data": {
        "platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
        "tradeNo": "PKFORM_out002",
        "amount": "3000",
        "status": "00029",
        "message": "REJECTED_TRANSACTION",
        "successTime": "2024-07-01 18:34:31"
    }
}