Skip to main content
POST
Aplicar encargo herdado do produto de empréstimo

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Canonical idempotency key for safe retries.

Exemplo:

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

Parâmetros de caminho

id
string<uuid>
obrigatório

Loan product identifier.

Exemplo:

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

Corpo

application/json
chargeEffectiveAt
string
obrigatório

Charge effective timestamp (RFC3339 or YYYY-MM-DD).

Exemplo:

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

chargeTemplateId
string
obrigatório

Charge template identifier.

loanAccountId
string<uuid>
obrigatório

Loan account identifier.

Exemplo:

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

productVersionId
string<uuid>
obrigatório

Product version identifier.

Exemplo:

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

accountCreatedAt
string

Loan account creation timestamp (RFC3339 or YYYY-MM-DD).

Exemplo:

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

Resposta

Created

accountCreatedAt
string
obrigatório

Loan account creation timestamp (RFC3339, UTC).

Exemplo:

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

amount
string
obrigatório

Charge amount as a decimal string in major currency units, fixed scale of 2 decimal places.

Exemplo:

"1234.56"

assessedAt
string
obrigatório

Timestamp the charge was assessed (RFC3339, UTC).

Exemplo:

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

chargeCode
string
obrigatório

Charge code resolved from the template.

Exemplo:

"LATE_FEE"

chargeTemplateId
string
obrigatório

Charge template the fact was derived from.

chargeType
string
obrigatório

Charge type resolved from the template.

currency
string
obrigatório

ISO 4217 currency code of the amount.

Exemplo:

"BRL"

loanAccountId
string
obrigatório

Loan account the charge was applied to (uuid).

Exemplo:

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

rate
string
obrigatório

Charge rate as a decimal string (fractional, e.g. "0.015" for 1.5%).

Exemplo:

"0.015"

sourceProductVersionId
string
obrigatório

Product version whose template produced this charge (uuid).

Exemplo:

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

regulatoryWarnings
string[] | null

Non-blocking regulatory warnings raised while assessing the charge.