Get credit operation descriptor
Returns the Res. CMN 5.004/2022 credit operation descriptor, optionally reconstructed as of a business date.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
Loan account identifier.
Query Parameters
Optional as-of date (YYYY-MM-DD) to reconstruct the descriptor.
Response
OK
Contractual nominal annual interest rate as a percentage decimal string.
"24.50"
Valuation date the financial figures are reconstructed as of (YYYY-MM-DD, UTC).
"2026-06-14"
Custo Efetivo Total, annualized, as a percentage decimal string.
"28.40"
Custo Efetivo Total, monthly, as a percentage decimal string.
"2.11"
RFC3339 UTC timestamp when the descriptor record was created.
"2026-06-14T12:00:00Z"
Date the descriptor snapshot was generated (YYYY-MM-DD, UTC).
"2026-06-14"
Unique identifier (UUID) of the credit operation descriptor snapshot.
"550e8400-e29b-41d4-a716-446655440000"
Total number of installments in the amortization schedule.
24
ISO jurisdiction code governing the descriptor (e.g. "BR").
"BR"
UUID of the loan account the descriptor summarizes.
"550e8400-e29b-41d4-a716-446655440001"
UUID of the originating loan application.
"550e8400-e29b-41d4-a716-446655440002"
Contractual nominal monthly interest rate as a percentage decimal string.
"1.85"
Original contracted term of the loan in number of installments.
24
Total outstanding balance (principal plus accrued charges) as a decimal string, scale 2.
"43250.75"
Number of installments currently past due.
1
Number of installments fully paid to date.
6
Outstanding principal as a decimal string in major currency units, scale 2.
"42000.00"
Jurisdiction profile version used to compute the descriptor.
"1.0.0"
RFC3339 UTC timestamp when the descriptor figures were last refreshed.
"2026-06-14T12:00:00Z"
Lifecycle status of the credit operation (e.g. active, settled).
"active"
Cumulative fees and charges as a decimal string in major currency units, scale 2.
"320.00"
Cumulative taxes as a decimal string in major currency units, scale 2.
"86.84"
Interest accrual state: accruing or suspended; omitted when not set.
"accruing"
Applicable consumer-protection regime label; omitted when not classified.
IOF (Imposto sobre Operacoes Financeiras) amount as a decimal string, scale 2; omitted when not applicable.
"50.34"
Date of the most recent payment received (YYYY-MM-DD, UTC); omitted if no payment recorded.
"2026-06-14"
Due date of the next scheduled installment (YYYY-MM-DD, UTC); omitted if none pending.
"2026-06-14"
Current PDD delinquency staging: one of current, stage_1, stage_2, stage_3; omitted when unstaged.
"stage_1"
UUID of the prepayment settlement that closed the operation; omitted unless settled via prepayment.
"550e8400-e29b-41d4-a716-446655440003"

