Webhook de limpeza de transação

Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de limpeza de transação. Este módulo serve para integrar sistemas de terceiros com boletos manuais no Recuperador CRM.

Limpeza de transação é um procedimento usado para cancelar uma transação de meio de pagamento. Serve para cancelar o registro de um boleto, cancelar um QR Code PIX etc. Ela normalmente é feita a pedido do devedor que perdeu o prazo de pagamento de um boleto ou PIX. A limpeza também acontece para viabilizar o cancelamento de um acordo que possua uma parcela com boleto ou transação PIX gerada e não paga.

Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a limpeza de transação efetuada. Isso permitirá com que o sistema de terceiros faça algumam ações, tais como remover o registro do boleto, cancelar uma transação PIX etc.

Dica: sistema de terceiros é um sistema feito por outra empresa, diferente da empresa responsável pelo Recuperador CRM, que receberá as informações da parcela afetada pela limpeza de transação. Esse sistema de terceiros pode ser um sistema de gestão, pode ser um sistema próprio etc.

Configuração inicial

O primeiro passo é habilitar o webhook de limpeza de transação no cadastro do credor em questão. Isso pode ser feito logado como administrador por meio do menu Cadastros > Credores > aba Webhooks. Mude o campo Habilita webhook de limpeza de transação para Sim, defina o endereço do endpoint do sistema de terceiros e clique em Salvar.

Importante: o endpoint do webhook de limpeza de transação deve ser obtido com o suporte do seu sistema de terceiros. Ele deve começar com http ou https.

Locais de disparo do webhook de limpeza de transação

Os webhooks de limpeza de transação serão disparados automaticamente sempre que:

1. Uma parcela de acordo for afetada pela limpeza de transação manual;
2. Uma parcela de acordo for afetada pela limpeza de transação para cancelamento automático de acordos;
3. Uma parcela de acordo for afetada pela limpeza de transação por meio do endpoint de limpeza de transação (integração);

O sistema fará até 5 tentativas de envio de webhook de uma limpeza de transação para o sistema de terceiros.

Relatório

Em Cadastros > Credores > aba Webhooks > botão Lista de payloads de limpeza de transação, é possível consultar os disparos dos webhooks de limpeza de transação por período e o status do envio por meio da coluna Enviado.

Além disso, é possível usar o botão Reprocessar para forçar o envio dos webhooks de limpeza de transação um determinado período que eventualmente não foram enviados. Isso pode ser especialmente útil em caso de queda temporária do sistema de terceiros.

Classe do evento do payload

O webhook disparará uma ação de POST para o endpoint informado no formato JSON com os seguintes campos:

• int id: código do webhook;
• int id_credor: código do credor;
• int id_acordo: código do acordo referente à parcela afetada;
• int id_cliente: código do cliente ;
• int id_contasareceber: código da parcela de acordo afetada;
• int id_limpezatransacao: código da parcela de acordo afetada;
• string nome_cliente: nome do devedor;
• string cpf_cnpj: CPF ou CNPJ formatado do devedor;
• string nome_credor: nome do credor;
• DatTime data_vencto: data de vencimento da parcela de acordo;
• string meio_pagto: nome do meio de pagamento utilizado na transação afetada pela limpeza de transação;
• decimal valor: valor da parcela afetada;
• DateTime data_limpeza: data da limpeza de transação da parcela de acordo;