Create payout
POST
/trade/payout/createRequest headers
Payment method values
payoutType |
|---|
CPF |
CNPJ |
PHONE |
EMAIL |
EVP |
Request parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
merchantOrderNo | String | Yes | 32 | Merchant order number |
transactionAmount | String | Yes | 20 | Payout amount, an integer or up to two decimal places |
payoutType | String | Yes | 20 | Payout method |
idType | String | Yes | 50 | ID type: individual uses CPF, business uses CNPJ |
userIdCard | String | Yes | 50 | ID number. CPF contains 11 digits and CNPJ contains 14 digits; use digits only. |
userName | String | Yes | 64 | User name |
userPhone | String | No | 11 | User mobile number, 11 digits (2 digit area code + 9 digit subscriber number) |
userEmail | String | No | 50 | User email |
bankCode | String | No | 20 | Bank codes |
bankName | String | No | - | Bank name |
bankAccountNo | String | Yes | 50 | Beneficiary account |
description | String | No | 100 | Description |
payoutCallbackUrl | String | No | 200 | Payout callback URL |
Request example
{ "merchantOrderNo": "PAYOUT202609170001", "transactionAmount": "100.00", "payoutType": "CPF", "idType": "CPF", "userIdCard": "12345678901", "userName": "TEST USER", "userPhone": "11987654321", "bankName": "Banco do Brasil", "bankAccountNo": "12345678901"}Response parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
code | int | Yes | - | Status code; a value other than 200 indicates an error |
data | Object | Yes | - | Response body |
data.merchantOrderNo | String | Yes | 32 | Merchant order number |
data.tradeNo | String | Yes | 32 | Platform order number |
data.transactionAmount | String | Yes | - | Payout amount |
data.status | String | Yes | 24 | Order status |
data.payoutType | String | Yes | 24 | Payout method |
msg | String | No | - | Error message |
tid | String | Yes | - | Trace ID |
Response example
{ "code": 200, "data": { "merchantOrderNo": "PAYOUT202609170001", "tradeNo": "VF2405220001BR0000508467743993", "transactionAmount": "100.00", "status": "PAYING", "payoutType": "CPF" }, "msg": "success", "tid": "747bbf80261844ed85b809212aab0d81"}