Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Loan Accounts

Create prepayment quote

Creates a time-limited, auditable prepayment quote with settlement and rebate breakdown.

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

Path parameters

idstring uuid required

Loan account identifier.

Loan account identifier.

Request body

OR

Example request

{
  "amount": "42000.00",
  "businessDate": "2026-06-14"
}

Response

Created

acceptedAtstring

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

acceptedTransactionIdstring

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

chargeRebatestring required

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

consumerProtectionRegimestring required

Consumer-protection regime label applied to the prepayment terms.

createdAtstring required

RFC3339 UTC timestamp when the quote was created.

currencystring required

ISO 4217 currency code of the loan and quote.

expiresAtstring required

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

grossAmountstring required

Retired settlement principal being paid off (equals the outstanding principal for a full settlement), as a decimal string, scale 2.

idstring required

Unique identifier (UUID) of the prepayment quote.

interestRebatestring required

Mandatory interest rebate (juros nao incorridos) credited on prepayment, as a decimal string, scale 2.

iofReconciliationstring required

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

jurisdictionCodestring required

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

loanAccountIdstring required

UUID of the loan account the quote was generated for.

netSettlementAmountstring required

Net cash payable to settle: gross settlement principal minus charge rebate plus any IOF due, as a decimal string, scale 2. Interest rebate is disclosure-only; defined-principal loans report zero IOF reconciliation because IOF is not refunded.

principalOutstandingstring required

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

profileVersionstring required

Jurisdiction profile version used to compute the quote.

quoteTypestring required

Quote variant: partial (principal prepayment) or full_settlement.

rebateMandatoryboolean required

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

slaDueAtstring

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

Example response

{
  "acceptedAt": "2026-06-14T12:00:00Z",
  "acceptedTransactionId": "550e8400-e29b-41d4-a716-446655440002",
  "chargeRebate": "120.00",
  "createdAt": "2026-06-14T12:00:00Z",
  "currency": "BRL",
  "expiresAt": "2026-06-14T12:00:00Z",
  "grossAmount": "42000.00",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interestRebate": "1250.75",
  "iofReconciliation": "0.00",
  "jurisdictionCode": "BR",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440001",
  "netSettlementAmount": "41880.00",
  "principalOutstanding": "42000.00",
  "profileVersion": "1.0.0",
  "quoteType": "partial",
  "slaDueAt": "2026-06-19T12:00:00Z"
}