Skip to main content
POST
Pré-visualizar a alocação de pagamento

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

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

Exemplo:

"2026-06-14"

transactionDate
string

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

Exemplo:

"2026-06-14"

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

ISO-8601 effective date applied to this preview.

Exemplo:

"2026-06-14"

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"