Skip to content

Create Payout

Request URL

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

Header Information

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryCountry code (e.g., BR)
app_codeApplication ID

Request Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringYes32Merchant order number
amountStringYes20Payout amount (in Brazilian Real), up to 2 decimal places
bankCodeStringno50Bank code
bankNameStringNo50Bank name
accountTypeIntYesCPF-401
CNPJ-402
PHONE-403
EMAIL-404
EVP-405
Choose one of these parameters based on actual situation
bankAccountStringYes255Payout bank account
realNameStringYes255Userโ€™s real name
idCardNumberStringYes50Payerโ€™s ID card number
idTypeStringYes32CPF (11 digits), CNPJ (14 digits)
callbackUrlStringNo200Payout callback URL, if not provided, the merchant configuration will be used
signStringYesSignature
{
"merchantOrderNo": "ds111ad111022911111111111131",
"realName": "Carlos",
"bankCode": "1",
"bankName": "BANK",
"accountType": 101,
"bankAccount": "1234567890123456",
"amount": "100000",
"callbackUrl": "http://127.0.0.1:8075/sys/dictionary/test",
"sign": "YOUR SIGN",
"idType": "DNI",
"phone": "13175025118",
"idCardNumber": "12345678"
}