Skip to main content
POST
Declare charge model revision

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 product version identifier.

Corpo

application/json
amount
string
obrigatório

Flat amount, decimal string, non-negative.

Exemplo:

"25.00"

chargeCode
string
obrigatório

Charge code carried onto every charge assessed from this model.

Minimum string length: 1
Exemplo:

"SERVICING_FEE"

chargeTemplateId
string
obrigatório

Operator-chosen key for this charge model. Charges are applied by naming it.

Required string length: 1 - 128
Exemplo:

"SERVICING_FEE"

chargeType
enum<string>
obrigatório

Charge type. Not a label: the Brazilian consumer-credit cap applies to late_fee and default_interest only, so a wrong type escapes its own ceiling.

Opções disponíveis:
late_fee,
default_interest,
origination_fee,
fee
Exemplo:

"fee"

currency
string
obrigatório

ISO 4217 currency code.

Required string length: 3
Exemplo:

"BRL"

effectiveFrom
string
obrigatório

Date this revision takes effect (RFC3339 or YYYY-MM-DD, UTC). Must be strictly after the newest revision of the same model on this version: a revision never reaches backwards into days already priced.

Exemplo:

"2026-04-01"

rate
string

Rate component, decimal string, non-negative. Defaults to 0.

Exemplo:

"0"

refundable
boolean

Whether early payoff gives this charge back pro-rata (CDC art. 52 par. 2), measured from the day it was assessed to the contract's final scheduled due date. ABSENT MEANS NOT REFUNDABLE: a charge earned when it was levied, such as a flat origination fee, must be left false. The assessed charge freezes this declaration, so revising the model never changes what is owed on a charge already levied.

Exemplo:

false

Resposta

Created

amount
string
obrigatório

Flat amount, decimal string.

Exemplo:

"25.00"

chargeCode
string
obrigatório

Charge code.

Exemplo:

"SERVICING_FEE"

chargeTemplateId
string
obrigatório

Operator-chosen key for this charge model.

Exemplo:

"SERVICING_FEE"

chargeType
string
obrigatório

Charge type.

Exemplo:

"fee"

currency
string
obrigatório

ISO 4217 currency code.

Exemplo:

"BRL"

effectiveFrom
string
obrigatório

Date this revision takes effect (RFC3339, UTC).

Exemplo:

"2026-04-01T00:00:00Z"

productVersionId
string
obrigatório

Product version this model belongs to (uuid).

Exemplo:

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

rate
string
obrigatório

Rate component, decimal string.

Exemplo:

"0"

refundable
boolean
obrigatório

Whether early payoff gives this charge back pro-rata.

Exemplo:

false