Payment Query API

Tips

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

Brief Description

None

Request URL

/v1/paypro/queryPayInResult

Request Method

POST

Header	Required	Type	Description
merchantNo	No	string	None

Request Body Parameters

Name	Required	Type	Description
tradeNo	Yes	string	The transaction number provided by the merchant during collection
timestamp	Yes	string	Timestamp
sign	Yes	string	Encrypted signature

Request Example

{
  "sign": "ac13b9abf95c66ffc4025abaaeeb3a83",
  "timestamp": "1728613488294",
  "tradeNo": "test_00000008"
}

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.tradeNo	Yes	string	Transaction number returned by the merchant
data.platFormTradeNo	Yes	string	PayPro transaction number
data.status	Yes	string	Request result. The merchant can use this for logical processing. "0000" indicates transaction success, "0001" indicates partial transaction success based on the actual payment amount, "0015" indicates processing, and other codes are error codes that can be treated as failures.
data.amount	Yes	string	Actual payment amount; there may be cases of partial payment
data.receivedAmount	Yes	string	Actual received amount
data.message	Yes	string	Error description

Successful Response Example:

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728613513280,
    "success": true,
    "data": {
        "tradeNo": "test_00000008",
        "payproTradeNo": "68o0uwogz7mnzutt",
        "status": "00029",
        "amount": "300",
        "receivedAmount": "230",
        "createTime": "2024-10-11 9:30:13",
        "successTime": "2024-10-11 10:30:13",
        "message": "Collection order timed out without payment"
    }
}