Obtener el descriptor de operación de crédito

Devuelve el descriptor de operación de crédito de la Res. CMN 5.004/2022, opcionalmente reconstruido a una fecha de negocio.

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

Obtener el descriptor de operación de crédito

cURL

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor \
  --header 'Authorization: Bearer <token>'

200

{
  "annualRate": "<string>",
  "asOfDate": "<string>",
  "cetAnnualPct": "<string>",
  "cetMonthlyPct": "<string>",
  "createdAt": "<string>",
  "descriptorDate": "<string>",
  "id": "<string>",
  "installmentCount": 123,
  "jurisdictionCode": "<string>",
  "loanAccountId": "<string>",
  "loanApplicationId": "<string>",
  "monthlyRate": "<string>",
  "originalTerm": 123,
  "outstandingBalance": "<string>",
  "overdueInstallmentCount": 123,
  "paidInstallmentCount": 123,
  "principalOutstanding": "<string>",
  "profileVersion": "<string>",
  "refreshedAt": "<string>",
  "status": "<string>",
  "totalCharges": "<string>",
  "totalTaxes": "<string>",
  "accrualState": "<string>",
  "consumerProtectionRegime": "<string>",
  "iofAmount": "<string>",
  "lastPaymentDate": "<string>",
  "nextDueDate": "<string>",
  "pddStage": "<string>",
  "prepaymentSettlementId": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · string<uuid> · requerido

Loan account identifier.

Parámetros de consulta

asOfDate · string<date>

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

Respuesta

200

application/json

OK

annualRate · string · requerido

Contractual nominal annual interest rate as a percentage decimal string.

Ejemplo:

"24.50"

asOfDate · string · requerido

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

Ejemplo:

"2026-06-14"

cetAnnualPct · string · requerido

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

Ejemplo:

"28.40"

cetMonthlyPct · string · requerido

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

Ejemplo:

"2.11"

createdAt · string · requerido

RFC3339 UTC timestamp when the descriptor record was created.

Ejemplo:

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

descriptorDate · string · requerido

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

Ejemplo:

"2026-06-14"

id · string · requerido

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

Ejemplo:

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

installmentCount · integer<int64> · requerido

Total number of installments in the amortization schedule.

Ejemplo:

24

jurisdictionCode · string · requerido

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

Ejemplo:

"BR"

loanAccountId · string · requerido

UUID of the loan account the descriptor summarizes.

Ejemplo:

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

loanApplicationId · string · requerido

UUID of the originating loan application.

Ejemplo:

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

monthlyRate · string · requerido

Contractual nominal monthly interest rate as a percentage decimal string.

Ejemplo:

"1.85"

originalTerm · integer<int64> · requerido

Original contracted term of the loan in number of installments.

Ejemplo:

24

outstandingBalance · string · requerido

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

Ejemplo:

"43250.75"

overdueInstallmentCount · integer<int64> · requerido

Number of installments currently past due.

Ejemplo:

1

paidInstallmentCount · integer<int64> · requerido

Number of installments fully paid to date.

Ejemplo:

6

principalOutstanding · string · requerido

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

Ejemplo:

"42000.00"

profileVersion · string · requerido

Jurisdiction profile version used to compute the descriptor.

Ejemplo:

"1.0.0"

refreshedAt · string · requerido

RFC3339 UTC timestamp when the descriptor figures were last refreshed.

Ejemplo:

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

status · string · requerido

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

Ejemplo:

"active"

totalCharges · string · requerido

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

Ejemplo:

"320.00"

totalTaxes · string · requerido

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

Ejemplo:

"86.84"

accrualState · string

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

Ejemplo:

"accruing"

consumerProtectionRegime · string

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

iofAmount · string

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

Ejemplo:

"50.34"

lastPaymentDate · string

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

Ejemplo:

"2026-06-14"

nextDueDate · string

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

Ejemplo:

"2026-06-14"

pddStage · string

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

Ejemplo:

"stage_1"

prepaymentSettlementId · string

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

Ejemplo:

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