Criar Bank Account

Cria um novo registro de Bank Account.

Visão geral

Cria um novo registro de Bank Account.

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
`startDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`endDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`ispb`	`string`	opcional	—	—	`"texto"`
`nameResponsible`	`string`	opcional	—	—	`"Fulano de Tal"`
`emailResponsible`	`string`	opcional	—	—	`"cliente@exemplo.com.br"`
`foneResponsible`	`string`	opcional	—	—	`"texto"`
`typeSend`	`string`	opcional	—	`I`, `S`	`"I"`
`typeSendValue`	`string`	opcional	—	—	`"texto"`

Exemplo de corpo

{
  "startDate": "2025-08-11T13:45:00Z",
  "endDate": "2025-08-11T13:45:00Z",
  "ispb": "texto",
  "nameResponsible": "Fulano de Tal",
  "emailResponsible": "cliente@exemplo.com.br",
  "foneResponsible": "texto",
  "typeSend": "I",
  "typeSendValue": "texto"
}

Response

Resposta 200 sem corpo (—).

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/Pix/ReportXml" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2025-08-11T13:45:00Z",
  "endDate": "2025-08-11T13:45:00Z",
  "ispb": "texto",
  "nameResponsible": "Fulano de Tal",
  "emailResponsible": "cliente@exemplo.com.br",
  "foneResponsible": "texto",
  "typeSend": "I",
  "typeSendValue": "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 = "/v1/BankAccount/Pix/ReportXml";

var corpo = new StringContent(
    """
    {
      "startDate": "2025-08-11T13:45:00Z",
      "endDate": "2025-08-11T13:45:00Z",
      "ispb": "texto",
      "nameResponsible": "Fulano de Tal",
      "emailResponsible": "cliente@exemplo.com.br",
      "foneResponsible": "texto",
      "typeSend": "I",
      "typeSendValue": "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 = {
  "startDate": "2025-08-11T13:45:00Z",
  "endDate": "2025-08-11T13:45:00Z",
  "ispb": "texto",
  "nameResponsible": "Fulano de Tal",
  "emailResponsible": "cliente@exemplo.com.br",
  "foneResponsible": "texto",
  "typeSend": "I",
  "typeSendValue": "texto"
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/Pix/ReportXml`, {
  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