Create prepayment quote

Creates a time-limited, auditable prepayment quote with settlement and rebate breakdown. A full-settlement quote issues its payer a pix or boleto charge, so it is refused with 409 (LENDER-0375) while another full-settlement quote on the contract is neither accepted nor expired and its charge is neither cancelled nor refused. An outdated calculation does not release that charge. That refusal’s problem document carries liveQuoteId and liveQuoteExpiresAt, the quote whose payoff statement to show instead; quote again under a new X-Idempotency once it ends. A quote valued on a São Paulo civil day before the contract’s disbursement is refused with 422 (LENDER-0985). A payoff priced before the contract moved is refused with 409 (LENDER-0353 or 0354). The single-live rule applies across all payoff channels, including portability. A partial quote issues no charge, so the single-live rule never refuses it. A full-settlement quote waits up to five seconds on another write to the same contract or on a running month close, and is refused past it with 409 (LENDER-0370): retry it under the same X-Idempotency.

POST /api/v1/br/loan-accounts/{id}/prepayment-quote

Create prepayment quote

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "42000.00",
  "quoteType": "partial",
  "businessDate": "2026-06-14",
  "overridePdd": true
}
'

201

{
  "accruedInterest": "111.74",
  "arrearsFees": "0.00",
  "arrearsInterest": "0.00",
  "arrearsLateCharges": "7.00",
  "arrearsPrincipal": "300.00",
  "chargeRebate": "120.00",
  "consumerProtectionRegime": "<string>",
  "createdAt": "2026-06-14T12:00:00Z",
  "currency": "BRL",
  "expiresAt": "2026-06-14T12:00:00Z",
  "fees": "25.00",
  "grossAmount": "42000.00",
  "heldCashApplied": "507.27",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interestRebate": "1250.75",
  "iofReconciliation": "0.00",
  "jurisdictionCode": "BR",
  "lateCharges": "7.00",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440001",
  "netSettlementAmount": "41992.23",
  "principalOutstanding": "42000.00",
  "profileVersion": "1.0.0",
  "quoteType": "partial",
  "rebateMandatory": true,
  "acceptedAt": "2026-06-14T12:00:00Z",
  "acceptedTransactionId": "550e8400-e29b-41d4-a716-446655440002",
  "payoffPurpose": "portability",
  "slaDueAt": "2026-06-19T12:00:00Z"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency · string · obrigatório

Canonical idempotency request ID. Required: a full-settlement quote issues a payment demand to the borrower, so without a key a retry cannot be told apart from a second demand.

Parâmetros de caminho

id · string<uuid> · obrigatório

Loan account identifier.

Corpo

application/json

Option 1

Option 2

amount · string · obrigatório

Prepayment amount in major currency units (e.g. "100.00").

Exemplo:

"42000.00"

quoteType · enum<string> · obrigatório

Discriminator: partial principal prepayment.

Opções disponíveis: partial

businessDate · string

Optional valuation date (RFC3339 or YYYY-MM-DD); defaults to now (UTC).

Exemplo:

"2026-06-14"

overridePdd · boolean

When true, overrides the PDD stage gate during quote generation.

Resposta

201

application/json

Created

accruedInterest · string · obrigatório

Interest a full settlement charges on top of the principal up to the payoff day: accrued and unpaid, less what a standing automatic-prepayment promise earned by then, as the payment that promised an instalment counts at its present value that day; zero on a partial. Decimal string, scale 2.

Exemplo:

"111.74"

arrearsFees · string · obrigatório

Fees of the instalments due on or before the valuation day, paid first by a partial prepayment; zero on a full settlement. Decimal string, scale 2.

Exemplo:

"0.00"

arrearsInterest · string · obrigatório

Interest of the instalments due on or before the valuation day, paid first by a partial prepayment; zero on a full settlement. Decimal string, scale 2.

Exemplo:

"0.00"

arrearsLateCharges · string · obrigatório

Late fine and mora of the instalments due on or before the valuation day, paid first by a partial prepayment; zero on a full settlement. Decimal string, scale 2.

Exemplo:

"7.00"

arrearsPrincipal · string · obrigatório

Principal of the instalments due on or before the valuation day, which a partial prepayment pays before retiring principal; zero on a full settlement and when nothing is due. Decimal string, scale 2.

Exemplo:

"300.00"

chargeRebate · string · obrigatório

Rebate of unaccrued charges and fees credited on prepayment, as a decimal string, scale 2.

Exemplo:

"120.00"

consumerProtectionRegime · string · obrigatório

Consumer-protection regime label applied to the prepayment terms.

createdAt · string · obrigatório

RFC3339 UTC timestamp when the quote was created.

Exemplo:

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

currency · string · obrigatório

ISO 4217 currency code of the loan and quote.

Exemplo:

"BRL"

expiresAt · string · obrigatório

RFC3339 UTC timestamp after which the quote is no longer valid.

Exemplo:

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

fees · string · obrigatório

Applied charges the schedule holds open on the payoff day, charged on top of the principal on a full settlement; zero on a partial, whose charges stay on the instalments that bill them. Decimal string, scale 2.

Exemplo:

"25.00"

grossAmount · string · obrigatório

Retired settlement principal being paid off (equals the outstanding principal for a full settlement; on a partial, the principal retired once the arrears are paid), as a decimal string, scale 2.

Exemplo:

"42000.00"

heldCashApplied · string · obrigatório

Cash the contract already holds, paid ahead of its due dates, that the prepayment spends before asking the borrower for the rest: on a partial at most the amount asked, the rest staying held for the due dates, and on an automatic-prepayment version never the present value already promised to an instalment. Decimal string, scale 2.

Exemplo:

"507.27"

id · string · obrigatório

Unique identifier (UUID) of the prepayment quote.

Exemplo:

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

interestRebate · string · obrigatório

Mandatory interest rebate (juros nao incorridos) disclosed on prepayment, as a decimal string, scale 2. On a full settlement it is the interest not yet incurred on the payoff day.

Exemplo:

"1250.75"

iofReconciliation · string · obrigatório

IOF adjustment as a decimal string, scale 2. Defined-principal loans report zero because IOF is not refunded on early payoff.

Exemplo:

"0.00"

jurisdictionCode · string · obrigatório

ISO jurisdiction code governing the quote (e.g. "BR").

Exemplo:

"BR"

lateCharges · string · obrigatório

Late fine and mora open on the payoff day, charged on top of the principal on a full settlement; zero on a partial. Decimal string, scale 2.

Exemplo:

"7.00"

loanAccountId · string · obrigatório

UUID of the loan account the quote was generated for.

Exemplo:

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

netSettlementAmount · string · obrigatório

Net cash payable to settle: gross settlement principal plus accrued interest, late charges and applied charges, minus charge rebate, plus any IOF due, plus on a partial the arrears it pays first, minus the held cash it spends, never below zero, as a decimal string, scale 2. At zero the borrower pays nothing and a full settlement issues no charge; held cash above a payoff is owed back on the payoff refund desk. Interest rebate is disclosure-only; defined-principal loans report zero IOF reconciliation because IOF is not refunded.

Exemplo:

"41992.23"

principalOutstanding · string · obrigatório

Outstanding principal at quote time as a decimal string in major currency units, scale 2.

Exemplo:

"42000.00"

profileVersion · string · obrigatório

Jurisdiction profile version used to compute the quote.

Exemplo:

"1.0.0"

quoteType · string · obrigatório

Quote variant: partial (principal prepayment) or full_settlement.

Exemplo:

"partial"

rebateMandatory · boolean · obrigatório

True when regulation mandates applying the interest rebate to this quote.

acceptedAt · string

RFC3339 UTC timestamp when the quote was accepted; empty while still pending.

Exemplo:

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

acceptedTransactionId · string

Identifier of the settlement transaction that accepted the quote; empty while still pending.

Exemplo:

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

payoffPurpose · string

Who pays this frozen payoff: borrower_prepayment or portability. Omitted when the quote does not state one.

Exemplo:

"portability"

slaDueAt · string

RFC3339 UTC full-settlement SLA deadline; omitted for partial quotes.

Exemplo:

"2026-06-19T12:00:00Z"