Pular para o conteúdo principal
POST
Preview repayment allocation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string<uuid>
obrigatório

Loan account identifier (UUID).

Exemplo:

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

Corpo

application/json
amount
string
obrigatório

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

Exemplo:

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

Exemplo:

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

Exemplo:

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

Resposta

OK

allocations
object[] | null
obrigatório

Per-installment allocation breakdown.

appliedAmount
string
obrigatório

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

Exemplo:

"125.00"

backdated
boolean
obrigatório

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

effectiveDate
string
obrigatório

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.

Exemplo:

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

loanAccountId
string
obrigatório

Loan account UUID.

Exemplo:

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

overpaymentAmount
string
obrigatório

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

Exemplo:

"0.00"