Payment Query API
Tips
- All requests are
Post
requests, and the data format isjson
Request URL
/v1/payproVN/queryPayInResult
Request Method
- POST
Header
Parameter | Required | Type | Description |
---|---|---|---|
merchantNo | No | string | Merchant number |
Request Body Parameters
Name | Required | Type | Description |
---|---|---|---|
tradeNo | Yes | string | Transaction number provided by the merchant during payin. |
timestamp | Yes | string | Timestamp of the request. |
sign | Yes | string | Encrypted signature. |
Request Example
{
"sign": "b94084c49e6292b3eff2b1defea69d55",
"timestamp": "1729156246442",
"tradeNo": "133323392"
}
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 | Actual payment 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": 1729156267022,
"success": true,
"data": {
"platFormTradeNo": "cch55ta98fee3huy",
"tradeNo": "133323392",
"amount": "50000.00",
"status": "00029",
"message": "Processing"
}
}