GET/v{version}/Amortization/{id}

Crédito · Simulação

Obtém simulações de operações de crédito geradas anteriormente

Consulta Amortization pelo identificador informado na rota.

Visão geral

Obtém simulações de operações de crédito geradas anteriormente, incluindo plano de pagamento, CET, custo de emissão, IOF, etc.

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

id — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string (uuid)`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`version`	path	`string`	obrigatório	—	`1`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`personId`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`personDisplay`	`string`	opcional	—	—	`"texto"`
`personDiscriminator`	`string`	opcional	—	—	`"texto"`
`productId`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`productIdDisplay`	`string`	opcional	—	—	`"texto"`
`legalPerson`	`boolean`	opcional	—	—	`true`
`amortizationId`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`amortization`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`paymentScheduleItems`	`array de objeto`	opcional	—	—	`[ … ]`

Detalhe de `amortization`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`amortizationType`	`string`	opcional	Tipo de tabela de amortização	—	`"texto"`
`calculateByValueType`	`string`	opcional	Tipo de cálculo de operação: Valor Bruto ou Valor Líquido	—	`"texto"`
`requestedAmount`	`integer (int64)`	opcional	Valor solicitado pelo tomador. Quando calculado pelo valor líquido, o valor solicitado é o liquido da operação.	—	`0`
`principalAmountInCents`	`integer (int64)`	opcional	Valor do principal da dívida.	—	`0`
`startDate`	`string (date-time)`	opcional	Data de início da operação	—	`"2025-08-11T13:45:00Z"`
`termInMonths`	`integer`	opcional	Prazo da operação (em meses ou anos, dependendo da periodicidade)	—	`0`
`numberOfPayments`	`integer`	opcional	Quantidade de parcelas que serão pagas pelo tomador	—	`0`
`paymentPeriodicity`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`absAmortizationInMonths`	`integer`	opcional	Número de períodos em que será dada carência de cobrança do principal	—	`0`
`absInterestInMonths`	`integer`	opcional	Número de períodos em que será dada carência de juros da operação. Será sempre menor ou igual à carência do principal.	—	`0`
`apr`	`number (double)`	opcional	Taxa de juros nominal da operação	—	`1.99`
`periodicity`	`string`	opcional	Periodicidade das parcelas da operação	—	`"texto"`
`daysInYear`	`integer`	opcional	Base de cálculos (dias no ano)	—	`0`
`agentCommission`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`calculationType`	`string`	opcional	Base de cálculo	—	`"texto"`
`firstPaymentDate`	`string (date-time)`	opcional	Data do primeiro pagamento	—	`"2025-08-11T13:45:00Z"`
`bankCommission`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`financeOperationsTax`	`number (double)`	opcional	Alíquota de IOF adicional utilizada durante o cálculo de IOF	—	`1.99`
`dailyFinanceOperationsTax`	`number (double)`	opcional	Alíquota de IOF diário utilizada durante o cálculo de IOF	—	`1.99`
`indexer`	`string`	opcional	Nome do indexador pós-fixado da operação, se utilizado	—	`"texto"`
`indexerValue`	`number (double)`	opcional	Quantidade (em percentual) do indexador que será aplicada a cada parcela da operação	—	`1000`
`paymentDay`	`integer`	opcional	Dia de vencimento das parcelas da operação	—	`0`
`skippedMonths`	`array de string`	opcional	Meses do ano em que foi dada carência no pagamento da parcela. Usado apenas em operações de CCI/Home Equity	—	`[ … ]`
`monthlyInterest`	`number (double)`	opcional	Taxa de juros nominal mensal da operação	—	`1000`
`yearlyInterest`	`number (double)`	opcional	Taxa de juros nominal anual da operação	—	`1000`
`effectiveMonthlyCost`	`number (double)`	opcional	Custo Efetivo Total (CET) Mensal da operação	—	`1000`
`effectiveYearlyCost`	`number (double)`	opcional	Custo Efetivo Total (CET) Anual da operação	—	`1000`
`liquidValue`	`integer (int64)`	opcional	Valor líquido da operação	—	`1`
`comm`	`integer`	opcional	Custo de Emissão da operação (soma da comissão do agente e Custo de emissão UY3)	—	`0`
`commTc`	`integer`	opcional	Custo de Emissão referentes à tarifas de cadastro (TC)	—	`0`
`commNonTc`	`integer`	opcional	Custo de Emissão da operação exceto tarifas de cadastro (TC)	—	`0`
`finTax`	`integer`	opcional	Valor de IOF da operação	—	`0`
`dueDate`	`string (date-time)`	opcional	Data de encerramento da operação (vencimento da última parcela)	—	`"2025-08-11T13:45:00Z"`
`initialValue`	`integer (int64)`	opcional	Valor inicial da dívida contraída	—	`0`
`fixedPaymentDuringGraduation`	`integer`	opcional	Valor da parcela durante o curso. Utilizado em operações de Financiamento Estudantil	—	`0`
`termsUntilGraduation`	`integer`	opcional	Número de períodos até o término do curso. Utilizado em operações de Financiamento Estudantil	—	`0`
`absAfterGraduation`	`integer`	opcional	Número de períodos com carência de pagamento após o término do curso. Utilizado em operações de Financiamento Estudantil	—	`0`
`pmt2Value`	`number (double)`	opcional	Valor do pagamento após o término da carência após conclusão do curso. Utilizado em operações de Financiamento Estudantil	—	`1000`
`fiduciaryGuarantee`	`number (double)`	opcional	Percentual de garantia fiduciária da operação. Utilizada em operações com garantia de duplicata.	—	`1000`
`financeTaxExempted`	`boolean`	opcional	Indica se a operação é isenta de IOF por definição legal	—	`true`
`issueNumber`	`integer`	opcional	Numero de série da nota comercial	—	`0`
`emissionNumber`	`integer`	opcional	Numero de emissão da nota comercial	—	`0`
`quantity`	`integer`	opcional	Quantidade de notas comerciais	—	`0`
`unitPrice`	`integer (int64)`	opcional	Valor unitario da nota comercial	—	`0`
`minEmissionCost`	`integer (int64)`	opcional	/// Custo Mínimo de Emissão com base no produto	—	`0`
`maxEmissionCost`	`integer (int64)`	opcional	Custo Máximo de Emissão com base no produto	—	`0`
`numberOfInterestPayments`	`integer`	opcional	Parcelas de pagamento de juros	—	`0`
`valueMarginReserve`	`integer (int64)`	opcional	Valor reserva de margem	—	`0`
`insuranceCoverAmount`	`integer (int64)`	opcional	Valor da cobertura do seguro	—	`0`
`paymentFixedCosts`	`integer (int64)`	opcional	Valor da parcela fixa	—	`0`
`includePaymentFixedCosts`	`boolean`	opcional	Incluir valor da parcela fixa na simulação	—	`true`
`dueDateOnBusinessDays`	`boolean`	opcional	Datas de vencimento são ajustadas para o próximo dia útil	—	`true`
`discountMode`	`boolean`	opcional	Calcula o juros baseado no valor de amortização em relação à data de início. Caso contrário, calcula o juros baseasdo no saldo devedor em relação à ultima parcela.	—	`true`

Detalhe de `paymentPeriodicity`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`every`	`integer`	opcional	A cada quantos per�odos	—	`0`
`periodicity`	`string`	opcional	Tipo de periodicidade (Monthly, Quarterly, etc)	—	`"texto"`

Detalhe de `agentCommission`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`amount`	`number (double)`	opcional	—	—	`1000`
`amountDisplay`	`string`	opcional	—	—	`"texto"`
`type`	`string`	opcional	—	—	`"texto"`
`baseValue`	`string`	opcional	—	—	`"texto"`
`chargeCommissionFrom`	`string`	opcional	—	—	`"texto"`
`financeCost`	`boolean`	opcional	—	—	`true`

Exemplo de resposta

{
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "personDisplay": "texto",
  "personDiscriminator": "texto",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productIdDisplay": "texto",
  "legalPerson": true,
  "amortizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortization": {
    "amortizationType": "texto",
    "calculateByValueType": "texto",
    "requestedAmount": 0,
    "principalAmountInCents": 0,
    "startDate": "2025-08-11T13:45:00Z",
    "termInMonths": 0,
    "numberOfPayments": 0,
    "paymentPeriodicity": {
      "every": 0,
      "periodicity": "texto"
    },
    "absAmortizationInMonths": 0,
    "absInterestInMonths": 0,
    "apr": 1.99,
    "periodicity": "texto",
    "daysInYear": 0,
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "calculationType": "texto",
    "firstPaymentDate": "2025-08-11T13:45:00Z",
    "bankCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "financeOperationsTax": 1.99,
    "dailyFinanceOperationsTax": 1.99,
    "indexer": "texto",
    "indexerValue": 1000,
    "paymentDay": 0,
    "skippedMonths": [
      "texto"
    ],
    "monthlyInterest": 1000,
    "yearlyInterest": 1000,
    "effectiveMonthlyCost": 1000,
    "effectiveYearlyCost": 1000,
    "liquidValue": 1,
    "comm": 0,
    "commTc": 0,
    "commNonTc": 0,
    "finTax": 0,
    "dueDate": "2025-08-11T13:45:00Z",
    "initialValue": 0,
    "fixedPaymentDuringGraduation": 0,
    "termsUntilGraduation": 0,
    "absAfterGraduation": 0,
    "pmt2Value": 1000,
    "fiduciaryGuarantee": 1000,
    "financeTaxExempted": true,
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "minEmissionCost": 0,
    "maxEmissionCost": 0,
    "numberOfInterestPayments": 0,
    "valueMarginReserve": 0,
    "insuranceCoverAmount": 0,
    "paymentFixedCosts": 0,
    "includePaymentFixedCosts": true,
    "dueDateOnBusinessDays": true,
    "discountMode": true
  },
  "paymentScheduleItems": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "payment": 0,
      "accruedInterest": 0,
      "addedFixedCosts": 0,
      "paymentNo": 0
    }
  ]
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

curl -X GET "{{baseUrl}}/v1/Amortization/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/Amortization/3fa85f64-5717-4562-b3fc-2c963f66afa6";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/Amortization/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Collection do Consignado privadoCadastros, operação e consultas do módulo.Baixar →Collection do FGTSCadastros, operação e consultas do módulo.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads