🇧🇷Brazil
Check the requirements and validations made over the cashouts on Brazil
Required fields
Field
Format
Description
login
String
Cashouts login
pass
String
Cashouts pass
external_id
String (max length: 100)
Transaction's ID on your end
amount
Number with up to 2 decimals
Cashout amount
beneficiary_name
String (max length: 100)
Beneficiary's name
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: DDDDDDDDD, DDDDDDDDDD, DDDDDDDDD-D, DDDDDDDDD-D where D are digits. The number of digits may change, but will range from 9 to 10 digits.
^\d{7,10} (-)?[\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
Mercado Pago
323
Format: DDDDDDDDDD-D or DDDDDDDDDDD where D are digits. The number of digits may change, but can't exceed 11 digits
^\d{1,9}(-)?[\d]$
12345678910, 1234567891-0
Itaú
341
Format: DDDDDD-D or DDDDDDD where D are digits. The number of digits may change, but will range from 6 to 7
^\d{1,7} (-)?[\d]$
123456, 12345-6
Pix Key Document
10002
Empty string
^$
""
Pix Key Phone
10000
Empty string
^$
Pix Key Email
10001
Empty string
^$
Pix Key Random
10003
Empty string
^$
Others
-
Format: DDDDDDDDDD-D or DDDDDDDDDDD where D are digits. The number of digits may change, but can't exceed 11 digits
^\d{1,9}(-)?[\d]$
123456789, 123456789-0
Bank Branch Validations
Use the Regex below to validate the valid (and invalid) bank branches on your end.
Bank name
Bank code
Format
Regex
Exceptions
Example
Banco do Brasil
001
Format: DDDD-X or DDDDX where D are digits and X is a digit or the letter 'X'. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\dxX]$
Can't have 4 zeros and a digit.
^0{0,4}(-)?[\dxX]$
1234-1, 1234-X, 12341, 1234X
Santander
033
Format: DDDD where D are digits. The number of digits may change, but can't exceed 4 digits
^\d{1,4}$
Can't be 033
^033$
1234
Banrisul
041
Format: DDDD-X or DDDDX where D are digits and X is a digit or the letter 'X'. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\dxX]$
N/A
1234-1, 1234-X, 12341, 1234X
Banco Inter
077
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't start with zeros followed by 77
^0{0,3}77$
1234-1, 12341
Caixa
104
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't be: 001/013/023/104
^001$|^013$|^023$|^104$
1234-1, 12341
Banco Original
212
Format: DDDDD-D or DDDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't start with zeros followed by 212
^0{0,2}212$
1234-1, 12341
Bradesco
237
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't be 237
^237$
1234-1, 12341
Banco Nu Pagamento
260
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't start with zeros followed by 260
^0{0,2}260$
1234-1, 12341
PagSeguro
290
Format: DDD-D or DDDD where D are digits. The number of digits may change, but can't exceed 4 digits
^\d{3}(-)?[\d]$
Can't start with zeros followed by 290
^0{0,2}290$
123-4, 1234
Mercado Pago
323
N/A
N/A
N/A
0001
Itau
341
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't be 314
^341$
1234-1, 12341
Pix Key Phone
10000
Format: "+55 012 92345-1234"
^([+55]{3})([(]?[0]?[1-9]{2}[)]?)[9]?([1-9]{4})-?([0-9]{4})$
N/A
+55 66 666666666
Pix Key Email
10001
N/A
^$
N/A
testuser@gmail.com
Pix Key Document
10002
N/A
^$
N/A
N/A
Others
-
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
N/A
1234-1, 12341
Account Types
The account_type is specified with only one character described below.
account_type
Description
C
Checkings account
S
Savings account
O
Joint checkings
P
Joint savings account
Click here to check document types and validations.
Example Request
Types of Keys
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
Pix Key Random
10003
bank_branch must be empty. The field account_type can have any value. The field bank_account must be sent - this indicates the customer's PIX random key
If a payout is created without the mandatory fields, it will be rejected.
Registred bank accounts
For withdrawals, it is possible to send the registered accounts of a customer, before creating a cashout, you can find all the information about the fields here, under the registered_bank_accounts object. You can have up to 3 bank accounts registered under this object. Example
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
Credisis - Central de Cooperativas de Crédito Ltdav
097
XP INVESTIMENTOS S.A
102
CAIXA ECONOMICA FEDERAL - CEF
104
Banco BOCOM BBM S.A.
107
BANCO AGIPLAN S.A.
121
Confederação Nacional das Cooperativas Centrais Unicred
136
Stone Pagamentos S.A
197
Banco BTG Pactual S.A.
208
BANCO ORIGINAL
212
BANCO BONSUCESSO S.A.
218
Banco Fibra S.A.
224
BANCO BRADESCO S.A.
237
NU PAGAMENTOS
260
Will Financeira S.A.
280
PagSeguro Internet S.A
290
Banco BPP Instituição de Pagamento S/A
301
BANCO BMG S.A
318
China Construction Bank Banco Múltiplo S.A.
320
MERCADOPAGO.COM REPRESENTACOES LTDA.
323
BANCO BARI DE INVESTIMENTOS E FINANCIAMENTOS S.A
330
BAcesso Soluções de Pagamento S.A
332
Banco Digio S.A
335
BANCO C6 S.A
336
ITAU UNIBANCO S.A.
341
GERENCIANET S.A
364
Banco Société Générale Brasil S.A.
366
PICPAY SERVICOS S.A
380
BANCO MERCANTIL DO BRASIL S.A.
389
Banco Hub pagamentos SA
396
HSBC BANK BRASIL S.A. - BANCO MULTIPLO
399
CORA SCD S.A
403
BANCO SAFRA S.A.
422
CITIBANK N.A.
477
Deutsche Bank S.A. – Banco Alemão
487
JPMorgan Chase Bank, National Association
488
ING Bank N.V.
492
Banco Credit Suisse S.A.
505
Banco PAN S.A.
623
BANCO SOFISA
637
Banco Votorantim S.A.
655
BANCO DAYCOVAL S.A.
707
BANCO OURINVEST S.A
712
BANCO CITIBANK
745
BANCO MODAL S.A.
746
Banco Rabobank International Brasil S.A.
747
BANCO COOPERATIVO SICREDI S.A.
748
Banco BNP Paribas Brasil S.A.
752
BANCO COOPERATIVO DO BRASIL S/A - BANCOOB
756
Pix Key Document
10002
For the full and most up-to-date list of banks and its codes, please check the Cashout Bank Code endpoint.
Last updated