Mandatory parameters - Bank transfers

Mandatory parameterDescriptionFlow type
login32 charsALL
pass32 charsALL
external_idMax. 100 charsALL
document_idSee document validations below.ALL
beneficiary_nameMax. 50 charsALL
beneficiary_lastnameMax. 50 charsALL
countryBRALL
bank_codeSee bank codes below.ALL
bank_branchSee bank branch validations below.ALL
bank_accountSee bank account validations below.​ALL
account_typeC: for Checking accounts
S: for Savings accounts
ALL
amountMax. 2 decimal numbersALL
document_typeCPF or CNPJC2C, B2C (only for PSPs)
addressBeneficiary address Max. 200 charsC2C
cityBeneficiary city Max. 100 charsC2C
remitter_documentRemitter document Max 45 charsC2C, B2C (only for PSPs)
remitter_full_nameMax. 200 charsC2C, B2C (only for PSPs)
remitter_birth_dateFormat: "YYYYMMDD"C2C, B2C (only for PSPs)
remitter_countryISO 3166- 1 alpha -2 codeC2C, B2C (only for PSPs)
purposePayouts purpose.
For P2P: EPREMT or EPDISP
C2C

Example request - Bank transfers

{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"document_id":"123.456.789-10",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"NASCIMENTO",
"country":"BR",
"bank_code":"341",
"bank_branch":"0167",
"bank_name":"Itau",
"bank_account":"12345-1",
"account_type":"C",
"comments":"this is the 1st comment",
"notification_url":"https://thisisawebsite.net",
"amount":"1100.00",
"currency":"BRL",
"type":"json"
}

Mandatory parameters - PIX transfer

Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
document_idSee document validations below.
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryBR
amountMax. 2 decimal numbers
account_typeWill depend on the pix Key you want to send.
Pix_email, Pix_phone, Pix_document_id, Pix_bank_account.
Key fieldIt will be mandatory the field that was indicated on the account type field as pix key.

email Max. 100 chars.
phone Country code plus 11 digits. Ex: +5512345678901
document_id See document validations below
bank account See bank account validations below

Example request - PIX transfer

{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"document_id":"123.456.789-10",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"NASCIMENTO",
"country":"BR",
"amount":"1100.00",
"currency":"BRL",
"account_type":"Pix_email",
"email":"[email protected]"
}

Document validations

ValidationNameLengthTypeVerification digitExample
DocumentCPF11numericlast two digits450.539.758-09
45053975809
DocumentCNPJ14numericlast two digits55.694.732/0001-10
55694732000110

Bank account validations

Reference

  • X --> Numeric character
  • D --> Alphanumeric character
Bank nameBank BranchCheckings AccountSavings Account
Banco do Brasil S.A.XXXX, XXXXD or XXXX-DXXXXXXXX or XXXXXXXX-XXXXXXXXXX or XXXXXXXXX-X
Prefixes: 51, 52, 61, 96 or 97
Banco Santander Brasil S.A.XXXXXXXXXXXX-X
Prefixes: 01, 02, 11, 13, 29 and 77
XXXXXXXX-X
Prefixes: 60
Caixa CEFXXXX, XXXXX or XXXX-XXXX.XXXXXXXX-X or any combination with or without . or - characters and prefix or verification code.
Prefixes: 001, 010, 003 or 023
XXXX.XXXXXXXX-X
Prefixes: 0000

XXX.XXXXXXXXX-X
Prefixe: 000

XXX.XXXXXXXX-X
Prefixes: 013, 022

All the combinations with or without . or - characters.
Banco Bradesco S.A.XXXX, XXXXX or XXXX-XXXXXXXX or XXXXXXX-XXXXXXXX or XXXXXXX-X
Itau Unibanco S.A.XXXXXXXXX-X or XXXXXXX-XXXXXX-X or XXXXXXX-X
HSBC Bank Brasil S.A.XXXX, XXXXD, XXXXDD, XXXX-D or XXXX-DDXXXXX-XXXXXXX-XX
Other banksXXXX, XXXXD, XXXXDD, XXXX-D or XXXX-DD--
Pix accountno format validationno format validation

Bank codes

These are the values the bank_code parameter can take in Brazil.

