Método utilizado para download em lote grande através de uma lista de boletos e…

Cria um novo registro de api.

Visão geral

Método utilizado para download em lote grande através de uma lista de boletos e envio por email.

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

Nenhum parâmetro de rota, query ou header.

Corpo da requisição

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

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`email`	`string`	opcional	—	—	`"cliente@exemplo.com.br"`
`billingIds`	`array de string`	opcional	—	—	`[ … ]`

Exemplo de corpo

{
  "email": "cliente@exemplo.com.br",
  "billingIds": [
    "texto"
  ]
}

Response

Sem resposta de sucesso documentada no contrato.

Códigos de retorno

Código	Significado	Detalhe do contrato
`401`	Não autenticado — token ausente, inválido ou expirado.	—

Exemplos

curl -X POST "{{baseUrl}}/api/v1/BankSlip/DownloadLongBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "cliente@exemplo.com.br",
  "billingIds": [
    "texto"
  ]
}'

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

var corpo = new StringContent(
    """
    {
      "email": "cliente@exemplo.com.br",
      "billingIds": [
        "texto"
      ]
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.

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

const payload = {
  "email": "cliente@exemplo.com.br",
  "billingIds": [
    "texto"
  ]
};

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

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
// Sem corpo de resposta neste endpoint.

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