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.

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": "<string>",
  "effectiveDate": "<string>",
  "transactionDate": "<string>"
}
'

200

{
  "allocations": [
    {
      "dueDate": "<string>",
      "feesAmount": "<string>",
      "fullyPaid": true,
      "installmentNumber": 123,
      "interestAmount": "<string>",
      "penaltiesAmount": "<string>",
      "principalAmount": "<string>",
      "totalAmount": "<string>"
    }
  ],
  "appliedAmount": "<string>",
  "backdated": true,
  "effectiveDate": "<string>",
  "loanAccountId": "<string>",
  "overpaymentAmount": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string<uuid> · required

Loan account identifier (UUID).

Example:

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

Body

application/json

amount · string · required

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

Example:

"125.00"

effectiveDate · string

ISO-8601 or YYYY-MM-DD effective date.

Example:

"2026-06-14"

transactionDate · string

ISO-8601 or YYYY-MM-DD transaction date (fallback when effectiveDate is absent).

Example:

"2026-06-14"

Response

200

application/json

OK

allocations · object[] | null · required

Per-installment allocation breakdown.

Show child attributes

appliedAmount · string · required

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

Example:

"125.00"

backdated · boolean · required

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

effectiveDate · string · required

ISO-8601 effective date applied to this preview.

Example:

"2026-06-14"

loanAccountId · string · required

Loan account UUID.

Example:

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

overpaymentAmount · string · required

Excess amount above total outstanding (2 d.p. string).

Example:

"0.00"