v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

LoanProducts

Create loan product version

Creates a new version snapshot of a loan product with updated regulatory parameters.

post/api/v1/loan-products/{id}/versions

Path parameters

idstring uuid required

Loan product identifier.

Request body

changeReasonstring required

Reason for the new version.

currencystring required

ISO 4217 currency code the product version denominates (3 uppercase letters); the loan's currency source of truth.

fixedAnnualRateBpsinteger

Fixed annual rate in basis points.

floatingRateTableIdstring

Floating-rate table identifier.

floatingSpreadBpsinteger

Floating spread in basis points.

jurisdictionCodestring required

Jurisdiction profile code.

jurisdictionExtensionsobject

Opaque per-jurisdiction version fields.

rateModestring

Rate mode (fixed|floating).

requiresFloatingRateboolean

Whether a floating-rate table is required.

Example request

{
  "currency": "BRL",
  "fixedAnnualRateBps": 1850,
  "floatingRateTableId": "550e8400-e29b-41d4-a716-446655440002",
  "floatingSpreadBps": 1850,
  "jurisdictionCode": "BR",
  "rateMode": "fixed"
}

Response

Created

changeReasonstring required

Reason recorded for creating this version.

createdAtstring required

Creation timestamp (RFC3339, UTC).

currencystring required

ISO 4217 currency code the product version denominates (3 uppercase letters).

fixedAnnualRateBpsinteger required

Fixed annual rate in basis points (1 bps = 0.01%).

floatingRateTableIdstring

Linked floating-rate table identifier (uuid); empty in fixed mode.

floatingSpreadBpsinteger required

Floating spread in basis points (1 bps = 0.01%).

idstring required

Server-assigned version identifier (uuid).

jurisdictionCodestring required

Jurisdiction profile code (e.g. BR).

jurisdictionExtensionsobject

Opaque per-jurisdiction version fields, echoed from the request for traceability.

productIdstring required

Owning loan product identifier (uuid).

rateModestring required

Rate mode (fixed|floating).

requiresFloatingRateboolean required

Whether a floating-rate table is required for this version.

Example response

{
  "createdAt": "2026-06-14T12:00:00Z",
  "currency": "BRL",
  "fixedAnnualRateBps": 1850,
  "floatingRateTableId": "550e8400-e29b-41d4-a716-446655440002",
  "floatingSpreadBps": 1850,
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "jurisdictionCode": "BR",
  "productId": "550e8400-e29b-41d4-a716-446655440000",
  "rateMode": "fixed"
}