Declare charge model revision

Declares one effective-dated revision of a charge model on a product version. Attaching a model to a version that already carries live contracts is allowed and is the point of the table being dated: the revision takes effect from its own date forward and never rewrites a charge already assessed.

POST /api/v1/loan-product-versions/{id}/charge-templates

Declare charge model revision

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "25.00",
  "chargeCode": "SERVICING_FEE",
  "chargeTemplateId": "SERVICING_FEE",
  "chargeType": "fee",
  "currency": "BRL",
  "effectiveFrom": "2026-04-01",
  "rate": "0",
  "refundable": false
}
'

201

{
  "amount": "25.00",
  "chargeCode": "SERVICING_FEE",
  "chargeTemplateId": "SERVICING_FEE",
  "chargeType": "fee",
  "currency": "BRL",
  "effectiveFrom": "2026-04-01T00:00:00Z",
  "productVersionId": "550e8400-e29b-41d4-a716-446655440001",
  "rate": "0",
  "refundable": false
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · string<uuid> · requerido

Loan product version identifier.

Cuerpo

application/json

amount · string · requerido

Flat amount, decimal string, non-negative. A late_fee or default_interest the version's CDC regime caps carries none: it is a rate no higher than the cap (LENDER-0116).

Ejemplo:

"25.00"

chargeCode · string · requerido

Charge code carried onto every charge assessed from this model.

Minimum string length: 1

Ejemplo:

"SERVICING_FEE"

chargeTemplateId · string · requerido

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

Required string length: 1 - 128

Ejemplo:

"SERVICING_FEE"

chargeType · enum<string> · requerido

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. Every revision of a chargeTemplateId keeps the type of its earlier revisions. origination_fee: retained at every direct-credit release; one template per version, new revisions under the same chargeTemplateId, each in force from the Brazilian civil day its effectiveFrom falls on; amount is the fixed part per release, rate the fraction of the release's gross (0.02 is 2%); never refundable; the version's currency; the version must accrue by effective interest.

Opciones disponibles: late_fee, default_interest, origination_fee, fee

Ejemplo:

"fee"

currency · string · requerido

ISO 4217 currency code.

Required string length: 3

Ejemplo:

"BRL"

effectiveFrom · string · requerido

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.

Ejemplo:

"2026-04-01"

rate · string

Rate component, decimal string, non-negative, as a fraction (0.02 is 2%). Defaults to 0.

Ejemplo:

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

Ejemplo:

false

Respuesta

201

application/json

Created

amount · string · requerido

Flat amount, decimal string.

Ejemplo:

"25.00"

chargeCode · string · requerido

Charge code.

Ejemplo:

"SERVICING_FEE"

chargeTemplateId · string · requerido

Operator-chosen key for this charge model.

Ejemplo:

"SERVICING_FEE"

chargeType · string · requerido

Charge type.

Ejemplo:

"fee"

currency · string · requerido

ISO 4217 currency code.

Ejemplo:

"BRL"

effectiveFrom · string · requerido

Date this revision takes effect (RFC3339, UTC).

Ejemplo:

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

productVersionId · string · requerido

Product version this model belongs to (uuid).

Ejemplo:

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

rate · string · requerido

Rate component, decimal string.

Ejemplo:

"0"

refundable · boolean · requerido

Whether early payoff gives this charge back pro-rata.

Ejemplo:

false