Account Type
In this section, we define the specifications for the account type field used in the payout API, focusing on payouts for bank transfer method. Each account type is identified by a specific code, which must be used to indicate the type of bank account. The table below outlines the supported account types and their corresponding codes for each country:
| Account Type | Description | Country |
|---|---|---|
| CRN | checking account | BR and CO |
| PAC | payment account | BR |
| SVN | saving account | BR and CO |
Bank Transfer in Brazil
For bank transfer method in Brazil, three key parameters must be provided: bank code, account branch, and account number.
- Bank Code (ISPB): The bank code parameter refers to the ISPB (Identificador de Sistema de Pagamentos Brasileiro), a unique identifier used by financial institutions within the Brazilian payment system. Similar to a routing number or SWIFT code used internationally, the ISPB ensures that transactions are routed to the correct institution.
In Brazil, the COMPE (Centralizadora da Compensação de Cheques e Outros Papéis) system is also widely used for bank identification, particularly in interbank transfers such as TED and DOC. However, for our system, the bank code corresponds to the ISPB, not COMPE. The relationship between ISPB and COMPE can be managed by converting codes between the two systems using the following dataset:<https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str>.
This dataset also provides access to all ISPBs of financial institutions in Brazil, helping to ensure you are using the correct code. - Account Branch: Identifies the specific bank branch. Some banks require just digits, while others include a check digit for verification.
- Account Number: This is the number associated with the customer’s account. While most banks follow a general regex pattern for account numbers, some institutions have specific regex formats that differ from the standard. Our table includes information about the general account number format, as well as the specific regex patterns for cases where institutions deviate from the general format.
The general account number regex format in Brazil is: ^(?:\d{6,14}|(?=\d+-\d+$)[\d-]{6,14})$.
Specific institutions may have variations from this general pattern, and those are detailed in the table below.
Together, these parameters ensure the payout reaches the correct institution, branch, and account. Below is a table of banks, ISPB codes, and required formats.
This table contains specific data necessary to ensure that transactions are correctly directed to the appropriate financial institutions. By consulting this table, you can ensure that the ISPB codes, agency formats, and account numbers are accurate. It is essential to follow the specified formats and regular expressions (regex) to avoid transaction errors.
| Bank Name | ISPB Code | Account Branch Format | Account Branch Regex | Account Number Format | Account Number Regex |
|---|---|---|---|---|---|
| Itaú Unibanco | 60701190 | 4 digits | - | 5 digits + 1 check digit | ^[0-9]{5}-[0-9]{1}$ |
| Bradesco | 60746948 | 4 digits + 1 check digit | ^[0-9]{4}-[0-9]{1}$/ | 7 digits + 1 check digit | ^[0-9]{7}-[0-9]{1}$ |
| Banco do Brasil | 00000000 | 4 digits + 1 check digit | ^[0-9]{4}-[0-9]{1}$ | 8 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ |
| Caixa Econômica Federal | 00360305 | 4 digits | - | 8 digits + 1 check digit or 9 digits + 1 check digit or 12 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ or ^[0-9]{9}-[0-9]{1}$ or ^[0-9]{12}-[0-9]{1}$ |
| Santander | 90400888 | 4 digits | - | 8 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ |
| Sicoob | 02038232 | 4 digits | - | 10 digits + 1 check digit | ^[0-9]{10}-[0-9]{1}$ |
| BTG Pactual | 30306294 | 3 digits | - | 6 digits + 1 check digit | ^[0-9]{6}-[0-9]{1}$ |
| Banco Safra | 58160789 | 4 digits | - | 7 digits + 1 check digit | ^[0-9]{7}-[0-9]{1}$ |
| Banco Votorantim (BV) | 59588111 | 3 digits | - | 8 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ |
| Banrisul | 92702067 | 4 digits + 1 check digit | ^[0-9]{4}-[0-9]{1}$ | 9 digits + 1 check digit | ^[0-9]{9}-[0-9]{1}$ |
| Citibank | 33042953 | 4 digits | - | 7 digits + 1 check digit | ^[0-9]{7}-[0-9]{1}$ |
| Banco do Nordeste | 7237373 | 4 digits | - | 7 digits + 1 check digit | ^[0-9]{7}-[0-9]{1}$ |
| Banco Original | 92894922 | 4 digits | - | 9 digits + 1 check digit | ^[0-9]{9}-[0-9]{1}$ |
| Pagbank (PagSeguro) | 08561701 | 4 digits | - | 8 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ |
| Nubank | 30680829 | 4 digits | - | 8 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ |
| Mercado Pago | 10573521 | 4 digits | - | 9 digits + 1 check digit | ^[0-9]{9}-[0-9]{1}$ |
| AME Digital | 32778350 | 4 digits | - | 9 digits + 1 check digit | ^[0-9]{9}-[0-9]{1}$ |
| C6 Bank | 31872495 | 4 digits | - | 8 digits + 1 check digit | ^[0-9]{8}-[0-9]{1}$ |
| Banco Inter | 00416968 | 4 digits | - | 9 digits + 1 check digit | ^[0-9]{9}-[0-9]{1}$ |
Optionally, you can separate the account numbers and the check digit with the character ' - '.
Bank Transfer in Colombia
For the account number parameter, the account number format varies by bank. Below are the specific formats required for different banks, along with a general format that applies when no specific rule is stated.
General format: ^[0-9]{6,20}$
Nequi (507) & Daviplata (551): ^3[0-9]{9}$
Davivienda (051): ^[0-9]{6,12}$
Bancolombia (007) & Caja Social (032): ^[0-9]{6,11}$
Bogotá (001): ^[0-9]{6,9}$
For the bank code parameter, the format is a 3-digit code, defined as ^[0-9]{3}$.
The table below lists the banks operating in Colombia and their corresponding bank parameters.
| Bank Name | Bank Code | Account Number Format | Account Number Regex |
|---|---|---|---|
| Banco de Bogotá | 001 | 6 to 9 digits | ^[0-9]{6,9}$ |
| Banco Popular | 002 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Itaú | 006 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Bancolombia | 007 | 6 to 11 digits | ^[0-9]{6,11}$ |
| Citibank | 009 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco GNB Sudameris | 012 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| BBVA Colombia | 013 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Scotiabank Colpatria S.A. | 019 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco de Occidente | 023 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Bancoldex S.A. | 031 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Caja Social BCSC S.A. | 032 | 6 to 11 digits | ^[0-9]{6,20}$ |
| Banco Agrario | 040 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| JPMorgan | 041 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| BNP Paribas Colombia | 042 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Mundo Mujer | 047 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Davivienda S.A. | 051 | 6 to 12 digits | ^[0-9]{6,12}$ |
| Banco AV Villas | 052 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco W S.A. | 053 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Procredit Colombia | 058 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Bancamía S.A. | 059 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Pichincha | 060 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Bancoomeva | 061 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Falabella S.A. | 062 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Finandina S.A. | 063 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Multibank S.A. | 064 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Santander de Negocios | 065 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Cooperativo Coopcentral | 066 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Compartir S.A. | 067 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco Serfinanza S.A. | 069 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Lulo Bank | 070 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Banco JP Morgan Colombia | 071 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| Nequi | 507 | 10 digits (starting with 3) | ^3[0-9]{9}$ |
| Daviplata | 551 | 10 digits (starting with 3) | ^3[0-9]{9}$ |
| Movii | 801 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |
| NU | 809 | 6 to 20 digits (General) | ^[0-9]{6,20}$ |