Skip to content

Payout Query

Request URl

MethodURL
POST/api/pay/payout/query/v1

Headers

Header ParameterDescription
timestampRequest timestamp
nonceRandom string
countryBP
app_codeApplication code

Request Parameters

FieldTypeRequiredMax LengthDescription
merchantOrderNoStringyes32Merchant order number
signStringyesSignature
Sample
{
"merchantOrderNo": "OrderNoExample",
"sign": "YOUR_SIGN"
}

Response Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
amountStringyesPayout amount
statusIntyesPayout status: 2 = Success, 3 = Failed, 4 = Refunded
Sample
{
"code": 200,
"data": {
"amount": "1000.00",
"merchantOrderNo": "OrderNoExample",
"status": 1,
"tradeNo": "TF2501010001MX0000000000000000"
},
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298"
}
Sample
{
"code": 400,
"msg":"Order not found",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298"
}