Payout callback
Request headers
Request parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
merchantOrderNo | String | Yes | 32 | Merchant order number |
tradeNo | String | Yes | 32 | Platform order number |
payoutAmount | String | Yes | - | Payout amount, an integer or up to two decimal places |
payoutType | String | Yes | 24 | Payout method |
payoutStatus | String | Yes | 20 | Order status |
failMsg | String | No | 200 | Order failure reason |
serviceAmount | String | No | - | Service fee |
completeTime | String | Yes | - | Completion time (local time, format yyyy-MM-dd HH:mm:ss) |
refundNo | String | No | 32 | Refund number; returned only for Brazilian payout refund notifications |
refundAmount | String | No | - | Refund amount; returned only for Brazilian payout refund notifications |
refundTime | String | No | - | Refund time; returned only for Brazilian payout refund notifications, format yyyy-MM-dd HH:mm:ss |
Request example
{ "merchantOrderNo": "PAYOUT202609170001", "tradeNo": "VF2405220001BR0000508467743993", "payoutAmount": "100.00", "payoutType": "CPF", "payoutStatus": "REFUND", "serviceAmount": "1.00", "completeTime": "2026-09-17 15:30:00", "refundNo": "REFUND202609170001", "refundAmount": "100.00", "refundTime": "2026-09-17 16:00:00"}Response parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
result | String | Yes | SUCCESS | Return SUCCESS to acknowledge successful receipt; any other value is treated as a failure |
msg | String | No | OK | Processing result description |
Response example
{ "result": "SUCCESS", "msg": "OK"}Only Brazilian payout callbacks include refund fields. Other countries do not return
refundNo, refundAmount or refundTime.