Payout Query API

Tips

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

Brief Description

This API allows the business party to actively query the payment results.

Request URL

• /v1/payproVN/queryPayOutResult

Request Method

• POST

Header

Parameter	Required	Type	Description
merchantNo	Yes	string	Merchant number

Request Body Parameters

Name	Required	Type	Description
tradeNo	Yes	string	Transaction number provided by the merchant during payout.
timestamp	Yes	string	Timestamp of the request.
sign	Yes	string	Encrypted signature.

Request Example

{
  "sign": "b609f38f4c3900a82beaf2222611083d",
  "timestamp": "1729153976003",
  "tradeNo": "133323384"
}

Successful Response Example

Parameter Name	Required	Type	Description
msg	Yes	string	Request result (only indicates the success of the current request, not for merchant-side logic).
code	Yes	string	Response code (only indicates the success of the current request, not for merchant-side logic). For specific error codes, refer to the business error code enumeration.
timestamp	Yes	string	Timestamp of the response.
success	Yes	string	Transaction result.
data	Yes	Object	Returned object.
data.platFormTradeNo	Yes	string	Unique platform transaction number.
data.tradeNo	Yes	string	Merchant transaction number returned.
data.amount	Yes	string	Transaction amount.
data.status	Yes	string	Request result. "0000" indicates success, "0015" indicates processing, and other values indicate error codes for failure handling.
data.message	Yes	string	Error description.
data.successTime	Yes	string	Transaction success time (local time).

Successful Response Example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1729325978798,
    "success": true,
    "data": {
        "platFormTradeNo": "7zr8om5hzclkemsz",
        "tradeNo": "133323384",
        "amount": "50000.00",
        "status": "0000",
        "successTime": "2024-10-19 14:37:28"
    }
}