Read the account
| Operation | Purpose |
|---|---|
GET /api/v1/loan-accounts/{id} | Read the active loan account. |
GET /api/v1/loan-accounts/{id}/schedule | Read the current installment schedule. |
GET /api/v1/loan-accounts/{id}/transactions | List transactions posted against the account. |
GET /api/v1/loan-accounts/{id}/charges | List active charges on the account. |
GET /api/v1/loan-accounts/{id}/audit-events | Read the immutable of lifecycle events. |
servicing collection (GET /api/v1/servicings, GET /api/v1/servicings/{id}) is the list-and-lookup surface over these accounts, including an external-status read (GET /api/v1/servicings/{id}/status).
Record money
Preview the allocation
POST /api/v1/loan-accounts/{id}/preview-repayment shows how a repayment would be allocated across outstanding installments — principal, interest, and charges — without recording it.Record the repayment
POST /api/v1/loan-accounts/{id}/repayments records money received and allocates it across the schedule. Writes are idempotent.Prepay
POST /api/v1/loan-accounts/{id}/prepayments settles the loan ahead of schedule, in whole or in part. In Brazil, take a binding prepayment quote first.Change the schedule
POST /api/v1/loan-accounts/{id}/reschedules rewrites the remaining schedule — for a renegotiation, for example. The change is a new schedule state, not an edit of the old one.
Correct without destroying
Corrections preserve a consistent, auditable timeline. To undo a posted transaction, reverse it:
POST /api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse
A reversal posts a compensating entry to the ledger rather than deleting anything, so the account and its books stay in step and the audit trail stays complete.
What happens downstream
Servicing emits
repayment.recorded, repayment_reversal.recorded, loan_schedule.prepayment_applied, and loan_schedule.rescheduled, and each money movement books to the ledger through the posting path.
Next steps
Accounting and accrual runs
Recognize interest over time and trace every posting back to the ledger.
Portfolio and delinquency
See the servicing book in aggregate, including overdue loans.