Este documento descreve o funcionamento do envio de webhooks para a atualização do status de um boleto. O webhook é utilizado para notificar eventos relacionados ao processamento do pagamento do boleto, como Boleto Confirmado, Boleto Pago e Boleto Cancelado. Cada evento contém um conjunto de dados específicos sobre o status do pagamento do boleto.

---

Estrutura do WebhookCopied!

O sistema envia dados em três momentos distintos:

1. Boleto Confirmado: Quando o boleto é gerado e o pagamento está aguardando pagamento.

2. Boleto Pago: Quando o pagamento do boleto é confirmado.

3. Boleto Cancelado: Quando o boleto é cancelado.

---

Dados enviado nos eventos dos webhooksCopied!

Campo	Tipo	Obrigatório	Descrição
product	string	Sim	Identificação do produto como Boleto
paymentId	string	Sim	ID do pagamento gerado
status	string	Sim	Status do pagamento no momento em que o webhook foi processado
externalId	string	Não	ID externo do pagamento, se aplicável
processedAt	Date	Sim	Data e hora em que o evento foi processado pelo sistema (formato ISO 8601).
additionalInfo	object	Não	Contém informações adicionais sobre o evento, como URLs, códigos, motivos de cancelamento e outros detalhes específicos.
additionalInfo.pdfUrl	string	Não	URL para acessar o arquivo PDF gerado para o boleto.
additionalInfo.pixCode	string	Não	Código Pix gerado para pagamento.
additionalInfo.barcode	string	Não	Código de barras do boleto.
additionalInfo.slipLine	string	Não	Linha digitável do boleto.
additionalInfo.issuingBank	string	Não	Banco emissor do boleto.
additionalInfo.reason	string	Não	Motivo do cancelamento do boleto (exemplo: "Cliente solicitou cancelamento", "Boleto expirado").

ConclusãoCopied!

Os webhooks descritos acima são enviados para garantir que o sistema receptor esteja sempre atualizado sobre o status do pagamento de boletos. Eles permitem uma comunicação eficiente e em tempo real entre o sistema de pagamentos e o sistema receptor, garantindo que o processo de pagamento seja monitorado e atualizado adequadamente.