Skip to main content
POST
Criar cotação de pré-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.

Corpo

application/json
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"

Resposta

Created

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"

grossAmount
string
obrigatório

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

Exemplo:

"42000.00"

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) credited on prepayment, as a decimal string, scale 2.

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"

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

Exemplo:

"41880.00"

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"

slaDueAt
string

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

Exemplo:

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