Dados operacionais (transação) de um relato (CONTESTADO)

Lista e filtra registros de Bank Account.

Visão geral

Dados operacionais (transação) de um relato (CONTESTADO).

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 — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`codAgencia`	query	`string`	opcional	—	`valor`
`nroConta`	query	`string`	opcional	—	`valor`
`cpfCnpj`	query	`string`	opcional	—	`valor`
`tipoConta`	query	`string`	opcional	—	`valor`
`idRelatoInfracao`	query	`string`	opcional	—	`valor`
`idTransacao`	query	`string`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`idRelatoInfracao`	`string`	opcional	—	—	`"texto"`
`idTransacao`	`string`	opcional	—	—	`"texto"`
`participanteRelator`	`string`	opcional	—	—	`"texto"`
`codAgenciaRelator`	`string`	opcional	—	—	`"texto"`
`nroContaRelator`	`string`	opcional	—	—	`"texto"`
`tipoContaRelator`	`string`	opcional	—	`CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional`	`"CheckingAccount"`
`cpfCnpjRelator`	`string`	opcional	—	—	`"12345678909"`
`nomeRelator`	`string`	opcional	—	—	`"Fulano de Tal"`
`participanteContraparte`	`string`	opcional	—	—	`"texto"`
`codAgenciaContraparte`	`string`	opcional	—	—	`"texto"`
`nroContaContraparte`	`string`	opcional	—	—	`"texto"`
`tipoContaContraparte`	`string`	opcional	—	`CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional`	`"CheckingAccount"`
`cpfCnpjContraparte`	`string`	opcional	—	—	`"12345678909"`
`nomeContraparte`	`string`	opcional	—	—	`"Fulano de Tal"`
`valorOperacao`	`number (decimal)`	opcional	—	—	`1000`
`dataHoraOperacao`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Exemplo de resposta

{
  "idRelatoInfracao": "texto",
  "idTransacao": "texto",
  "participanteRelator": "texto",
  "codAgenciaRelator": "texto",
  "nroContaRelator": "texto",
  "tipoContaRelator": "CheckingAccount",
  "cpfCnpjRelator": "12345678909",
  "nomeRelator": "Fulano de Tal",
  "participanteContraparte": "texto",
  "codAgenciaContraparte": "texto",
  "nroContaContraparte": "texto",
  "tipoContaContraparte": "CheckingAccount",
  "cpfCnpjContraparte": "12345678909",
  "nomeContraparte": "Fulano de Tal",
  "valorOperacao": 1000,
  "dataHoraOperacao": "2025-08-11T13:45:00Z"
}

Códigos de retorno

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

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/MED/Contested/Operation" \
  -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 = "/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/MED/Contested/Operation";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

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

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/MED/Contested/Operation`, {
  method: 'GET',
  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