Integração de cobrança via Web Service / API ACBr

Detalhes de configuração para comunicação via Web Service ou API com o banco para evitar a necessidade de manualmente fazer o controle por arquivo de remessa

• Bancos homologados
• Retorno dos Boletos via API/WS

Bancos homologados

• Sicredi - Versão: 816
• Sicoob - Versão: 816
• Inter - Versão: 816

Retorno dos Boletos via API/WS

🧩 Objetivo

A aba Retornos API tem como função facilitar a identificação e liquidação de boletos bancários que foram pagos no período selecionado, permitindo ao usuário integrar essas informações com as faturas em aberto no sistema. A tela se encontra no Menu Banco -> Retorno de Boletos.

⚙️ Funcionamento

1. Seleção da Conta Bancária

• Campo para selecionar uma conta bancária previamente configurada no sistema.

• Este filtro determina a origem dos dados de liquidação dos boletos consultados.

2. Definição do Período

• O usuário escolhe o intervalo de datas para consulta (ex.: Hoje, Últimos 7 dias, Data personalizada).

• Base temporal usada para buscar os boletos liquidados na API bancária.

3. Consulta de Boletos

• Ao clicar no botão Consultar Boletos, o sistema realiza uma integração com a API do banco vinculado à conta selecionada.

• São retornados e listados na grade os títulos que foram liquidados dentro do período especificado.

4. Listagem dos Títulos

A grade exibe os seguintes dados por boleto liquidado:

• Parceiro

• Nome (no arquivo)

• ID do Boleto

• Nº Documento

• Valor do Título

• Vencimento

• Mora, Multa e Acréscimos

• Valor Pago

• Datas de Ocorrência e Crédito

• Nosso Número, Agência e Conta

• Motivos de ocorrência, tarifas, abatimento, desconto e despesas

Além disso:

• A primeira coluna da grid possui checkboxes, permitindo selecionar múltiplos boletos que permitirá o sistema realizar a liquidação dos titulos localizados.

5. Liquidação das Parcelas

• Após selecionar os boletos desejados, o usuário deve clicar no botão Liquidar Parcelas (F5).

• O sistema irá:

  • Identificar faturas em aberto vinculadas aos boletos selecionados.

  • Atualizar o status de cada parcela, registrando os pagamentos conforme os dados retornados.

  • Gerar movimentações financeiras conforme as regras do sistema.

📌 Observações Técnicas

• Caso possui valores relacionados a tarifas do boleto cobrada pelo banco, será registrar uma despesa no sistema referente as mesmas.

• Os valores recebidos são desmembrados para compor os campos de multa, mora, juros, tarifas, etc.

 

🏦 Particularidades de cada Banco

🔷 Banco SICOOB

📋 Funcionamento geral

• O módulo Retornos Sicoob apresenta uma lista dos retornos disponíveis para processamento.

• Para que um retorno apareça disponível, é necessário abrir uma solicitação prévia ao Sicoob, informando o período desejado.

⚙️ Processo de solicitação

1. O usuário acessa a aba “Retornos API” → “Retornos Sicoob”.

2. Define o período desejado para solicitação sendo de um dia especifico (por exemplo, “Hoje”, “ontem” ou dia específico).

3. O sistema envia uma requisição à API do Sicoob, solicitando os retornos referentes ao período informado.
   lembrando que para essa solicitação acontecer, é necessário que o campo do Retornos Sicoob não tenha nenhum selecionado.

   

4. A solicitação é registrada com data, código de solicitação, conta vinculada e status de disponibilidade.

🔔 Notificação de retorno disponível

• Assim que o Sicoob disponibiliza o arquivo de retorno solicitado, o sistema emite um aviso visual no canto inferior direito da tela uma única vez, caso fechado o aviso não voltará a ser exibido a menos que faça outra solicitação ao banco.

• O aviso tem o formato:

  💬 “Retorno Bancário da Conta [NOME DA CONTA] está disponível para processamento.”

📦 Processamento

O retorno é listado na grade com os seguintes campos:

• • Data Solicitação

  • Código Solicitação

  • Disponível 

  • Processado

  • Código da Conta

  • Notificado

  • Data Inicial
  • Data Final

• O usuário pode então selecionar o retorno e precionar o botão Consultar Boletos. Onde será exibido na Grid abaixo os titulos recebidos.

🔷Banco SICREDI

📋 Funcionamento geral

• Para o Sicredi, a obtenção dos retornos via API, porém com uma particularidade:

  • A API não permite consulta direta por intervalo de datas.

  • Portanto, o sistema precisa realizar uma requisição separada para cada dia dentro do período informado.

⚙️ Processo de consulta

1. O usuário define o intervalo de datas (ex.: 01/11/2025 a 05/11/2025).

2. O sistema gera um lista de dias ([01/11, 02/11, 03/11, 04/11, 05/11]).

3. Para cada data individual, o sistema envia uma requisição à API do Sicredi.

4. As respostas são agregadas e exibidas em uma lista unificada na tela.

5. Caso não tenha registros no dia, o mesmo retornará que "não possui retorno no dia"

📦 Processamento

• Cada retorno é tratado de forma independente (um por dia), mas é exibido em conjunto no grid da interface.

• o processamento segue o fluxo normal de conciliação e baixa de títulos.

 

🔷Banco Inter

📋 Funcionamento geral

• Para o Inter, a obtenção dos retornos via API, permite solicitar dentro de uma faixa de dias: (esta semana, semana passada, este mês)

⚙️ Processo de consulta

1. O usuário define o intervalo de datas (ex.: 01/11/2025 a 05/11/2025).

2. As respostas são agregadas e exibidas em uma lista unificada na tela.

3. Caso não tenha registros no dia, o mesmo retornará que "não possui retorno no dia"