Leia a conta
Registre dinheiro
1
Veja a prévia da alocação
POST /api/v1/loan-accounts/{id}/preview-repayment mostra como o Lender alocaria um pagamento entre as parcelas em aberto sem registrar o pagamento. O Lender paga primeiro a parcela vencida mais antiga. Dentro de cada parcela, ele paga multas, depois tarifas, depois juros, depois principal.2
Registre o pagamento
POST /api/v1/loan-accounts/{id}/repayments registra o dinheiro recebido e o aloca pelo cronograma. Envie um id de requisição em X-Request-ID, ou em X-Idempotency como fallback. 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 efetiva retorna o pagamento já registrado. O mesmo id com fatos diferentes responde 409. Veja Idempotência.3
Antecipe
POST /api/v1/loan-accounts/{id}/prepayments liquida o empréstimo antes do prazo, no todo ou em parte. 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 de cronograma, não uma edição do antigo.
Corrija sem destruir
As correções preservam uma linha do tempo consistente e auditável. Para desfazer uma transação registrada, estorne essa transação:
POST /api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse
Um estorno acrescenta uma transação compensatória em vez de apagar qualquer coisa, então a conta mantém uma trilha de auditoria completa.
Um estorno aceita um id de requisição nos mesmos headers de um pagamento. O mesmo id repete o estorno já registrado apenas quando cada fato do estorno também bate. Os fatos do estorno são a transação que você estorna, 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 um broker está configurado, a gestão da carteira emite
repayment.recorded, repayment_reversal.recorded, loan_schedule.prepayment_applied e loan_schedule.rescheduled. Um pagamento antecipado liquidado contra uma cotação brasileira de pagamento antecipado registra uma intenção de lançamento durável. O pagamento antecipado repassa essa intenção ao ledger apenas quando você configura o relay do ledger. Leia o caminho de lançamento.
Próximos passos
Contabilidade e rodadas de apropriação
Reconheça juros ao longo do tempo e leia a referência de diário que cada rodada registra.
Pacote regulatório Brasil
Leia o estágio de PDD de um empréstimo em atraso e aplique uma transição de estágio.