Declare charge model revision

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
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates"

	payload := strings.NewReader("{\n  \"amount\": \"25.00\",\n  \"chargeCode\": \"SERVICING_FEE\",\n  \"chargeTemplateId\": \"SERVICING_FEE\",\n  \"chargeType\": \"fee\",\n  \"currency\": \"BRL\",\n  \"effectiveFrom\": \"2026-04-01\",\n  \"rate\": \"0\",\n  \"refundable\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '25.00',
    chargeCode: 'SERVICING_FEE',
    chargeTemplateId: 'SERVICING_FEE',
    chargeType: 'fee',
    currency: 'BRL',
    effectiveFrom: '2026-04-01',
    rate: '0',
    refundable: false
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates"

payload = {
    "amount": "25.00",
    "chargeCode": "SERVICING_FEE",
    "chargeTemplateId": "SERVICING_FEE",
    "chargeType": "fee",
    "currency": "BRL",
    "effectiveFrom": "2026-04-01",
    "rate": "0",
    "refundable": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

api

loan-product-versions

{id}

charge-templates

Declare charge model revision

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
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates"

	payload := strings.NewReader("{\n  \"amount\": \"25.00\",\n  \"chargeCode\": \"SERVICING_FEE\",\n  \"chargeTemplateId\": \"SERVICING_FEE\",\n  \"chargeType\": \"fee\",\n  \"currency\": \"BRL\",\n  \"effectiveFrom\": \"2026-04-01\",\n  \"rate\": \"0\",\n  \"refundable\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '25.00',
    chargeCode: 'SERVICING_FEE',
    chargeTemplateId: 'SERVICING_FEE',
    chargeType: 'fee',
    currency: 'BRL',
    effectiveFrom: '2026-04-01',
    rate: '0',
    refundable: false
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-product-versions/{id}/charge-templates"

payload = {
    "amount": "25.00",
    "chargeCode": "SERVICING_FEE",
    "chargeTemplateId": "SERVICING_FEE",
    "chargeType": "fee",
    "currency": "BRL",
    "effectiveFrom": "2026-04-01",
    "rate": "0",
    "refundable": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string<uuid>

required

Loan product version identifier.

Body

application/json

amount

string

required

Flat amount, decimal string, non-negative.

Example:

"25.00"

chargeCode

string

required

Charge code carried onto every charge assessed from this model.

Minimum string length: 1

Example:

"SERVICING_FEE"

chargeTemplateId

string

required

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

Required string length: 1 - 128

Example:

"SERVICING_FEE"

chargeType

enum<string>

required

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.

Available options:

late_fee,

default_interest,

origination_fee,

fee

Example:

"fee"

currency

string

required

ISO 4217 currency code.

Required string length: 3

Example:

"BRL"

effectiveFrom

string

required

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.

Example:

"2026-04-01"

rate

string

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

Example:

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

Example:

false

Response

Created

amount

string

required

Flat amount, decimal string.

Example:

"25.00"

chargeCode

string

required

Charge code.

Example:

"SERVICING_FEE"

chargeTemplateId

string

required

Operator-chosen key for this charge model.

Example:

"SERVICING_FEE"

chargeType

string

required

Charge type.

Example:

"fee"

currency

string

required

ISO 4217 currency code.

Example:

"BRL"

effectiveFrom

string

required

Date this revision takes effect (RFC3339, UTC).

Example:

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

productVersionId

string

required

Product version this model belongs to (uuid).

Example:

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

rate

string

required

Rate component, decimal string.

Example:

"0"

refundable

boolean

required

Whether early payoff gives this charge back pro-rata.

Example:

false

Brazil loan products

Consignado operations

Loan product lifecycle

Product versions

Product configuration

Floating-rate tables

Document templates

Loan Applications

Credit instruments

Regulatory disclosures and risk

Payoff and prepayment

Account overview and audit

Charges and schedule

Repayments

Transactions

Returned payment receivables

Assignment funds

Assignment sets

Assignment exceptions and registry

Accounting

Portfolio dashboards

Jurisdictions

Tax

Session

Streaming

Error handling

Events

Declare charge model revision

Authorizations

Path Parameters

Body

Response