Preview repayment allocation

Returns a deterministic repayment allocation preview without recording a transaction. Not idempotency-gated. A malformed UUID yields 422 (schema error). A malformed amount string yields 422. Money dated on a São Paulo civil day after today is refused with 422 (LENDER-0395), and money dated on a day before the contract’s disbursement with 422 (LENDER-0985), as the payment would be.

POST /api/v1/loan-accounts/{id}/preview-repayment

Preview repayment allocation

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/preview-repayment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "125.00",
  "effectiveDate": "2026-06-14T17:30:00Z",
  "transactionDate": "2026-06-14T17:30:00Z"
}
'

200

{
  "allocations": [
    {
      "dueDate": "2026-06-14",
      "feesAmount": "3.50",
      "fullyPaid": true,
      "installmentNumber": 3,
      "interestAmount": "20.00",
      "penaltiesAmount": "1.50",
      "principalAmount": "100.00",
      "totalAmount": "125.00"
    }
  ],
  "appliedAmount": "125.00",
  "backdated": true,
  "effectiveDate": "2026-06-14",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "overpaymentAmount": "0.00",
  "prepaidInstallment": {
    "discount": "14.96",
    "dueDate": "2026-06-15",
    "installmentNumber": 1,
    "presentValue": "507.27"
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · string<uuid> · requerido

Loan account identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

Cuerpo

application/json

amount · string · requerido

Repayment amount in major currency units (e.g. "125.00"). Must be positive with at most 2 fractional digits.

Ejemplo:

"125.00"

effectiveDate · string

The moment the money moved, as a full RFC 3339 instant with a time and an offset. A bare YYYY-MM-DD calendar date is refused with LENDER-0348. Omit it and transactionDate, and Lender stamps the tenant's business now.

Ejemplo:

"2026-06-14T17:30:00Z"

transactionDate · string

The moment the money moved, as a full RFC 3339 instant, read when effectiveDate is absent. A bare YYYY-MM-DD calendar date is refused with LENDER-0348.

Ejemplo:

"2026-06-14T17:30:00Z"

Respuesta

200

application/json

OK

allocations · object[] | null · requerido

Per-installment allocation breakdown.

Show child attributes

appliedAmount · string · requerido

Amount applied to the loan (2 d.p. string).

Ejemplo:

"125.00"

backdated · boolean · requerido

True if the repayment effective date is before the business date.

effectiveDate · string · requerido

YYYY-MM-DD São Paulo day of the instant this preview is dated at: the one the request named, or the tenant's business now when it named none.

Ejemplo:

"2026-06-14"

loanAccountId · string · requerido

Loan account UUID.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

overpaymentAmount · string · requerido

Part of the payment that no instalment due on or before the effective date absorbed (2 d.p. string). It is not an excess over the whole balance: instalments due later take none of the payment, so paying ahead of the schedule lands here.

Ejemplo:

"0.00"

prepaidInstallment · object

The instalment this payment would cover ahead of the schedule, closing at its present value on its due date. Omitted when it would promise nothing.

Show child attributes