Lista contestações recebidas (CONTESTED)

Lista e filtra registros de Bank Account.

Visão geral

Lista contestações recebidas (CONTESTED).

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`
`registrationNumber`	query	`string`	opcional	CPF/CNPJ do cliente.	`valor`
`recipientName`	query	`string`	opcional	Nome do destinatário (opcional).	`valor`
`bankCode`	query	`string`	opcional	Código do banco ISPB (opcional).	`valor`
`agencyCode`	query	`string`	opcional	Agência (opcional).	`valor`
`accountNumber`	query	`string`	opcional	Número da conta (opcional).	`valor`
`transactionId`	query	`string`	opcional	ID da transação EndToEndId (opcional).	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`status`	query	`objeto`	opcional	Filtro de status (opcional).	`valor`
`startDate`	query	`string (date-time)`	opcional	Data inicial (opcional).	`valor`
`endDate`	query	`string (date-time)`	opcional	Data final (opcional).	`valor`
`startTime`	query	`string`	opcional	Hora inicial HH:mm:ss (opcional).	`valor`
`endTime`	query	`string`	opcional	Hora final HH:mm:ss (opcional).	`valor`
`page`	query	`integer`	opcional	Número da página.	`10`
`pageSize`	query	`integer`	opcional	Itens por página.	`10`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200 — retorna uma lista (array) de objetos.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`infractionReportId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`bankCode`	`string`	opcional	—	—	`"texto"`
`bankName`	`string`	opcional	—	—	`"Fulano de Tal"`
`operationAmount`	`number (decimal)`	opcional	—	—	`1000`
`recoveredAmount`	`number (decimal)`	opcional	—	—	`1000`
`transactionDateTime`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`contestationDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`status`	`string`	opcional	—	`UNKNOWN`, `IN_ANALYSIS`, `APPROVED`, `PARTIALLY_REFUNDED`, `FULLY_REFUNDED`, `REJECTED`, `DEADLINE_EXPIRED`, `CANCELLED`	`"UNKNOWN"`
`contestationType`	`string`	opcional	—	`REPORTED`, `CONTESTED`	`"REPORTED"`
`reason`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"UNKNOWN"`
`analysisDaysRemaining`	`integer`	opcional	—	—	`0`
`recoveryDaysRemaining`	`integer`	opcional	—	—	`0`
`analysisDeadline`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`recoveryDeadline`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Exemplo de resposta

[
  {
    "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909",
    "bankCode": "texto",
    "bankName": "Fulano de Tal",
    "operationAmount": 1000,
    "recoveredAmount": 1000,
    "transactionDateTime": "2025-08-11T13:45:00Z",
    "contestationDate": "2025-08-11T13:45:00Z",
    "status": "UNKNOWN",
    "contestationType": "REPORTED",
    "reason": "UNKNOWN",
    "analysisDaysRemaining": 0,
    "recoveryDaysRemaining": 0,
    "analysisDeadline": "2025-08-11T13:45:00Z",
    "recoveryDeadline": "2025-08-11T13:45:00Z"
  }
]

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).	—
`401`	Não autenticado — token ausente, inválido ou expirado.	—
`500`	Erro interno no servidor.	—

Exemplos

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

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/Contestations/Received`, {
  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