API Docs Início Documentação Referência de API Copiar para LLM
GET/v1/BankAccount/{id}/Pix/InfrigmentReport
Banking · PIX

Consultar lista de relato de infração

Lista e filtra registros de Bank Account.

Visão geral

Consultar lista de relato de infração

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

Request

Parâmetros

NomeEmTipoObrigatórioDescriçãoExemplo
idpathstringobrigatório3fa85f64-5717-4562-b3fc-2c963f66afa6
Pagequeryintegeropcional10
Sizequeryintegeropcional10
Statusquerystringopcionalvalor

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
dataarray de objetoopcionalobjeto — ver detalhe abaixo[ … ]
pageintegeropcional0
totalPagesintegeropcional0
totalItemsintegeropcional0

Detalhe de data

CampoTipoObrigatórioDescriçãoValoresExemplo
idstringopcional"texto"
infrigmentReportIdstringopcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
infrigmentReportDetailsstringopcional"texto"
endToEndOriginalstringopcional"texto"
statusstringopcionalOPEN, ACKNOWLEDGED, CLOSED, CANCELLED"OPEN"
statusDisplaystringopcional"texto"
createdAtstring (date-time)opcional"2025-08-11T13:45:00Z"

Exemplo de resposta

{
  "data": [
    {
      "id": "texto",
      "infrigmentReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "infrigmentReportDetails": "texto",
      "endToEndOriginal": "texto",
      "status": "OPEN",
      "statusDisplay": "texto",
      "createdAt": "2025-08-11T13:45:00Z"
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0
}

Códigos de retorno

CódigoSignificadoDetalhe do contrato
200Requisição bem-sucedida.

Exemplos

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

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/InfrigmentReport`, {
  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.

Guia de importação: Como importar no Postman · Todos os downloads: Downloads