Checking Account

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

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

Resposta:

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

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

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