Payout Query API

Tips

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

API Documentation for Querying PayOut Result

Brief Description

• Query the current status and details of a payout order.

Request URL

• /v1/paypro/queryPayOutResult

Request Method

• POST

Header

Name	Required	Type	Description
merchantNo	Yes	String	Merchant number

Request Body Parameters

Name	Required	Type	Description
tradeNo	Yes	String	Merchant transaction number used when creating the payout order
timestamp	Yes	Long	13-digit Unix timestamp in milliseconds
sign	Yes	String	Request signature generated using the signature logic in the Overview

Request Example

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

Response Parameters

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	Long	Timestamp (e.g., 1715941383720)
success	Yes	Boolean	Whether the API request was accepted
data	Yes	Object	Response object
data.tradeNo	Yes	string	Merchant transaction number
data.platFormTradeNo	Yes	string	PayPro transaction number
data.orderAmount	Yes	String	Payout order amount in COP
data.status	Yes	string	Transaction status: 0000 success, 0015 processing, or 00029 failed.
data.message	Yes	string	Status or error description
data.successTime	Conditional	string	Transaction success time, formatted as yyyy-MM-dd HH:mm:ss; returned after a successful transaction

Processing Response Example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728613339884,
    "success": true,
    "data": {
        "platFormTradeNo": "63mz9aepqczdw280",
        "tradeNo": "test_00000002",
        "orderAmount": "300.00",
        "status": "0015",
        "message": "Processing"
    }
}

---