---
title: "Create prepayment quote"
method: POST
path: "/api/v1/br/loan-accounts/{id}/prepayment-quote"
tags: ["Loan Accounts"]
---

# Create prepayment quote

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

## Request

- Base URL: `https://identity.sandbox.lerian.net`
- URL: `https://identity.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote`
- Auth: none required
- TypeScript: <https://skmtc.dev/lerian/apis/identity-plugin/docs/api/v1/br/loan-accounts/:id/prepayment-quote/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `id` string, uuid, required: Loan account identifier.

## Request body

- union
  - PartialPrepaymentQuoteRequest
    - `amount` string, required: Prepayment amount in major currency units (e.g. "100.00").
    - `businessDate` string: Optional valuation date (RFC3339 or YYYY-MM-DD); defaults to now (UTC).
    - `quoteType` 'partial', required: Discriminator: partial principal prepayment.
  - FullSettlementPrepaymentQuoteRequest
    - `businessDate` string: Optional valuation date (RFC3339 or YYYY-MM-DD); defaults to now (UTC).
    - `instrumentType` 'pix' | 'boleto', required: Borrower payment rail.
    - `overridePdd` boolean: When true, overrides the PDD stage gate during quote generation.
    - `quoteType` 'full_settlement', required: Discriminator: full settlement of the outstanding balance.

## Response `201`

Created

- PrepaymentQuoteResponse
  - `acceptedAt` string: RFC3339 UTC timestamp when the quote was accepted; empty while still pending.
  - `acceptedTransactionId` string: Identifier of the settlement transaction that accepted the quote; empty while still pending.
  - `chargeRebate` string, required: Rebate of unaccrued charges and fees credited on prepayment, as a decimal string, scale 2.
  - `consumerProtectionRegime` string, required: Consumer-protection regime label applied to the prepayment terms.
  - `createdAt` string, required: RFC3339 UTC timestamp when the quote was created.
  - `currency` string, required: ISO 4217 currency code of the loan and quote.
  - `expiresAt` string, required: RFC3339 UTC timestamp after which the quote is no longer valid.
  - `grossAmount` string, required: Retired settlement principal being paid off (equals the outstanding principal for a full settlement), as a decimal string, scale 2.
  - `id` string, required: Unique identifier (UUID) of the prepayment quote.
  - `interestRebate` string, required: Mandatory interest rebate (juros nao incorridos) credited on prepayment, as a decimal string, scale 2.
  - `iofReconciliation` string, required: IOF adjustment as a decimal string, scale 2. Defined-principal loans report zero because IOF is not refunded on early payoff.
  - `jurisdictionCode` string, required: ISO jurisdiction code governing the quote (e.g. "BR").
  - `loanAccountId` string, required: UUID of the loan account the quote was generated for.
  - `netSettlementAmount` string, 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.
  - `principalOutstanding` string, required: Outstanding principal at quote time as a decimal string in major currency units, scale 2.
  - `profileVersion` string, required: Jurisdiction profile version used to compute the quote.
  - `quoteType` string, required: Quote variant: partial (principal prepayment) or full_settlement.
  - `rebateMandatory` boolean, required: True when regulation mandates applying the interest rebate to this quote.
  - `slaDueAt` string: RFC3339 UTC full-settlement SLA deadline; omitted for partial quotes.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/lerian/apis/identity-plugin.md) - [All operations](https://skmtc.dev/lerian/apis/identity-plugin/llms.txt) - [OpenAPI document](https://skmtc.dev/lerian/apis/identity-plugin/revisions/25daba385532?raw)