Skip to content

Payout Query

Request URL

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

Headers

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryPK
app_codeApplication ID

Request Parameters

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

Response Parameters

FieldTypeRequiredMax LengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
amountStringyesPayout amount
statusIntyesPayout status: 2 - Success, 3 - Failed
serviceAmountStringyesService fee = fixed fee + (transaction amount * service rate) (Added 20250506)
immServiceStringyesFixed fee amount (Added 20250506)
serviceRateStringyesService rate (Added 20250506)
errorCodenumberyesError code for failed order (Added 20250506)
errorMessageStringyesError message for failed order (Added 20250506)
completeTimeStringyesCompletion time in local time zone, format: yyyy-MM-dd HH:mm:ss (Added 20250506)
query
{
"code": 200,
"data": {
"merchantOrderNo": "OrderNoExample",
"tradeNo": "TF2501010001PK0000000000000000",
"amount": "1000.00",
"status": 2,
"serviceAmount": "15.00",
"immService": "5.00",
"serviceRate": "0.010",
"errorCode": null,
"errorMessage": null,
"completeTime": "2025-05-01 00:00:00"
},
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298"
}
query
{
"code": 400,
"msg":"Order not found",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298"
}