Integração Webhook da API Sicredi (Beta)
Atenção!
Este conteúdo está presente na versão Beta. Sua disponibilidade na versão Master será a partir de Abril de 2025.
Introdução
Esta documentação detalha o processo de integração da API Webhook do Sicredi com o sistema. O Webhook permite o recebimento de notificações em tempo real entre o banco Sicredi e o sistema, automatizando a baixa de pagamentos recebidos via Pix e trazendo agilidade na liquidação dos boletos pagos via código de barras.
Acesso ao formulário
Caminho: Menu Sistema > Cadastros > Pasta Financeiro > Carteira de cobrança > Aba Configurações Gateway
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.
Funcionalidade Principal
A integração da API Webhook do Sicredi possibilita o recebimento instantâneo de notificações sobre boletos pagos via Pix, além de agilizar a liquidação de boletos quitados por código de barras.
Passo a Passo: Como Configurar Webhook da API Sicredi
- Início;
- Acesse o Menu Sistema > Cadastros > Pasta Financeiro > Carteira de cobrança;
- Selecione a carteira de cobrança desejada e clique em Editar;
- Siga para aba Configurações gateway;
- Localize o campo “Usar webhook” e selecione a opção Sim;
- Em seguida, preencha os seguintes campos:
- Código do beneficiário: Número do convênio (pode ser consultado na aba “Configurações bancárias”)
- Código da Cooperativa: Número da Agência bancária;
- Após preencher os campos, clique em Salvar.
- Fim.
A partir dessa configuração, os pagamentos realizados para títulos gerados na carteira de cobrança do Sicredi API terão o webhook da liquidação enviado ao Sistema, permitindo o recebimento ágil das cobranças.
Melhoria Versão Estável - Abril 2025!
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.
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.
Considerações Importantes
- Verifique a versão do sistema! O webhook foi liberado a partir da versão do dia 05/02/2025.
- 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 do 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 integração do Webhook do Sicredi com a API de Carteira de cobrança do Sistema oferece uma solução eficiente para a gestão de pagamentos. É crucial verificar a versão atual do Sistema.
Etiquetas
IntegracaoBancaria Webhook Sicredi SicrediApi CarteiraDeCobranca ApiBancaria