v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

LoanProducts

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

Path parameters

idstring uuid required

Loan product identifier.

Example:550e8400-e29b-41d4-a716-446655440000

Loan product identifier.

Headers

X-Idempotencystring required

Canonical idempotency key for safe retries.

Example:550e8400-e29b-41d4-a716-446655440004

Canonical idempotency key for safe retries.

Request body

accountCreatedAtstring

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

chargeEffectiveAtstring required

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

chargeTemplateIdstring required

Charge template identifier.

loanAccountIdstring uuid required

Loan account identifier.

productVersionIdstring uuid required

Product version identifier.

Example request

{
  "accountCreatedAt": "2026-06-14T12:00:00Z",
  "chargeEffectiveAt": "2026-06-14T12:00:00Z",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440005",
  "productVersionId": "550e8400-e29b-41d4-a716-446655440001"
}

Response

Created

accountCreatedAtstring required

Loan account creation timestamp (RFC3339, UTC).

amountstring required

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

assessedAtstring required

Timestamp the charge was assessed (RFC3339, UTC).

chargeCodestring required

Charge code resolved from the template.

chargeTemplateIdstring required

Charge template the fact was derived from.

chargeTypestring required

Charge type resolved from the template.

currencystring required

ISO 4217 currency code of the amount.

loanAccountIdstring required

Loan account the charge was applied to (uuid).

ratestring required

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

regulatoryWarningsstring[] nullable

Non-blocking regulatory warnings raised while assessing the charge.

sourceProductVersionIdstring required

Product version whose template produced this charge (uuid).

Example response

{
  "accountCreatedAt": "2026-06-14T12:00:00Z",
  "amount": "1234.56",
  "assessedAt": "2026-06-14T12:00:00Z",
  "chargeCode": "LATE_FEE",
  "currency": "BRL",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440005",
  "rate": "0.015",
  "sourceProductVersionId": "550e8400-e29b-41d4-a716-446655440001"
}