Payment Notify API
Tips
- All requests are
Postrequests, 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
- Content-Type:
application/json
Request Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| status | Yes | string | Transaction status: 0000 success, 0015 processing, or 00029 failed. |
| message | Yes | string | Status or error description |
| platFormTradeNo | Yes | string | PayPro transaction number |
| tradeNo | Yes | string | Merchant transaction number |
| amount | Yes | Decimal | Transaction amount in COP |
| successTime | Conditional | string | Transaction success time, formatted as yyyy-MM-dd HH:mm:ss; returned after a successful transaction |
| timestamp | Yes | Long | 13-digit Unix timestamp in milliseconds |
| sign | Yes | string | Notification signature; verify it using the signature logic in the Overview |
Asynchronous Notification Example
{
"platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
"tradeNo": "00000020",
"amount": 30000,
"status": "0000",
"message": "SUCCESS",
"successTime": "2024-07-01 18:34:31",
"timestamp": 1724740395968,
"sign": "12222222222"
}
Response Parameters
After processing the notification, return HTTP 200 with the following exact plain-text response:
OK
