Apply inherited loan product charge

Applies one product-version charge template to a loan account and persists an immutable charge fact.

POST /api/v1/loan-products/{id}/charges

Apply inherited loan product charge

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-products/{id}/charges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "chargeEffectiveAt": "<string>",
  "chargeTemplateId": "<string>",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountCreatedAt": "<string>"
}
'

201

{
  "accountCreatedAt": "<string>",
  "amount": "<string>",
  "assessedAt": "<string>",
  "chargeCode": "<string>",
  "chargeTemplateId": "<string>",
  "chargeType": "<string>",
  "currency": "<string>",
  "loanAccountId": "<string>",
  "rate": "<string>",
  "sourceProductVersionId": "<string>",
  "regulatoryWarnings": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string · required

Canonical idempotency key for safe retries.

Example:

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

Path Parameters

id · string<uuid> · required

Loan product identifier.

Example:

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

Body

application/json

chargeEffectiveAt · string · required

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

Example:

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

chargeTemplateId · string · required

Charge template identifier.

loanAccountId · string<uuid> · required

Loan account identifier.

Example:

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

productVersionId · string<uuid> · required

Product version identifier.

Example:

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

accountCreatedAt · string

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

Example:

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

Response

201

application/json

Created

accountCreatedAt · string · required

Loan account creation timestamp (RFC3339, UTC).

Example:

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

amount · string · required

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

Example:

"1234.56"

assessedAt · string · required

Timestamp the charge was assessed (RFC3339, UTC).

Example:

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

chargeCode · string · required

Charge code resolved from the template.

Example:

"LATE_FEE"

chargeTemplateId · string · required

Charge template the fact was derived from.

chargeType · string · required

Charge type resolved from the template.

currency · string · required

ISO 4217 currency code of the amount.

Example:

"BRL"

loanAccountId · string · required

Loan account the charge was applied to (uuid).

Example:

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

rate · string · required

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

Example:

"0.015"

sourceProductVersionId · string · required

Product version whose template produced this charge (uuid).

Example:

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

regulatoryWarnings · string[] | null

Non-blocking regulatory warnings raised while assessing the charge.