Docs/API Reference/Recibos
DashboardGitHub

Após a confirmação de pagamento, a Dyvit gera automaticamente um Termo de Quitação com protocolo único. O recibo pode ser enviado via WhatsApp e email, e fica disponível para download.

Endpoints

#
MétodoEndpointDescrição
GET/api/receipts/:protocolDownload por protocolo (requer HMAC sig)
POST/api/receipts/generate/:paymentIdGerar recibo + enviar via WhatsApp
POST/api/receipts/regenerate-allRegenerar todos os recibos em lote
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN), exceto o download por protocolo que usa assinatura HMAC.

Download por protocolo

GET/api/receipts/:protocol

Retorna o Termo de Quitação pelo número de protocolo. Requer uma assinatura HMAC válida no query parameter sig para autenticação. Esse endpoint é público e usado nos links enviados ao devedor.

Gerar recibo

POST/api/receipts/generate/:paymentId

Gera o Termo de Quitação para um pagamento confirmado e envia automaticamente via WhatsApp ao devedor. Opcionalmente, envia também por email via Resend.

Regenerar todos os recibos

POST/api/receipts/regenerate-all

Regenera todos os recibos existentes em lote. Útil após atualizações no template do Termo de Quitação.

⚠️

Este endpoint processa todos os recibos em background. O tempo de execução depende do volume total.