Latest
API Documentation
Deposits Tools
Specifications
Brazil
Check the requirements and validations made over the cashouts on Brazil
Required fields
Field
Format
Description
loginString
Cashouts login
passString
Cashouts pass
external_idString (max length: 100)
Transaction's ID on your end
amountNumber with up to 2 decimals
Cashout amount
beneficiary_nameString (max length: 100)
Beneficiary's name
phoneString (max length: 20)
Beneficiary's phone number. Only required for Pix Key Phone (10000)
emailString (max length: 100)
Beneficiary's email address. Only required for Pix Key Email (10001)
Bank Account Validations
Use the Regex below to validate the bank accounts on your end.
Bank name
Bank code
Format
Regex
Example
Banco do Brasil
001
Format: DDDDDDDDD-X or DDDDDDDDDX where D are digits and X is a digit or the letter 'X'. The number of digits may change, but can't exceed 10 digits
^\d{1,9}(-)?[\dxX]$1234567890, 123456789-0, 123456789-X, 123456789X
Santander
033
Format: DDDDDDDD, DDDDDDDDD, DDDDDDDD-D, DDDDDDDD-D where D are digits. The number of digits has to be 8 or 9
^\d{7,8}(-)?[\d]$12345678, 12345678-9
Banrisul
041
Format: DDDDDDDDD-D or DDDDDDDDDD where D are digits. The number of digits has to be 10
^\d{9}(-)?[\d]$1234567890, 123456789-0
Caixa
104
Format: DDDDDDDDD-D or DDDDDDDDDDDDDD-D where D are digits. The number of digits has to be between 1 and 15
^\d{1,14}(-)?[\d]$1234567890,
123456789-0, 12345678901234-5
Bradesco
237
Format: DDDDDDD-D or DDDDDDDD where D are digits. The number of digits may change, but can't exceed 8 digits
^\d{1,7}(-)?[\d]$12345678, 1234567-8
Itaú
341
Format: DDDDD-D or DDDDDD where D are digits. The number of digits may change, but can't exceed 6 digits
^\d{1,5}(-)?[\d]$123456, 12345-6
Pix Key Phone
10000
Empty string
^$""
Pix Key Email
10001
Empty string
^$""
Pix Key Document
10002
Empty string
^$""
Others
-
Format: DDDDDDDDD-D or DDDDDDDDDD where D are digits. The number of digits may change, but can't exceed 10 digits
^\d{1,9}(-)?[\d]$1234567890, 123456789-0
Bank Branch Validations
Use the Regex below to validate the valid (and invalid) bank branches on your end.
Bank name
Bank code
Regex
Exceptions
Banco do Brasil
001
^\d{1,4}(-)?[\dxX]$^0{0,4}(-)?[\dxX]$Santander
033
^\d{1,4}$^033$Banrisul
041
^\d{1,4}(-)?[\dxX]$N/A
Banco Inter
077
^\d{1,4}(-)?[\d]$^0{0,3}77$Caixa
104
^\d{1,4}(-)?[\d]$^001$|^013$|^023$|^104$Banco Original
212
^\d{1,4}(-)?[\d]$^0{0,2}212$Bradesco
237
^\d{1,4}(-)?[\d]$^237$Banco Nu Pagamento
260
^\d{1,4}(-)?[\d]$^0{0,2}260$PagSeguro
290
^\d{3}(-)?[\d]$^0{0,2}290$Itau
341
^\d{1,4}(-)?[\d]$^341$Pix Key Phone
10000
^$N/A
Pix Key Email
10001
^$N/A
Pix Key Document
10002
^$N/A
Others
-
^\d{1,4}(-)?[\d]$N/A
Account Types
The
account_type is specified with only one character described below.account_typeDescription
CCheckings account
SSavings account
OJoint checkings
PJoint savings account
Document Validations
Phone validations
Bank name
Bank code
Format
Required
Example
Others
-
-
No
-
Email validations
Bank name
Bank code
Format
Required
Example
Others
-
-
No
-
Example Request
Banks
Pix Keys
1
{
2
"login": "xxxxxxx",
3
"pass": "xxxxxxx",
4
"external_id": "30000000001",
5
"country": "BR",
6
"currency": "BRL",
7
"amount": 100,
8
"document_id": "01716001340",
9
"beneficiary_name": "User",
10
"bank_account": "3423422-7",
11
"bank_code": "001",
12
"bank_branch": "1234",
13
"account_type": "C",
14
"notification_url": "https://webhook.site/url",
15
"type": "json"
16
}
Copied!
Type of keys
Bank
Bank Code
Details
Pix Key Phone
10000
bank_account and bank_branch must be empty. The field acount_type can have any value. The field phone must be sent Pix Key Email
10001
bank_account and bank_branch must be empty. The field acount_type can have any value. The field email must be sent Pix Key Document
10002
bank_account and bank_branch must be empty. The field acount_type can have any value. The field document_id must be sent If a payout to any of the 3 banks above is created without phone, email or document_id respectively, it will get REJECTED.
Example Requests
Pix Key Phone
1
{
2
"login": "xxxxxxx",
3
"pass": "xxxxxxx",
4
"external_id": "30000000001",
5
"country": "BR",
6
"currency": "BRL",
7
"amount": 100,
8
"document_id": "01716001340",
9
"beneficiary_name": "User",
10
"bank_code": "10000",
11
"phone": "+5491234567890",
12
"bank_account": "",
13
"bank_branch": "",
14
"account_type": "C",
15
"notification_url": "https://webhook.site/url",
16
"type": "json"
17
}
Copied!
Pix Key Email
1
{
2
"login": "xxxxxxx",
3
"pass": "xxxxxxx",
4
"external_id": "30000000001",
5
"country": "BR",
6
"currency": "BRL",
7
"amount": 100,
8
"document_id": "01716001340",
9
"beneficiary_name": "User",
10
"bank_code": "10001",
11
"email": "[email protected]",
12
"bank_account": "",
13
"bank_branch": "",
14
"account_type": "C",
15
"notification_url": "https://webhook.site/url",
16
"type": "json"
17
}
Copied!
Pix Key Document
1
{
2
"login": "xxxxxxx",
3
"pass": "xxxxxxx",
4
"external_id": "30000000001",
5
"country": "BR",
6
"currency": "BRL",
7
"amount": 100,
8
"document_id": "01716001340",
9
"beneficiary_name": "User",
10
"bank_code": "10002",
11
"bank_account": "",
12
"bank_branch": "",
13
"account_type": "C",
14
"notification_url": "https://webhook.site/url",
15
"type": "json"
16
}
Copied!
Bank Codes
Bank
Code
BANCO DO BRASIL S.A.
001
BANCO DA AMAZONIA S.A.
003
BANCO DO NORDESTE DO BRASIL S.A.
004
BANESTES S.A. BANCO DO ESTADO DO ESPIRITO SANTO
021
Banco Alfa S.A.
025
BANCO SANTANDER BRASIL S.A.
033
BANCO ABN AMRO S.A
033
BANCO DO ESTADO DO PARA S.A. - BANPARA
037
BANCO DO ESTADO DO RIO GRANDE DO SUL S.A. - BANRISUL
041
BANCO DO ESTADO DE SERGIPE S.A. - BANESE
047
BANCO DE BRASILIA S.A. - BRB
070
BANCO INTER
077
Banco Original do Agronegócio S.A.
079
Cooperativa Central de Crédito (VIACREDI)
085
POLOCRED SCMEPP
093
CAIXA ECONOMICA FEDERAL - CEF
104
Banco BOCOM BBM S.A.
107
BANCO AGIPLAN S.A.
121
Confederação Nacional das Cooperativas Centrais Unicred
136
For the full and most up-to-date list of banks and its codes, please check the Cashout Bank Code endpoint.
Last modified 1mo ago