Payment Notify API
Tips
- All requests are
Post
requests, and the data format isjson
Brief Description
This document describes the asynchronous notification to the merchant. When a transaction (payout, payin) has a result, the platform will POST the result to the URL reported by the merchant. The merchant must respond with OK after processing the result. If the platform's request fails, it will notify the merchant up to 8 times within 24 hours, following the schedule of 2s/5s/10s/30s/1h/3h/3h/3h. If the merchant still does not receive a successful response, they can actively query the result through the query interface.
If there are IP restrictions for the merchant's request acceptance, please inform us.
Request Method
- POST
Request Parameters
Parameter Name | Required | Type | Description |
---|---|---|---|
status | Yes | string | Request result. The merchant can use this for logical processing. "0000" indicates transaction success, "0001" indicates partial payment (the actual successful amount is based on the payment amount, applicable only in cases of partial success), "0015" indicates processing, and other codes are error codes that can be treated as failures. |
message | Yes | string | Error description |
platFormTradeNo | Yes | string | PayPro transaction number |
tradeNo | Yes | string | The transaction number provided by the merchant for response |
amount | Yes | float | Actual payment amount; there may be cases of partial payment |
successTime | No | string | Transaction success time (local time); returned upon successful transaction |
timestamp | Yes | string | Timestamp |
sign | Yes | string | Encrypted signature string |
Asynchronous Notification Example
{
"platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
"tradeNo": "00000020",
"amount": 30000,
"status": "0000",
"message": "SUCCESS",
"utr": "111111111111",
"successTime": "2024-07-01 18:34:31",
"timestamp": "1724740395968",
"sign": "12222222222"
}
Response Parameters
OK