GET
/v1/BankAccount/{id}/Pix/InfrigmentReportBanking · 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):
id— —
Request
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
id | path | string | obrigatório | — | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
Page | query | integer | opcional | — | 10 |
Size | query | integer | opcional | — | 10 |
Status | 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 |
|---|---|---|---|---|---|
data | array de objeto | opcional | — | objeto — ver detalhe abaixo | [ … ] |
page | integer | opcional | — | — | 0 |
totalPages | integer | opcional | — | — | 0 |
totalItems | integer | opcional | — | — | 0 |
Detalhe de data
| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
id | string | opcional | — | — | "texto" |
infrigmentReportId | string | opcional | — | — | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
infrigmentReportDetails | string | opcional | — | — | "texto" |
endToEndOriginal | string | opcional | — | — | "texto" |
status | string | opcional | — | OPEN, ACKNOWLEDGED, CLOSED, CANCELLED | "OPEN" |
statusDisplay | string | opcional | — | — | "texto" |
createdAt | string (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ódigo | Significado | Detalhe do contrato |
|---|---|---|
200 | Requisiçã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.
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