Skip to content

Payout Callback

Callback URL

methodurl
POSTMerchant provided callback URL

Header Information

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryBR
appCodeApplication ID

Callback Parameters

ParameterTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
amountStringyesTransaction amount
serviceAmountStringyesService fee e.g.: 18.02
statusIntyesPayment status: 2: Success 3: Failure 4: Refunded 5: Partially refunded
refundNoIntyesThe refund order number for this time is โ€œT00X-โ€, where X represents the number of refunds. For example, the first refund would be 1. T001-TF2501010001
refundAmountIntyesThe amount of the current refund
refundStatusIntyesThe current refund status: 0 (partial refund) 1 (full refund)๏ผ‰
refundTimeIntyesThe time for this refund
completeTimeStringyesCompletion time: In the current countryโ€™s time zone, in the format of yyyy-MM-dd HH:mm:ss
errorCodenumberyesOrder failure status error code
errorMessageStringyesOrder failure error message: 1000-Card error or limit 1001-Refunded 1002-Channel fluctuation 9999-Others
signStringyesSignature
Callback Example
{
"merchantOrderNo": "OrderNoExample",
"tradeNo": "TF201806251011",
"status": 2,
"amount": "1000",
"serviceAmount": "60",
"sign": "TEEMO_SIGN"
}
Callback Example
{
"amount": "300",
"merchantOrderNo": "OrderNoExample",
"tradeNo": "TF2501010001BR0000000000000000",
"completeTime": "2026-04-20 04:17:29",
"status": 5,
"serviceAmount": "0",
"refundStatus": 2,
"refundNo": "T002-TF2405220001BR0000527108668641",
"refundAmount": "200",
"refundTime": "2026-04-20 04:17:29",
"errorMessage": null,
"errorCode": null,
"sign": ""
}

Error Code Description:

errorCodeerrorMessageSuggestion
1000The account does not exist or is restrictedSuggest user to change card
1001ReturnRefunded, suggest to retry payout within 24 hours after receiving callback
1002Channel server fluctuationsChannel fluctuation, suggest retry after 10 minutes
9999OthersOther issues, suggest canceling the order

Callback Response

ParameterTypeRequiredLengthDescription
SUCCESSStringyesMust return โ€œSUCCESSโ€ otherwise callback will be repeated
Response Example
SUCCESS