Bank NameBank Code
ACESSO SOLUCOES PAGAMENTO SA332
BANCO A.J. RENNER S.A.654
Banco ABC Brasil S.A.246
Banco ABN Amro S.A.075
Banco Agiplan S.A.121
Banco Alfa S.A.025
Banco AndBank (Brasil) S.A.065
Banco Arbi S.A.213
Banco B3 S.A.096
Banco Bandepe S.A.024
BANCO BARI DE INVESTIMENTOS E FINANCIAMENTOS S.A.330
Banco Bmg S.A.318
Banco BNP Paribas Brasil S.A.752
Banco Bocom BBM S.A.107
Banco Bonsucesso S.A.218
Banco Bradescard S.A.063
Banco Bradesco BBI S.A.036
Banco Bradesco BERJ S.A.122
Banco Bradesco Financiamentos S.A.394
Banco Bradesco S.A.237
Banco BTG Pactual S.A.208
Banco C6 S.A.336
Banco Caixa Geral - Brasil S.A.473
BANCO CAPITAL S.A.412
Banco Cargill S.A.040
BANCO CEDULA S.A.266
Banco Cetelem S.A.739
Banco Cifra S.A.233
Banco Citibank745
BANCO CLASSICO S.A.241
Banco Cooperativo do Brasil S.A. - BANCOOB756
Banco Cooperativo Sicredi S.A.748
BANCO CRÉDIT AGRICOLE BRASIL S.A.222
Banco Credit Suisse (Brasil) S.A.505
Banco Crefisa S.A.069
Banco da Amazonia S.A.003
Banco da China Brasil S.A.083
Banco Daycoval S.A.707
Banco de Brasilia S.A. - BRB070
Banco de la Nacion Argentina300
Banco Digio S.A.335
Banco do Brasil S.A.001
Banco do Estado de Sergipe S.A. - BANESE047
Banco do Estado do Para S.A. - BANPARA037
Banco do Estado do Rio Grande do Sul S.A. - BANRISUL041
Banco do Nordeste do Brasil S.A.004
Banco Fator S.A.265
Banco Fibra S.A.224
BANCO FICSA S.A.626
Banco Finaxis S.A.094
Banco Guanabara S.A.612
Banco Inbursa S.A.012
Banco Industrial do Brasil S.A.604
BANCO INDUSVAL S.A.653
Banco Inter077
Banco Investcred Unibanco S.A.249
Banco Itaú BBA S.A.184
Banco Itaú Consignado S.A.029
Banco ItauBank S.A.479
Banco J. Safra S.A.074
BANCO J.P. MORGAN S.A.376
Banco John Deere S.A.217
Banco KDB do Brasil S.A.076
BANCO KEB HANA DO BRASIL S.A.757
Banco Luso Brasileiro S.A.600
Banco Máxima S.A.243
Banco Mercantil do Brasil S.A.389
Banco Mizuho do Brasil S.A.370
Banco Modal S.A.746
BANCO MORGAN STANLEY S.A.066
Banco MUFG Brasil S.A.456
BANCO NACIONAL DE DESENVOLVIMENTO ECONOMICO E SOCIAL007
Banco Olé Bonsucesso Consignado S.A.169
Banco Original212
Banco Original do Agronegócio S.A.079
Banco Ourinvest S.A.712
Banco Panamericano S.A.623
Banco Paulista S.A.611
Banco Pine S.A.643
Banco Rabobank International Brasil S.A.747
Banco Rendimento S.A.633
BANCO RIBEIRAO PRETO S.A.741
BANCO RODOBENS S.A.120
Banco Safra S.A.422
Banco Santander Brasil S.A.033
Banco Semear S.A.743
Banco Sistema S.A.754
Banco Smartbank S.A.630
BANCO SOCIETE GENERALE BRASIL S.A.366
Banco Sofisa637
Banco Sumitomo Mitsui Brasileiro S.A.464
BANCO TOPÁZIO S.A.082
BANCO TRIANGULO S.A.634
Banco Tricury S.A.018
Banco Votorantim S.A. (Banco Neon)655
Banco VR S.A.610
Banco Western Union do Brasil S.A.119
Banco Woori Bank do Brasil S.A.124
Banco XP S.A.348
BancoSeguro S.A.081
Banestes S.A. Banco do Estado do Espirito Santo021
Bank of America Merrill Lynch Banco Múltiplo S.A.755
BCV - BANCO DE CRÉDITO E VAREJO S.A.250
BEXS BANCO DE CÂMBIO S/A144
Bexs Corretora de Câmbio S/A253
BNY Mellon Banco S.A.017
BPP Instituição de Pagamento S.A.301
BR Partners Banco de Investimento S.A.126
Caixa Economica Federal - CEF104
China Construction Bank (Brasil) Banco Múltiplo S/A320
Citibank N.A.477
Commerzbank Brasil S.A. - Banco Múltiplo163
Confederacao Nacional das Cooperativas Centrais Unicreds136
Cooperativa Central de Credito Urbano - CECRED085
CORA SCD S.A.403
CREDICOAMO CREDITO RURAL COOPERATIVA010
CREDIT SUISSE HEDGING-GRIFFO CORRETORA DE VALORES S.A011
DEUTSCHE BANK S.A. - BANCO ALEMAO487
GOLDMAN SACHS DO BRASIL BANCO MULTIPLO S.A.064
Haitong Banco de Investimento do Brasil S.A.078
Hipercard Banco Múltiplo S.A.062
HSBC BRASIL S.A. - BANCO DE INVESTIMENTO269
ICBC do Brasil Banco Múltiplo S.A.132
ING Bank N.V.492
Intesa Sanpaolo Brasil S.A. - Banco Múltiplo139
Itaú Unibanco Holding S.A.652
Itau Unibanco S.A.341
JPMorgan Chase Bank National Association488
Kirton Bank S.A. - Banco Multiplo399
Mercadopago.com Representacoes LTDA323
MONEYCORP BANCO DE CÂMBIO S.A.259
MS Bank S.A. Banco de Câmbio128
Novo Banco Continental S.A. - Banco Múltiplo753
Nu Pagamentos (Nubank)260
Omni Banco S.A.613
Pagseguro Internet S.A290
PARANÁ BANCO S.A.254
Plural S.A. Banco Múltiplo125
Scotiabank Brasil S.A. Banco Múltiplo751
STATE STREET BRASIL S.A. – BANCO COMERCIAL014
Stone Pagamentos S.A.197
Travelex Banco de Câmbio S.A.095
UBS Brasil Banco de Investimento S.A.129
UBS Brasil Corretora de Câmbio Títulos e Valores Mobiliários S.A.015
Unicred Norte do Parana084