API Docs Início Documentação Referência de API Copiar para LLM
POST/api/v1/Installment/{installmentId}/Register
Cobrança · Parcelamentos

Método responsável por registrar um parcelamento específico

Cria um novo registro de api.

Visão geral

Método responsável por registrar 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):

Request

Parâmetros

NomeEmTipoObrigatórioDescriçãoExemplo
installmentIdpathstringobrigatórioindentificação3fa85f64-5717-4562-b3fc-2c963f66afa6

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Sem campos estruturados no contrato (tipo primitivo ou livre).

Exemplo de resposta

true

Códigos de retorno

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

Exemplos

curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/Register" \
  -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/Register";

var resp = await http.PostAsync(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/Register`, {
  method: 'POST',
  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