Skip to content

Create a payout order

Request Url

methodurl
POST/api/pay/payout/create/v1

Headers

Header ParameterDescription
timestampRequest timestamp
nonceRandom string
countryBP
app_codeApplication ID

Request Parameters

FieldTypeRequiredMax LengthDescription
merchantOrderNoStringyes32Merchant order number
amountStringyes20Payout amount
chainStringyes50Chain name: e.g., trc20, erc20
addressStringyesReceiving address
callbackUrlStringno200Callback URL; if omitted, merchant config is used
signStringyesSignature
Sample
{
"merchantOrderNo": "OrderNoExample",
"amount": "10.00",
"chain": "trc20",
"address": "123456789987654321",
"callbackUrl": "https://www.callbackexample.com",
"sign": "YOUR_SIGN"
}

Response Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
statusIntyesPayout status: 1 = Processing, 3 = Failed (can retry)
amountStringyesTransaction amount
Sample
{
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298",
"code": 200,
"data": {
"amount": "1000.00",
"merchantOrderNo": "OrderNoExample",
"status": 1,
"tradeNo": "TF2501010001MX0000000000000000"
}
}