POST/api/v1/Installment

Cobrança · Parcelamentos

Método de cadastro de um parcelamento

Cria um novo registro de api.

Visão geral

Método de cadastro de um parcelamento.

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.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`idempotence`	query	`string`	opcional	—	`valor`
`register`	query	`boolean`	opcional	—	`true`

Corpo da requisição

Envie no formato application/json. Corpo obrigatório.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`walletCode`	`integer (int64)`	opcional	—	—	`0`
`description`	`string`	opcional	—	—	`"texto"`
`operations`	`array de string`	opcional	—	—	`[ … ]`
`admissionDates`	`array de string (date-time)`	opcional	—	—	`[ … ]`
`billingSettingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`communicationSettingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`reference`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`tags`	`array de string`	opcional	—	—	`[ … ]`
`payer`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`guarantor`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`billings`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`firstInstructionDebtCollection`	`string`	opcional	—	—	`"texto"`
`secondInstructionDebtCollection`	`integer`	opcional	—	—	`0`
`bankCode`	`string`	opcional	—	—	`"texto"`
`walletNumber`	`integer`	opcional	—	—	`0`
`latePaymentInterestAmountPerDay`	`integer`	opcional	—	—	`0`
`creditTypeValue`	`string`	opcional	—	—	`"texto"`
`billingCreateTypeValue`	`string`	opcional	—	—	`"texto"`
`installmentsToCancel`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`interestTypeValue`	`string`	opcional	—	—	`"texto"`
`interestAmount`	`number (decimal)`	opcional	—	—	`1000`
`fineTypeValue`	`string`	opcional	—	—	`"texto"`
`interestCodeValue`	`string`	opcional	—	—	`"texto"`
`fineAmount`	`number (decimal)`	opcional	—	—	`1000`
`apr`	`number (double)`	opcional	—	—	`1.99`

Detalhe de `billings`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`externalId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`documentNumber`	`string`	opcional	—	—	`"texto"`
`amount`	`integer (int64)`	opcional	—	—	`0`
`dueDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`iof`	`string`	opcional	—	—	`"texto"`
`deduction`	`integer`	opcional	—	—	`0`
`participantControlNumber`	`string`	opcional	—	—	`"texto"`
`discount`	`integer`	opcional	—	—	`0`
`discountLimitDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`discount2`	`integer`	opcional	—	—	`0`
`discountLimitDate2`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`discount3`	`integer`	opcional	—	—	`0`
`discountLimitDate3`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Detalhe de `installmentsToCancel`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`installmentStatus`	`string`	opcional	—	`Created`, `Registered`, `Paid`, `Cancelled`, `Renegotiated`, `Refinanced`	`"Created"`

Exemplo de corpo

{
  "walletCode": 0,
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "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"
  },
  "billings": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "iof": "texto",
      "deduction": 0,
      "participantControlNumber": "texto",
      "discount": 0,
      "discountLimitDate": "2025-08-11T13:45:00Z",
      "discount2": 0,
      "discountLimitDate2": "2025-08-11T13:45:00Z",
      "discount3": 0,
      "discountLimitDate3": "2025-08-11T13:45:00Z"
    }
  ],
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "billingCreateTypeValue": "texto",
  "installmentsToCancel": [
    {
      "id": "texto",
      "installmentStatus": "Created"
    }
  ],
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "interestCodeValue": "texto",
  "fineAmount": 1000,
  "apr": 1.99
}

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 POST "{{baseUrl}}/api/v1/Installment" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "walletCode": 0,
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "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"
  },
  "billings": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "iof": "texto",
      "deduction": 0,
      "participantControlNumber": "texto",
      "discount": 0,
      "discountLimitDate": "2025-08-11T13:45:00Z",
      "discount2": 0,
      "discountLimitDate2": "2025-08-11T13:45:00Z",
      "discount3": 0,
      "discountLimitDate3": "2025-08-11T13:45:00Z"
    }
  ],
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "billingCreateTypeValue": "texto",
  "installmentsToCancel": [
    {
      "id": "texto",
      "installmentStatus": "Created"
    }
  ],
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "interestCodeValue": "texto",
  "fineAmount": 1000,
  "apr": 1.99
}'

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

var corpo = new StringContent(
    """
    {
      "walletCode": 0,
      "description": "texto",
      "operations": [
        "texto"
      ],
      "admissionDates": [
        "2025-08-11T13:45:00Z"
      ],
      "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": {
        "resource": "CreditNote",
        "id": "texto"
      },
      "tags": [
        "texto"
      ],
      "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"
      },
      "billings": [
        {
          "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "documentNumber": "texto",
          "amount": 0,
          "dueDate": "2025-08-11T13:45:00Z",
          "iof": "texto",
          "deduction": 0,
          "participantControlNumber": "texto",
          "discount": 0,
          "discountLimitDate": "2025-08-11T13:45:00Z",
          "discount2": 0,
          "discountLimitDate2": "2025-08-11T13:45:00Z",
          "discount3": 0,
          "discountLimitDate3": "2025-08-11T13:45:00Z"
        }
      ],
      "firstInstructionDebtCollection": "texto",
      "secondInstructionDebtCollection": 0,
      "bankCode": "texto",
      "walletNumber": 0,
      "latePaymentInterestAmountPerDay": 0,
      "creditTypeValue": "texto",
      "billingCreateTypeValue": "texto",
      "installmentsToCancel": [
        {
          "id": "texto",
          "installmentStatus": "Created"
        }
      ],
      "interestTypeValue": "texto",
      "interestAmount": 1000,
      "fineTypeValue": "texto",
      "interestCodeValue": "texto",
      "fineAmount": 1000,
      "apr": 1.99
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

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

const payload = {
  "walletCode": 0,
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "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"
  },
  "billings": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "iof": "texto",
      "deduction": 0,
      "participantControlNumber": "texto",
      "discount": 0,
      "discountLimitDate": "2025-08-11T13:45:00Z",
      "discount2": 0,
      "discountLimitDate2": "2025-08-11T13:45:00Z",
      "discount3": 0,
      "discountLimitDate3": "2025-08-11T13:45:00Z"
    }
  ],
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "billingCreateTypeValue": "texto",
  "installmentsToCancel": [
    {
      "id": "texto",
      "installmentStatus": "Created"
    }
  ],
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "interestCodeValue": "texto",
  "fineAmount": 1000,
  "apr": 1.99
};

const resp = await fetch(`${baseUrl}/api/v1/Installment`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

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

Visão geral

Autenticação e pré-requisitos

Request

Parâmetros

Corpo da requisição

Campos

Detalhe de billings

Detalhe de installmentsToCancel

Exemplo de corpo

Response

Campos

Detalhe de billings

Exemplo de resposta

Códigos de retorno

Exemplos

Downloads

Detalhe de `billings`

Detalhe de `installmentsToCancel`

Detalhe de `billings`