Docs/API Reference/Pagamentos
DashboardGitHub

A Dyvit processa pagamentos Pix via Mercado Pago. O fluxo é: o agente gera um QR code Pix, o devedor paga, e o webhook do Mercado Pago notifica a confirmação automaticamente.

Endpoints

#
MétodoEndpointDescrição
GET/api/payments/:debtIdStatus do pagamento (requer autenticação)
POST/api/payments/webhookWebhook IPN do Mercado Pago
ℹ️

O endpoint de status do pagamento exige Authorization: Bearer TOKEN e só enxerga dívidas do próprio cliente. O webhook é chamado diretamente pelo Mercado Pago e se autentica pela assinatura HMAC.


Status do pagamento

GET/api/payments/:debtId

Retorna o status atual do pagamento associado a uma dívida do cliente autenticado. Retorna PENDING, APPROVED, REJECTED ou CANCELLED.

Para o polling da página pública de checkout, que o devedor abre sem sessão, use GET /api/checkout/:debtId/status: ele é público e devolve apenas o campo status.


Webhook IPN

POST/api/payments/webhook

Recebe notificações IPN (Instant Payment Notification) do Mercado Pago. Quando um pagamento Pix é confirmado, este endpoint soma o valor ao saldo pago da dívida e decide pelo alvo de quitação (acordo negociado, ou o valor original): se quitou, a dívida vai para PAID, a conversa encerra e o Termo de Quitação é gerado; se não, a dívida fica PARTIALLY_PAID (aberta) e o devedor recebe o saldo restante. Estornos reabrem a dívida.

Para a sua integração, os eventos de saída são payment.succeeded/payment.confirmed (dívida quitada), payment.partial (pagamento que não quita, com paidTotal e remainingAmount) e payment.refunded (estorno).

⚠️

Este endpoint é chamado exclusivamente pelo Mercado Pago. Não envie requisições manuais para ele.