Check Disbursement Status
Tip
- All requests are
Post requests, and the data format is json
- API Documentation for Querying Payment Results
Brief Description
- The business party can actively query the payment results.
Request URL
/v1/vexora/queryPayOutResult
Request Method
- Method: POST
- Content-Type: application/json
| Name |
Required |
Type |
Description |
| merchantNo |
Yes |
String |
- |
Request Body Parameters
| Name |
Required |
Type |
Description |
| tradeNo |
Yes |
String |
Transaction number passed by the merchant during the payout |
| timestamp |
Yes |
String |
Timestamp |
| sign |
Yes |
String |
Encrypted value |
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 |
vexora transaction number |
| data.tradeNo |
Yes |
String |
Merchant transaction number returned |
| data.amount |
Yes |
String |
Transaction amount |
| data.status |
Yes |
String |
Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table. |
| data.message |
Yes |
String |
Status description |
| data.successTime |
Yes |
String |
Transaction success time (local time) |
| endToEndId |
No |
String |
endToEndId |
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"
}
}