Método utilizado para enviar/protestar um boleto especifico para o cartório

Cria um novo registro de api.

Visão geral

Método utilizado para enviar/protestar um boleto especifico para o cartório.

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

barCode — código de barras

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`barCode`	path	`string`	obrigatório	código de barras	`valor`
`idempotence`	query	`string`	opcional	chave de idempotência	`valor`

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ó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/BankSlip/valor/DebtCollection/Submit" \
  -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/BankSlip/valor/DebtCollection/Submit";

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/BankSlip/valor/DebtCollection/Submit`, {
  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.

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