Método para buscar parcelamentos por contratoId (número da operação)

Visão geral

Método para buscar parcelamentos por contratoId (número da operação).
Localiza o CPF associado ao contrato e retorna todos os parcelamentos vinculados a esse CPF.

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

• contractId — Número da operação/contrato (mesmo ID usado para consulta no Dataprev)

Request

Parâmetros

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Detalhe de installments

Exemplo de resposta

{
  "contractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "numeroInscricaoSacado": "texto",
  "message": "texto",
  "installments": [
    {
      "id": "texto",
      "walletCode": 0,
      "description": "texto",
      "operations": [
        "texto"
      ],
      "admissionDates": [
        "2025-08-11T13:45:00Z"
      ],
      "payerName": "Fulano de Tal",
      "payerRegistrationNumber": "texto",
      "status": "texto",
      "statusDisplay": "texto",
      "billingCount": 0,
      "totalAmount": 0,
      "paidAmount": 1,
      "pendingAmount": 0,
      "overdueBillingsCount": 0,
      "paidBillingsCount": 1,
      "createdAt": "2025-08-11T13:45:00Z",
      "registered": true
    }
  ]
}

Códigos de retorno

Exemplos

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

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