We provide our clients with functionalities that allow the traceability and governance of amounts transferred in their checking account.

Obtain the account balance

In this functionality, updated positions of available and blocked amounts in the client's checking account are returned.

We request the fields:

Field	Description	Format	Mandatory
dataReferencia	Reference date to search for balance	date-time	Yes

Response:

Field	Description	Format	Nullable
Valor	Balance amount available for use in the checking account	number	No
valorBloqueado	Blocked balance amount that will not be available for use	number	No

Obter o saldo da conta

Obtain the account statement

Through this feature, we provide detailed information on financial transactions in an account, such as accounting date, amount, description, type of transaction (C - credit, D - debit), protocol, history code and description, among others.

Account statement

In order to deliver a better experience, it will be possible to consult transactions online in analytical and/or summarized form, which will facilitate financial reconciliation.

Analytical - Detailed information on transactions and amounts;
Summarized - Grouping of information on transactions and amounts.

Analytical statement

We request the following fields:

Field	Description	Format	Mandatory
Start date	Start date of the statement period, including the time	date-time	Yes
End date	End date of the statement period, including the time	date-time	Yes
Nature of the Operation	Type of transaction, which can be either Credit or Debit	string	No
Transaction history	Enter one or more histories according to the transaction history’s code table	array	No
Sorting	Ascending or descending	string	No

Response:

Field	Description	Format	Nullable
Transactions	We provide the accounting date/time of the transaction (in GMT-3), nature of the entry (C – credit / D - debit), history code and description, amount, protocol, counterpart details, additional data	array	Sim

Obtém o extrato analítico

Summarized statement

We request the following fields:

Field	Description	Format	Mandatory
Start date	Start date of the statement period, including the time	date-time	Sim
End date	End date of the statement period, including the time	date-time	Sim
Nature of the Operation	Type of transaction, which can be either Credit or Debit	string	Não
Transaction history	Receive one or more histories	array	Não
Sorting	Ascending or descending	string	Não

Response:

Field	Description	Format	Nullable
Transactions	We provide the accounting date/time of the transaction (in GMT-3), nature of the entry (C – credit / D - debit), history code and description, amount, protocol, counterpart details, additional data	array	Sim

Obtém o extrato sintético

Transaction history codes

A few categories are listed below, with history codes, their descriptions and nature.

Deposit

Code	Description	Nature
938	DEPÓSITO ATRAVÉS DE BOLETO / DEPÓSITO ATRAVÉS DE BOLETO	D

Investments

Code	Description	Nature
352	APLICAÇÃO FINANCEIRA / APLICAÇÃO	D
1573	REMUNERAÇÃO APLICAÇÃO AUTOMÁTICA / REMUNERAÇÃO APLICAÇÃO AUT	C

Credit operations

Code	Description	Nature
320	DÉBITO PARCELA EMPREST. / DÉBITO PARCELA EMPRÉSTIMO	D
19	LÍQ.OPER. EMPRÉSTIMO / LÍQUIDO OPERAÇÃO EMPRÉST	C
1007	CRÉDITO LIQUIDAÇÃO CENTRALIZADA-EMISSOR / CR.LIQ.CENTR.- EMISSOR	C

Payments

Code	Description	Nature
380	PAGAMENTO OPER. EMPRÉSTIMO/ PAGAMENTO OPER EMPRÉSTIMO	D
383	PAGAMENTOS DE TRIBUTOS-CL / PAGAMENTO TRIBUTOS	D
782	PGTO COBRANÇA INTERN.BANK. / PAGAMENTO BOLETO	D
784	PGTO CONCES.PUB.INT.BANK. / PGTO CONCESS/TRIBUTO	D
916	DEB.SERV.DE PAGTO TED / DEB SERV DE TRANSF EM LOT	D
1026	COMPRA À VISTA MASTERCARD NAC / COMPRA À VISTA MASTER NAC	D
17	LÍQUIDO DE COBRANÇA – PGTO/DEPÓSITO BOLETOS	C
20	LÍQUIDO COBRANÇA VINCULADA / LÍQUIDO COBRANÇA VINCULAD	C
204	RECEB.CARTÃO CRÉDITO / RECEBIMENT CARTÃO CRÉDITO	C
208	RECEB.CARTÃO ANTECIPAÇÃO / RECEB.CARTÃO ANTECIPAÇÃO	C

Pix transfers

Code	Description	Nature
1501	Débito Pix / PIX ENVIADO	D
1505	Débito Devolução Pix / DEVOLUÇÃO ENVIADA PIX	D
1507	Débito PIX Transf. Interna / PIX INTERNO ENVIADO	D
1090	CRÉDITO PIX MANUAL / PIX RECEBIDO MANUAL	C
1091	CRÉDITO PIX CHAVE / PIX RECEBIDO CHAVE	C
1504	Crédito Devolução Pix / DEVOLUÇÃO RECEBIDA PIX	C
1506	Crédito Pix Transf. Interna / PIX INTERNO RECEBIDO	C
1526	Crédito Pix QR Code/ Crédito Pix QR Code	C

