Leia a conta
Registre dinheiro
1
Pré-visualize a alocação
POST /api/v1/loan-accounts/{id}/preview-repayment mostra como um repagamento seria alocado entre as parcelas em aberto sem registrá-lo. O Lender paga primeiro a parcela vencida mais antiga. Dentro de cada parcela ele paga multas, depois encargos, depois juros e por último o principal.2
Registre o repagamento
POST /api/v1/loan-accounts/{id}/repayments registra o dinheiro recebido e o aloca ao longo do cronograma. Envie um id de request em X-Request-ID, ou em X-Idempotency como alternativa — uma chamada sem nenhum dos dois responde 422. O mesmo id com a mesma conta de empréstimo, o mesmo valor e a mesma data de efeito devolve o repagamento já registrado. O mesmo id com dados diferentes responde 409. Leia Idempotência.3
Pague antecipadamente
POST /api/v1/loan-accounts/{id}/prepayments liquida o empréstimo antes do prazo, total ou parcialmente. Uma conta de empréstimo brasileira precisa antes de uma cotação de pagamento antecipado.Mude o cronograma
POST /api/v1/loan-accounts/{id}/reschedules reescreve o cronograma restante — para uma renegociação, por exemplo. A mudança é um novo estado do cronograma, não uma edição do anterior.
Corrija sem destruir
Correções preservam uma linha do tempo consistente e auditável. Para desfazer uma transação registrada, estorne-a:
POST /api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse
Um estorno acrescenta uma transação compensatória em vez de apagar qualquer coisa, assim a conta mantém uma trilha de auditoria completa.
Um estorno recebe um id de request nos mesmos headers de um repagamento. O mesmo id repete o estorno já registrado somente quando cada fato do estorno também coincide: a transação que está sendo revertida, a conta de empréstimo, a data efetiva do estorno, o motivo, a versão do perfil e o código de jurisdição. Qualquer diferença nesses fatos responde 409.
O que acontece downstream
Quando o streaming está habilitado e há um broker configurado, o servicing emite
repayment.recorded, repayment_reversal.recorded, loan_schedule.prepayment_applied e loan_schedule.rescheduled. Um pagamento antecipado liquidado contra uma cotação de pagamento antecipado brasileira registra uma intenção de posting durável e a transmite ao ledger somente quando o relay do ledger está configurado. Leia a rota de posting.
Próximos passos
Contabilidade e rotinas de apropriação
Reconheça juros ao longo do tempo e leia a referência de lançamento que cada rotina registra.
Pacote regulatório do Brasil
Leia o estágio de PDD de um empréstimo vencido e aplique uma transição de estágio.