Importa contestações do PIX MED que ainda não existem no banco local

Cria um novo registro de Bank Account.

Visão geral

Importa contestações do PIX MED que ainda não existem no banco local.

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

id — Id da conta.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	Id da conta.	`3fa85f64-5717-4562-b3fc-2c963f66afa6`

Corpo da requisição

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

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`codAgencia`	`string`	opcional	—	—	`"texto"`
`nroConta`	`string`	opcional	—	—	`"texto"`
`cpfCnpj`	`string`	opcional	—	—	`"12345678909"`
`tipoConta`	`string`	opcional	—	`CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional`	`"CheckingAccount"`
`dataInicio`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`dataFim`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`contestationType`	`string`	opcional	—	`REPORTED`, `CONTESTED`	`"REPORTED"`

Exemplo de corpo

{
  "codAgencia": "texto",
  "nroConta": "texto",
  "cpfCnpj": "12345678909",
  "tipoConta": "CheckingAccount",
  "dataInicio": "2025-08-11T13:45:00Z",
  "dataFim": "2025-08-11T13:45:00Z",
  "contestationType": "REPORTED"
}

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`totalFound`	`integer`	opcional	—	—	`0`
`newContestations`	`integer`	opcional	—	—	`0`
`alreadyExists`	`integer`	opcional	—	—	`0`
`errors`	`integer`	opcional	—	—	`0`

Exemplo de resposta

{
  "totalFound": 0,
  "newContestations": 0,
  "alreadyExists": 0,
  "errors": 0
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—
`400`	Requisição inválida (validação de campos ou regra de negócio).	—
`500`	Erro interno no servidor.	—
`502`	Erro de gateway em serviço dependente.	—

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Contestations/Import" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "codAgencia": "texto",
  "nroConta": "texto",
  "cpfCnpj": "12345678909",
  "tipoConta": "CheckingAccount",
  "dataInicio": "2025-08-11T13:45:00Z",
  "dataFim": "2025-08-11T13:45:00Z",
  "contestationType": "REPORTED"
}'

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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Contestations/Import";

var corpo = new StringContent(
    """
    {
      "codAgencia": "texto",
      "nroConta": "texto",
      "cpfCnpj": "12345678909",
      "tipoConta": "CheckingAccount",
      "dataInicio": "2025-08-11T13:45:00Z",
      "dataFim": "2025-08-11T13:45:00Z",
      "contestationType": "REPORTED"
    }
    """,
    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 = {
  "codAgencia": "texto",
  "nroConta": "texto",
  "cpfCnpj": "12345678909",
  "tipoConta": "CheckingAccount",
  "dataInicio": "2025-08-11T13:45:00Z",
  "dataFim": "2025-08-11T13:45:00Z",
  "contestationType": "REPORTED"
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Contestations/Import`, {
  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