Docs/API Reference/Recorrência
DashboardGitHub

Pagamentos recorrentes automatizam a cobrança de parcelas. Quando um plano de parcelamento é aceito, a recorrência gera Pix automaticamente a cada vencimento e notifica o devedor via WhatsApp.

Endpoints

#
MétodoEndpointDescrição
POST/api/recurring/createCriar pagamento recorrente
GET/api/recurring/debt/:debtIdListar recorrentes de uma dívida
POST/api/recurring/:id/pausePausar recorrência
POST/api/recurring/:id/resumeRetomar recorrência
POST/api/recurring/:id/cancelCancelar definitivamente
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).

Criar pagamento recorrente

POST/api/recurring/create

Cria uma recorrência vinculada a uma dívida ou plano de parcelamento. Define valor, intervalo (mensal) e data de início.

Listar recorrentes de uma dívida

GET/api/recurring/debt/:debtId

Retorna todos os pagamentos recorrentes associados a uma dívida, incluindo status e histórico de cobranças geradas.

Pausar recorrência

POST/api/recurring/:id/pause

Pausa temporariamente a geração de cobranças. A recorrência pode ser retomada a qualquer momento.

Retomar recorrência

POST/api/recurring/:id/resume

Retoma uma recorrência pausada. A próxima cobrança será gerada na data prevista.

Cancelar definitivamente

POST/api/recurring/:id/cancel

Cancela a recorrência de forma definitiva. Esta ação não pode ser revertida. Para interrupções temporárias, use o endpoint de pausa.