Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Loan Accounts

Get credit operation descriptor

Returns the Res. CMN 5.004/2022 credit operation descriptor, optionally reconstructed as of a business date.

get/api/v1/br/loan-accounts/{id}/credit-descriptor

Path parameters

idstring uuid required

Loan account identifier.

Loan account identifier.

Query parameters

asOfDatestring date

Optional as-of date (YYYY-MM-DD) to reconstruct the descriptor.

Optional as-of date (YYYY-MM-DD) to reconstruct the descriptor.

Response

OK

accrualStatestring

Interest accrual state: accruing or suspended; omitted when not set.

annualRatestring required

Contractual nominal annual interest rate as a percentage decimal string.

asOfDatestring required

Valuation date the financial figures are reconstructed as of (YYYY-MM-DD, UTC).

cetAnnualPctstring required

Custo Efetivo Total, annualized, as a percentage decimal string.

cetMonthlyPctstring required

Custo Efetivo Total, monthly, as a percentage decimal string.

consumerProtectionRegimestring

Applicable consumer-protection regime label; omitted when not classified.

createdAtstring required

RFC3339 UTC timestamp when the descriptor record was created.

descriptorDatestring required

Date the descriptor snapshot was generated (YYYY-MM-DD, UTC).

idstring required

Unique identifier (UUID) of the credit operation descriptor snapshot.

installmentCountinteger required

Total number of installments in the amortization schedule.

iofAmountstring

IOF (Imposto sobre Operacoes Financeiras) amount as a decimal string, scale 2; omitted when not applicable.

jurisdictionCodestring required

ISO jurisdiction code governing the descriptor (e.g. "BR").

lastPaymentDatestring

Date of the most recent payment received (YYYY-MM-DD, UTC); omitted if no payment recorded.

loanAccountIdstring required

UUID of the loan account the descriptor summarizes.

loanApplicationIdstring required

UUID of the originating loan application.

monthlyRatestring required

Contractual nominal monthly interest rate as a percentage decimal string.

nextDueDatestring

Due date of the next scheduled installment (YYYY-MM-DD, UTC); omitted if none pending.

originalTerminteger required

Original contracted term of the loan in number of installments.

outstandingBalancestring required

Total outstanding balance (principal plus accrued charges) as a decimal string, scale 2.

overdueInstallmentCountinteger required

Number of installments currently past due.

paidInstallmentCountinteger required

Number of installments fully paid to date.

pddStagestring

Current PDD delinquency staging: one of current, stage_1, stage_2, stage_3; omitted when unstaged.

prepaymentSettlementIdstring

UUID of the prepayment settlement that closed the operation; omitted unless settled via prepayment.

principalOutstandingstring required

Outstanding principal as a decimal string in major currency units, scale 2.

profileVersionstring required

Jurisdiction profile version used to compute the descriptor.

refreshedAtstring required

RFC3339 UTC timestamp when the descriptor figures were last refreshed.

statusstring required

Lifecycle status of the credit operation (e.g. active, settled).

totalChargesstring required

Cumulative fees and charges as a decimal string in major currency units, scale 2.

totalTaxesstring required

Cumulative taxes as a decimal string in major currency units, scale 2.

Example response

{
  "accrualState": "accruing",
  "annualRate": "24.50",
  "asOfDate": "2026-06-14",
  "cetAnnualPct": "28.40",
  "cetMonthlyPct": "2.11",
  "createdAt": "2026-06-14T12:00:00Z",
  "descriptorDate": "2026-06-14",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "installmentCount": 24,
  "iofAmount": "50.34",
  "jurisdictionCode": "BR",
  "lastPaymentDate": "2026-06-14",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440001",
  "loanApplicationId": "550e8400-e29b-41d4-a716-446655440002",
  "monthlyRate": "1.85",
  "nextDueDate": "2026-06-14",
  "originalTerm": 24,
  "outstandingBalance": "43250.75",
  "overdueInstallmentCount": 1,
  "paidInstallmentCount": 6,
  "pddStage": "stage_1",
  "prepaymentSettlementId": "550e8400-e29b-41d4-a716-446655440003",
  "principalOutstanding": "42000.00",
  "profileVersion": "1.0.0",
  "refreshedAt": "2026-06-14T12:00:00Z",
  "status": "active",
  "totalCharges": "320.00",
  "totalTaxes": "86.84"
}