Objective

To perform automatic reconciliation of receivables using the APIs of banks in general (e.g., Inter, Itaú, Bradesco, Santander, Banco do Brasil, etc.), and reflect the payments in EVO by marking the receivables as received (paid).

🚧 Important: Currently, there is no direct integration between EVO and banks.
What is possible is for the customer to develop their own automation that consumes the bank APIs and then uses the EVO API to update the financial status.

Main Endpoint (EVO API)

Marks a list of receivables as received (paid)

PUT /api/v1/receivables/mark-received

Auxiliary Endpoints (EVO)

Consult receivables (to map open titles)

GET /api/v1/receivables

Consult bank accounts (to obtain the idBankAccount)

GET /api/v1/bank-accounts

(Optional) Consult debtors / delinquency

GET /api/v1/receivables/debtors

Requirements

Client-side integration with the bank

The customer must consult the bank for confirmed payments via bank APIs.

Existing receivables in EVO

The titles need to exist in EVO as accounts receivable.

Mapping between Bank and EVO

The customer needs a strategy to identify which bank payment corresponds to which receivable in EVO (e.g., amount, date, payer, description, identifiers, etc.).

idBankAccount

Identifier of the bank account in EVO where the receipt will be recorded.

Step by Step

1. Consult Bank Accounts in EVO

Before marking payments, it is necessary to obtain the idBankAccount that will be used to record the receipt.

Endpoint:

GET /api/v1/bank-accounts

Choose the correct account (e.g., "Main Checking Account") and save the id field.

2. Consult Open Receivables in EVO

The next step is to list the receivables that have not yet been paid, to cross-reference with the payments obtained from the bank.

Endpoint:

GET /api/v1/receivables

Recommended filters:

Due date (dueDateStart, dueDateEnd)

Payment type (paymentTypes)

ID	Payment Type
1	Cash
2	Credit Card
3	Debit Card
4	Check
5	Bank Slip
6	PagSeguro
7	Deposit
8	Direct Debit
9	Internet
11	Sales Credits
12	Online Credit Card
13	Transfer
18	Pix
0	Outstanding Balance

Status of the receivable (accountStatus)

1 = Open

4 = Overdue

Tip: Working with a date range (e.g., last 7 days) avoids very large queries and facilitates reconciliation.

3. Consult Confirmed Payments at the Bank

On the bank side, the customer should consult the available APIs to:

Identify received amounts

Obtain payment date/time, amount, payer, and identifiers (when available)

This step occurs outside the EVO API, using the bank's official APIs.

4. Match (Bank ↔ EVO)

The customer should cross-reference the bank data with the data returned from the GET /receivables endpoint.

The goal is to create a list of EVO IDs:

idReceivable (EVO) ← will be used in mark-received

Useful fields returned by EVO for matching:

idReceivable

amount

dueDate

payerName

paymentType

description

authorization (when applicable)

🚧 Important: the EVO API does not perform this match automatically.
Reconciliation depends on the integrator's logic.

5. Mark Receivables as Received in EVO

With the identified idReceivable, send the request to mark as paid.

Parameters:

Parameter	Type	Required	Description
`idsReceivables`	array<int32>	Yes	List of IDs of the receivables to be marked as paid.
`idBankAccount`	int32	Yes	Bank account in EVO where the receipt will be recorded.

Example Request

Frequently Asked Questions

1. Is it possible to connect any bank directly to EVO via API?

No.
Currently, EVO does not have direct integration with banks.

The recommended path is:

The customer consumes the bank APIs

Matches the payments

Uses the EVO API to record the receipts

2. Is there anything native for credit cards?

For credit cards, EVO integrates with some payment gateways, which bridge EVO and the acquiring/bank ecosystem.

🚧 EVO does not communicate directly with acquirers or banks for credit cards.

3. What happens if I mark a receivable incorrectly as paid?

The receivable will be updated in EVO as received, impacting:

financials

collection status

reports

Therefore, the match must be done carefully.

Expected Result

After executing the flow:

The payments identified at the bank will be reflected in EVO

The corresponding titles will be marked as Received

The financials will be consistent with the bank statement (as long as the match is correct)

Bank payment reconciliation

Objective#

Main Endpoint (EVO API)#

Auxiliary Endpoints (EVO)#

Consult receivables (to map open titles)#

Consult bank accounts (to obtain the idBankAccount)#

(Optional) Consult debtors / delinquency#

Requirements#

Step by Step#

1. Consult Bank Accounts in EVO#

2. Consult Open Receivables in EVO#

3. Consult Confirmed Payments at the Bank#

4. Match (Bank ↔ EVO)#

5. Mark Receivables as Received in EVO#

Example Request#

Frequently Asked Questions#

1. Is it possible to connect any bank directly to EVO via API?#

2. Is there anything native for credit cards?#

3. What happens if I mark a receivable incorrectly as paid?#

Expected Result#