Lista bancos com paginação, busca por vários campos e ordenação

Lista e filtra registros de Bank Account.

Visão geral

Lista bancos com paginação, busca por vários campos e ordenaçã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.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`page`	query	`integer`	opcional	Página 0-based	`10`
`size`	query	`integer`	opcional	Tamanho da página	`10`
`searchString`	query	`string`	opcional	Busca aplicada em Ispb, Code e Name. Opcional.	`valor`
`orderBy`	query	`string`	opcional	Ex.: "Name asc", "Code desc", "Ispb asc". Opcional.	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`page`	`integer`	opcional	—	—	`0`
`size`	`integer`	opcional	—	—	`0`
`total`	`integer`	opcional	—	—	`0`
`items`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `items`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`ispb`	`integer (int64)`	opcional	—	—	`0`
`code`	`integer`	opcional	—	—	`0`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`

Exemplo de resposta

{
  "page": 0,
  "size": 0,
  "total": 0,
  "items": [
    {
      "ispb": 0,
      "code": 0,
      "name": "Fulano de Tal"
    }
  ]
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	(items, total)

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/Account/Banks" \
  -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/Account/Banks";

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/Account/Banks`, {
  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