Skip to content

Create a payout order

Request URL

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

Header Information

Header ParameterParameter Description
timestampRequest timestamp
nonceRandom value
countryCountry code (MX)
app_codeApplication ID

Request Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
amountStringyes20Payout amount (in pesos)
bankCodeStringyes50Bank code
bankNameStringyes50Bank name
accountTypeIntyesAccount type 3-Debit card 40-CLABE
bankAccountStringyes50Recipient account number
realNameStringyes40Customer name
idCardNumberStringyes50Recipient ID number
callbackUrlStringno200Payout callback URL, if not provided, the merchant configuration will be used
signStringyesSignature
Request
{
"outTradeNo": "OrderNoExample",
"amount": "100",
"bankCode": "646",
"bankName": "STP",
"accountType": 3,
"bankAccount": "1234567890",
"realName": "John Doe",
"idCardNumber": "1234567890",
"callbackUrl": "https://merchant.com/api/payout/callback",
"sign": "YOUR_SIGN"
}

Return Parameters

ParameterTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
statusIntyes1-Pending 3-Failed (can be retried)
amountStringyesTransaction amount
Return
{
"merchantOrderNo": "OrderNoExample",
"tradeNo": "TF201806251011",
"status": 1,
"sign": "TEEMO_SIGN"
}