Check Disbursement Status
Tip
- All requests use
POST
- Content type is
application/json
Brief Description
Use this API to query the latest status of a Vietnam payout order by merchant transaction number.
Request URL
/v1/vexora/queryPayOutResult
Request Method
- Method: POST
- Content-Type: application/json
| Name |
Required |
Type |
Desc |
| merchantNo |
Yes |
String |
Merchant number |
Request Body Parameters
| Name |
Required |
Type |
Desc |
| tradeNo |
Yes |
String |
Merchant order number |
| timestamp |
Yes |
String |
Timestamp |
| sign |
Yes |
String |
Signature generated according to the signing rules |
Request Example
{
"sign": "ee5c512fe36fed2afe2d36ab248e0eb8",
"timestamp": "1728613320708",
"tradeNo": "test_00000002"
}
Response Parameters
| Parameter name |
Required |
Type |
Description |
| msg |
yes |
String |
Request result. A successful request does not mean the transaction itself succeeded. |
| code |
yes |
String |
API response code. Refer to the response code section for business interpretation. |
| timestamp |
yes |
String |
Response timestamp |
| success |
yes |
String |
Request execution result |
| data |
yes |
Object |
Response object |
| data.tradeNo |
yes |
String |
Merchant transaction number |
| data.platFormTradeNo |
yes |
String |
Vexora transaction number |
| data.amount |
yes |
String |
Payout amount |
| data.status |
yes |
String |
Transaction results. Merchants should determine the final order state based on the returned status value. |
| data.message |
yes |
String |
Error description |
| data.successTime |
no |
String |
Transaction success time in local time when available |
Successful Response Example
{
"msg": "success",
"code": "0000",
"timestamp": 1728613339884,
"success": true,
"data": {
"platFormTradeNo": "63mz9aepqczdw280",
"tradeNo": "test_00000002",
"amount": "300.00",
"status": "0015",
"message": "In processing",
"successTime": "2024-10-11 10:30:13"
}
}