Método de visualização de um parcelamento específico

Consulta api pelo identificador informado na rota.

Visão geral

Método de visualização de um parcelamento específico.

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):

installmentId — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`installmentId`	path	`string`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`walletCode`	`integer (int64)`	opcional	—	—	`0`
`billingCreateTypeValue`	`string`	opcional	—	—	`"texto"`
`billingCreateTypeDisplay`	`string`	opcional	—	—	`"texto"`
`description`	`string`	opcional	—	—	`"texto"`
`operations`	`array de string`	opcional	—	—	`[ … ]`
`admissionDates`	`array de string (date-time)`	opcional	—	—	`[ … ]`
`billingSettingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`billingSettingDisplay`	`string`	opcional	—	—	`"texto"`
`communicationSettingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`communicationSettingDisplay`	`string`	opcional	—	—	`"texto"`
`reference`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`tags`	`array de string`	opcional	—	—	`[ … ]`
`billings`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`payer`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`guarantor`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`billingCount`	`integer`	opcional	—	—	`0`
`firstInstructionDebtCollection`	`string`	opcional	—	—	`"texto"`
`secondInstructionDebtCollection`	`integer`	opcional	—	—	`0`
`statusValue`	`string`	opcional	—	—	`"texto"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`registered`	`boolean`	opcional	—	—	`true`
`bankCode`	`string`	opcional	—	—	`"texto"`
`walletNumber`	`integer`	opcional	—	—	`0`
`latePaymentInterestAmountPerDay`	`integer`	opcional	—	—	`0`
`creditTypeValue`	`string`	opcional	—	—	`"texto"`
`creditTypeDisplay`	`string`	opcional	—	—	`"texto"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`apr`	`number (double)`	opcional	—	—	`1.99`
`warrantyRegistrationOffice`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"None"`
`warrantyRegistrationOfficeDisplay`	`string`	opcional	—	—	`"texto"`
`calculationCriteria`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"V252DiasUteis"`
`calculationCriteriaDisplay`	`string`	opcional	—	—	`"texto"`
`interestTypeValue`	`string`	opcional	—	—	`"texto"`
`interestTypeValueDisplay`	`string`	opcional	—	—	`"texto"`
`interestAmount`	`number (decimal)`	opcional	—	—	`1000`
`fineTypeValue`	`string`	opcional	—	—	`"texto"`
`fineTypeValueDisplay`	`string`	opcional	—	—	`"texto"`
`fineAmount`	`number (decimal)`	opcional	—	—	`1000`
`predecessorInstallmentId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`successorInstallmentId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`

Detalhe de `billings`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`externalId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`billingStatus`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`isAnticipatedBilling`	`boolean`	opcional	—	—	`true`

Exemplo de resposta

{
  "id": "texto",
  "walletCode": 0,
  "billingCreateTypeValue": "texto",
  "billingCreateTypeDisplay": "texto",
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billingSettingDisplay": "texto",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingDisplay": "texto",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "billings": [
    {
      "id": "texto",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billingStatus": {
        "type": {},
        "message": "texto"
      },
      "isAnticipatedBilling": true
    }
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "billingCount": 0,
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "statusValue": "texto",
  "statusDisplay": "texto",
  "registered": true,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "creditTypeDisplay": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "apr": 1.99,
  "warrantyRegistrationOffice": "None",
  "warrantyRegistrationOfficeDisplay": "texto",
  "calculationCriteria": "V252DiasUteis",
  "calculationCriteriaDisplay": "texto",
  "interestTypeValue": "texto",
  "interestTypeValueDisplay": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "fineTypeValueDisplay": "texto",
  "fineAmount": 1000,
  "predecessorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "successorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—
`401`	Não autenticado — token ausente, inválido ou expirado.	—

Exemplos

curl -X GET "{{baseUrl}}/api/v1/Installment/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 = "/api/v1/Installment/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}/api/v1/Installment/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 →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