Skip to content

Payout callback

Request headers

Callback request headers.

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
tradeNoStringYes32Platform order number
payoutAmountStringYes-Payout amount, an integer or up to two decimal places
payoutTypeStringYes24Payout method
payoutStatusStringYes20Order status
failMsgStringNo200Order failure reason
serviceAmountStringNo-Service fee
completeTimeStringYes-Completion time (local time, format yyyy-MM-dd HH:mm:ss)
refundNoStringNo32Refund number; returned only for Brazilian payout refund notifications
refundAmountStringNo-Refund amount; returned only for Brazilian payout refund notifications
refundTimeStringNo-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

FieldTypeRequiredExampleDescription
resultStringYesSUCCESSReturn SUCCESS to acknowledge successful receipt; any other value is treated as a failure
msgStringNoOKProcessing result description

Response example

{
"result": "SUCCESS",
"msg": "OK"
}
Only Brazilian payout callbacks include refund fields. Other countries do not return refundNo, refundAmount or refundTime.