Skip to main content
POST
Preview repayment allocation

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

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.

Example:

"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.

Example:

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

Response

OK

allocations
object[] | null
required

Per-installment allocation breakdown.

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

RFC 3339 instant the money moved, used for this preview. A bare calendar date is refused (LENDER-0103 is the charge equivalent; this route answers LENDER-0348): the day a payment belongs to is derived from the moment, so the moment is what the caller declares.

Example:

"2026-06-14T21:00:00Z"

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"