Skip to content

Payout Query

Request URL

methodurl
POST/api/pay/payout/query/v1

Header Information

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryCountry code (BR)
app_codeApplication ID

Request Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
signStringyesSignature
Request Example
{
"merchantOrderNo": "OrderNoExample",
"sign": "YOUR_SIGN"
}

Response Parameters

ParameterTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
amountStringyesPayout amount
statusIntyes1-Processing 2-Payout Success 3-Payout Failed 4-Refund
Response Example
{
"code": 200,
"msg": "success",
"data": {
"merchantOrderNo": "OrderNoExample",
"tradeNo": "TF201806251011",
"status": 1,
},
"success": true
}
Order Not Found Response Example
{
"code": 400,
"msg": "Order not found",
"success": false
}