Withdrawals

Code	Description	Nature
924	SAQUE CARTAO DÉBITO NAC / SAQUE BANCO 24H	D
1052	SAQUE DIGITAL / SAQUE BANCO 24H	D

Bank charges

Code	Description	Nature
340	TARIFA ENTRADA TÍTULO / TARIFA ENTRADA TÍTULO	D
361	TARIFA MANUT MENSAL C/C / TARIFA MANUT MENSAL CONTA	D
555	TARIFA TED BS2.EMP / TARIFA TED BS2.EMP	D
561	TARIFA.ENTRADA.TIT.BS2.EMP / TAR.ENTRADA.TIT.BS2.EMP	D
563	TAR.BAIXA.TIT.FINAN.BS2.EMP / TAR.BAIXA.TIT.FINAN.BS2.EMP	D
565	TAR.BAIX.TIT.S/.FINAN.BS2.EMP / TAR.BAX.TIT.S/FIN.BS2.EMP	D
653	TARIFA OPERAÇÃO / TARIFA DE OPERAÇÃO	D
1056	TARIFA OPERAÇÕES PIX / TARIFA OPERAÇÕES PIX	D
1120	TARIFA T.A.C. / TARIFA T.A.C.	D
1216	TARIFA COBRANÇA ARQUIVO CNAB / TAR. COBRAN. ARQ. CNAB	D
1222	TARIFA CRÉDITO PIX / TARIFA CRÉDITO PIX	D
1524	TARIFAS PIX REMESSA / TAR TRANSF EM LOTE	D
1530	TARIFA DE MEDIÇÃO DE OBRA / TARIFA DE MEDIÇÃO DE OBRA	D

Transfers

Code	Description	Nature
373	TED REMETIDA OUTRA TITULARIDADE MANUAL / TED ENV OUTRA TIT MANUAL	D
778	TED REMETIDA OUTRA TITULARIDADE IB / TED ENVIADA OUTRA TIT IB	D
779	TED REMETIDA MESMA TITULARIDADE IB / TED ENVIADA MESMA TIT IB	D
780	TRANSF.ENT.CTAS INTERN. BANKING / TRANSF ENTRE CONTAS BS2	D
781	TRANSF.ENT.CTAS DIF. INTER.BANK. / TRANSF ENTRE CONTAS BS2	D
829	TED ENVIADA STR008 / TED ENVIADA STR008	D
50	TED C RECEBIDA / RECEBIMENTO TED	C
786	RECEB.TRANSF.ENT.CONTAS IB / RECEBIMENTO CONTAS BS2	C

Other

Code	Description	Nature
25	LANÇAMENTO AVISADO A CRÉDITO / CRÉDITO CONFORME AVISO	C
301	TRANSFERÊNCIA ENTRE CONTAS / TRANSF ENTRE CONTAS BS2	D
322	DÉBITO CONFORME AVISO / DÉBITO CONFORME AVISO	D
385	TRANSF.ENTRE CONTAS – DIFERENTE / TRANSF ENTRE CONTAS BS2	D
413	ACOLHIMENTO DEPÓSITO JUDICIAL / ACOLHIMENTO JUDICIAL	D

Obtain the account statement (Legacy)

In the statement, detailed data on financial transactions in the client's checking account is returned.

We request the fields:

Field	Description	Format	Mandatory
movimentoInicial	Start date of the bank statement period.	date-time	Sim
movimentoFinal	End date of the bank statement period. The interval between dates cannot exceed 31 days.	date-time	Sim

Response:

Field	Description	Format	Nullable
Saldo	Starting, ending and blocked balance	object	Não
ChequeEspecial	Displays information on interest rate, limit amount, due date, IOF, total accrued interest, total effective cost and the number of days the overdraft protection is used	object	Não
Movimentacoes	Displays the transaction date, description, amount, type of transaction ('D' debit or 'C' credit) and the category (see table [Transaction categories]), sender and beneficiary of the transaction	array	Sim

Obter o extrato da conta (legado)

Transaction categories (Legacy)

The mapped categories of financial transactions are:

Enumeration	Description
1	Payment
2	Transfer
3	Deposit
4	Withdraw
5	Payment Chargeback
6	Transfer Chargeback
7	Fee
8	Fee Chargeback
9	Purchase Card
10	PIX credit
11	PIX debit
12	PIX Internal Return Debit
13	PIX Internal Chargeback Credit
14	PIX Return Credit
15	PIX Return Debit
16	PIX Internal Receipt Credit
17	PIX Internal Payment Debit
18	PIX Debit Return
19	PIX Credit Return
20	Pix fee
99	Others

Bank account details obtained upon authentication

This functionality displays data from the checking account that is making requests to this API.

Response:

Field	Description	Format	Nullable
usuario	Identifies the user authenticated in the application	string	Sim
Empresa	Inform the CNPJ and company name	object	Sim
Conta	Provide the account number and branch of the authenticated user	object	Sim

Obter dados da conta baseado na autenticação