Objetivo

Realizar a conciliação automática de recebimentos utilizando as APIs de bancos no geral (ex.: Inter, Itaú, Bradesco, Santander, Banco do Brasil, etc.), e refletir os pagamentos no EVO marcando os recebíveis como recebidos (pagos).

🚧 Importante: Atualmente não existe integração direta EVO ↔ Banco.
O que é possível é o cliente desenvolver uma automação própria que consome as APIs do banco e, em seguida, utiliza a EVO API para atualizar o status financeiro.

Endpoint Principal (EVO API)

Marks a list of receivables as received (paid)

PUT /api/v1/receivables/mark-received

Endpoints Auxiliares (EVO)

Consultar recebíveis (para mapear títulos em aberto)

GET /api/v1/receivables

Consultar contas bancárias (para obter o idBankAccount)

GET /api/v1/bank-accounts

(Opcional) Consultar devedores / inadimplência

GET /api/v1/receivables/debtors

Requisitos

Integração do lado do cliente com o banco

O cliente deve consultar no banco os pagamentos confirmados via APIs bancárias.

Recebíveis existentes no EVO

Os títulos precisam existir no EVO como contas a receber.

Mapeamento entre Banco ↔ EVO

O cliente precisa de uma estratégia para identificar qual pagamento do banco corresponde a qual recebível no EVO (ex.: valor, data, pagador, descrição, identificadores, etc.).

idBankAccount

Identificador da conta bancária no EVO onde o recebimento será registrado.

Passo a Passo

1. Consulte as Contas Bancárias no EVO

Antes de marcar pagamentos, é necessário obter o idBankAccount que será utilizado para registrar o recebimento.

Endpoint:

GET /api/v1/bank-accounts

Escolha a conta correta (ex.: “Conta Corrente Principal”) e guarde o campo id.

2. Consulte os Recebíveis em Aberto no EVO

O próximo passo é listar os recebíveis que ainda não foram pagos, para cruzar com os pagamentos obtidos via banco.

Endpoint:

GET /api/v1/receivables

Filtros recomendados:

Período de vencimento (dueDateStart, dueDateEnd)

Tipo de pagamento (paymentTypes)

ID	Tipo de Pagamento
1	Dinheiro
2	Cartão de Crédito
3	Cartão de Débito
4	Cheque
5	Boleto Bancário
6	PagSeguro
7	Depósito
8	Débito em Conta
9	Internet
11	Créditos de Venda
12	Cartão de Crédito Online
13	Transferência
18	Pix
0	Saldo Devedor

Status do recebível (accountStatus)

1 = Em aberto

4 = Atrasado

Dica: Trabalhar com uma janela de datas (ex.: últimos 7 dias) evita consultas muito grandes e facilita a conciliação.

3. Consulte os Pagamentos Confirmados no Banco

Do lado do banco, o cliente deve consultar as APIs disponíveis para:

Identificar valores recebidos

Obter data/hora do pagamento, valor, pagador e identificadores (quando existirem)

Esse passo ocorre fora da EVO API, usando as APIs oficiais do banco.

4. Faça o Match (Banco ↔ EVO)

O cliente deverá cruzar os dados do banco com os dados retornados no endpoint GET /receivables.

O objetivo é montar uma lista de IDs do EVO:

idReceivable (EVO) ← será usado no mark-received

Campos úteis retornados pelo EVO para match:

idReceivable

ammount

dueDate

payerName

paymentType

description

authorization (quando aplicável)

🚧 Importante: a EVO API não realiza esse match automaticamente.
A conciliação depende da lógica do integrador.

5. Marque os Recebíveis Como Recebidos no EVO

Com os idReceivable identificados, envie a requisição para marcar como pago.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
`idsReceivables`	array<int32>	Sim	Lista de IDs dos recebíveis que serão marcados como pagos.
`idBankAccount`	int32	Sim	Conta bancária do EVO onde o recebimento será registrado.

Exemplo de Requisição

Perguntas Frequentes

1. É possível conectar diretamente qualquer banco ao EVO via API?

Não.
Atualmente a EVO não possui integração direta com bancos.

O caminho recomendado é:

O cliente consome as APIs do banco

Faz o match dos pagamentos

Usa a EVO API para registrar os recebimentos

2. Existe algo nativo para cartão de crédito?

Para cartão, a EVO integra com alguns gateways de pagamento, que faz a ponte entre EVO e o ecossistema de adquirência/bancos.

🚧 O EVO não se comunica diretamente com adquirentes ou bancos para cartão.

3. O que acontece se eu marcar um recebível errado como pago?

O recebível será atualizado no EVO como recebido, impactando:

financeiro

status de cobrança

relatórios

Por isso, o match deve ser feito com cuidado.

Resultado Esperado

Após a execução do fluxo:

Os pagamentos identificados no banco serão refletidos no EVO

Os títulos correspondentes serão marcados como Recebidos

O financeiro ficará consistente com o extrato bancário (desde que o match esteja correto)

Conciliação de pagamentos via banco

Objetivo#

Endpoint Principal (EVO API)#

Endpoints Auxiliares (EVO)#

Consultar recebíveis (para mapear títulos em aberto)#

Consultar contas bancárias (para obter o idBankAccount)#

(Opcional) Consultar devedores / inadimplência#

Requisitos#

Passo a Passo#

1. Consulte as Contas Bancárias no EVO#

2. Consulte os Recebíveis em Aberto no EVO#

3. Consulte os Pagamentos Confirmados no Banco#

4. Faça o Match (Banco ↔ EVO)#

5. Marque os Recebíveis Como Recebidos no EVO#

Exemplo de Requisição#

Perguntas Frequentes#

1. É possível conectar diretamente qualquer banco ao EVO via API?#

2. Existe algo nativo para cartão de crédito?#

3. O que acontece se eu marcar um recebível errado como pago?#

Resultado Esperado#