Pular para o conteúdo principal
GET
/
api
/
v1
/
br
/
loan-accounts
/
{id}
/
credit-descriptor
Obter descritor de operação de crédito
curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string<uuid>
obrigatório

Loan account identifier.

Parâmetros de consulta

asOfDate
string<date>

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

Resposta

OK

annualRate
string
obrigatório

Contractual nominal annual interest rate as a percentage decimal string.

Exemplo:

"24.50"

asOfDate
string
obrigatório

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

Exemplo:

"2026-06-14"

cetAnnualPct
string
obrigatório

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

Exemplo:

"28.40"

cetMonthlyPct
string
obrigatório

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

Exemplo:

"2.11"

createdAt
string
obrigatório

RFC3339 UTC timestamp when the descriptor record was created.

Exemplo:

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

descriptorDate
string
obrigatório

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

Exemplo:

"2026-06-14"

id
string
obrigatório

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

Exemplo:

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

installmentCount
integer<int64>
obrigatório

Total number of installments in the amortization schedule.

Exemplo:

24

jurisdictionCode
string
obrigatório

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

Exemplo:

"BR"

loanAccountId
string
obrigatório

UUID of the loan account the descriptor summarizes.

Exemplo:

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

loanApplicationId
string
obrigatório

UUID of the originating loan application.

Exemplo:

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

monthlyRate
string
obrigatório

Contractual nominal monthly interest rate as a percentage decimal string.

Exemplo:

"1.85"

originalTerm
integer<int64>
obrigatório

Original contracted term of the loan in number of installments.

Exemplo:

24

outstandingBalance
string
obrigatório

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

Exemplo:

"43250.75"

overdueInstallmentCount
integer<int64>
obrigatório

Number of installments currently past due.

Exemplo:

1

paidInstallmentCount
integer<int64>
obrigatório

Number of installments fully paid to date.

Exemplo:

6

principalOutstanding
string
obrigatório

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

Exemplo:

"42000.00"

profileVersion
string
obrigatório

Jurisdiction profile version used to compute the descriptor.

Exemplo:

"1.0.0"

refreshedAt
string
obrigatório

RFC3339 UTC timestamp when the descriptor figures were last refreshed.

Exemplo:

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

status
string
obrigatório

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

Exemplo:

"active"

totalCharges
string
obrigatório

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

Exemplo:

"320.00"

totalTaxes
string
obrigatório

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

Exemplo:

"86.84"

accrualState
string

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

Exemplo:

"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.

Exemplo:

"50.34"

lastPaymentDate
string

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

Exemplo:

"2026-06-14"

nextDueDate
string

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

Exemplo:

"2026-06-14"

pddStage
string

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

Exemplo:

"stage_1"

prepaymentSettlementId
string

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

Exemplo:

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