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.
Um pagamento final devolvido vira um recebível
Estornar o pagamento que quitou um empréstimo consignado nem sempre devolve a dívida ao contrato. A ordem de exclusão manda a entidade pagadora parar de descontar da folha. Depois que a ordem foi emitida ao trilho e o trilho não a rejeitou, o mandato de folha acabou. Nada no Lender o averba de novo. Um contrato revivido ali seria dívida sem instrumento por trás. Essa dívida seria cobrada por atraso, provisionada e oferecida de volta ao oficial como algo cujo desconto ele poderia cancelar uma segunda vez. O Lender ainda aceita o estorno, porque o banco devolveu o dinheiro e o ledger tem de concordar com o banco. O destino muda. O Lender abre um recebível de pagamento devolvido contra o tomador, fora da operação de crédito, sem mandato de folha e cobrado por outros meios. O estorno responde qual dos dois aconteceu, e com o id do recebível quando um foi aberto. O contrato mantém o estado de quitado. Nada reabre. O Lender não reprocessa nenhum cronograma e não desfaz nenhuma alocação.
Uma exclusão ainda em voo conta como emitida. Um estorno não pode esperar a resposta do trilho. Se uma revivência acontece antes de o trilho responder, nada a desfaz quando a resposta volta confirmada. Onde o trilho rejeitou a exclusão, o mandato nunca morreu, e o estorno revive o contrato exatamente como sempre reviveu.
Trabalhar o recebível
Uma cobrança quita a dívida inteira, então ela não carrega valor: o Lender lê o número do recebível. Ela recebe um id de pedido nos mesmos cabeçalhos que um repagamento recebe. Reenviar a mesma cobrança sob esse mesmo id de pedido responde
200 com a cobrança que já está de pé. Uma segunda cobrança, diferente, contra uma dívida já cobrada responde 409 com LENDER-0325. O Lender recusa uma cobrança com 422 e LENDER-0326 quando o instante de cobrança dela não é RFC 3339, ou quando ela não tem id de pedido. A mesma recusa cobre um nome de cobrador mais longo do que o campo comporta, ou um id de pedido já gasto cobrando outra dívida.
O recebível nomeia o contrato de onde veio, então você encontra os recebíveis de um contrato delimitando a lista àquela conta de empréstimo. Ele não faz parte da visão de servicing do próprio contrato, porque já não é dívida do contrato.
O Lender carrega o recebível a valor de face. A varredura diária de PDD o envelhece pela escala do produto de origem e provisiona a perda esperada para a idade dele. No estágio final, a varredura o baixa a prejuízo. Um produto cujo plano de contas pode desviar um pagamento devolvido deve carregar as três regras dessa provisão e dessa baixa. Caso contrário, o Lender recusa o plano com 422 e LENDER-0406.
O que acontece downstream
A gestão da carteira emite
repayment.recorded, repayment_reversal.recorded, loan_schedule.prepayment_applied, loan_schedule.rescheduled, returned_payment_receivable.opened, returned_payment_receivable.collected e returned_payment_receivable.written_off. Um pagamento, um estorno e um pagamento antecipado registram intenções de lançamento duráveis. O Lender as repassa 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.