Central de Ajuda

Leitura de 4 min

Integração Webhook da API Sicoob

Introdução

Esta documentação detalha o processo de integração da API Webhook do Sicoob com o sistema. O Webhook permite o recebimento de notificações em tempo real entre o banco Sicoob e o sistema, automatizando a baixa de pagamentos recebidos via Pix e e agilidade na liquidação dos boletos pagos via código de barras.

Benefícios!

  • Baixa automática de recebimentos via Pix;
  • Redução de processos manuais;
  • Maior eficiência na gestão financeira;
  • Informações em tempo real sobre pagamentos e liquidações.

Acesso ao formulário

Caminho: Menu Sistema > Cadastros > Pasta Financeiro > Carteira de cobrança > Aba Configurações Gateway

Funcionalidade Principal

A integração da API Sicoob com a comunicação via Webhook possibilita o recebimento instantâneo de notificações enviadas pelo Banco sobre boletos pagos via Pix, além de agilizar a liquidação de boletos quitados por código de barras.

Importante!

Detalhes de funcionamento - Webhook API Banco Sicoob

  • O webhook só pode ser utilizado se os escopos de webhook estiverem habilitados na plataforma Developers Sicoob;
  • Apenas um webhook pode ser criado por convênio Sicoob;
  • Após o envio da solicitação de cadastro do webhook, o tempo de ativação pode variar;
  • Para pagamentos via Pix, serão recebidos no sistema mediante prazo de compensação de liquidação pelo Banco Central e o Sicoob;
  • Para pagamentos via linha digitável, serão recebidos no sistema mediante prazo de compensação de liquidação pelo Banco Central e o Sicoob;
  • Se desejado ativar o webhook em mais de uma carteira de cobrança que utilize o mesmo convênio Sicoob, o Sistema utilizará o URL callback da carteira previamente cadastrada para a comunicação do webhook.

O webhook deve ser utilizado somente com a versão V3 da API Sicoob.

Melhorias!

Master abril 2025

1. Agora estão disponíveis dois novos campos para o controle do float (como D+0, D+1) da data de crédito.

  • Se for preenchido com “0”, a data do crédito será igual à data do pagamento.
  • Se for preenchido com “1” ou valor maior, a data do crédito deve ser a data do pagamento + o número de dias úteis do campo.

2. Campos Adicionados:

  • Data de crédito Pix: data em que a movimentação financeira ficará registrada no ato de recebimento.
  • Data de crédito boleto: data em que a movimentação financeira ficará registrada no ato de recebimento.

Passo a Passo: Como Configurar Webhook da API Sicoob

  1. Acesse o Developers Sicoob e faça o login em sua conta.
  2. Acesse o menu Meus Aplicativos, clique em Novo Aplicativo digite um nome para a sua aplicação (a Descrição é opcional), em seguida clique em Prosseguir.
  3. No parâmetro A integração será por uma empresa parceira, marque como Sim.
  4. Agora em Empresa parceira, localize na lista e selecione IXC Soft SA, e clique em Prosseguir.
  5. Na tela de APIs, selecione a opção:
    • Cobrança Bancária V3.
    • Tendo selecionado a opção Cobrança Bancária V3, certifique-se de que todos os escopos de webhook também estejam ativos:
      • webhooks_inclusao
      • webhooks_consulta
      • webhooks_alteracao
  6. Clique em Prosseguir.
  7. Feito isso, o aplicativo estará criado e com o Status Pendente, então é necessário aprovar a sua criação em seu Internet banking para que ele adote o Status Ativo.
  8. Após ativação do aplicativo, novamente no ambiente developers do banco, acesse seu aplicativo e copie a informação Client ID.
  9. Fim.

A partir dessa configuração, os pagamentos realizados para títulos gerados na carteira de cobrança do Sicoob API terão o webhook da liquidação enviado ao Sistema, permitindo o recebimento ágil das cobranças.

Considerações Importantes

  • Após ativar o parâmetro “Usar webhook”, realize testes tanto via Pix quanto via boleto (gere um boleto teste e efetue seu pagamento).
  • Mesmo após habilitar o parâmetro, mantenha a configuração das consultas de pagamento ativa. Ao utilizar o webhook, estas consultas trabalharão como uma garantia de baixas, que executará sempre no dia seguinte consultando as liquidações ocorridas no dia anterior.

Fluxo de Processo

graph TD
    Start[Início] --> A[Acessar Carteira de cobrança]
    A --> B[Editar carteira]
    B --> C[Ativar Parâmetro Webhook]
    C --> D[Preencher Campos]
    D --> E[Salvar]
    E --> End[Fim]

Considerações Finais

A implementação do Webhook para a integração da carteira de cobrança com a API Sicoob no sistema proporciona uma solução eficiente para a gestão de pagamentos. Sua configuração proporciona um fluxo aprimorado para o recebimento de liquidações com a API do banco Sicoob. Mantenha seu sistema atualizado para aproveitar esse benefício.

Etiquetas

IntegracaoBancaria Webhook Sicoob SicoobApi CarteiraDeCobranca ApiBancaria

Leia Também

Visão de gráfico