Skip to main content
GET
/
pix
/
financial_institutions
Get Financial Institution
curl --request GET \
  --url https://production.api.noodle.cx/external/pix/financial_institutions \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "is_active": true,
      "is_compe_participant": true,
      "name": "<string>",
      "str_start_date": "2023-12-25",
      "compe_number": "<string>",
      "ispb_number": "<string>"
    }
  ],
  "pagination": {
    "current_page": 123,
    "rows_per_page": 123,
    "total_pages": 123,
    "total_rows": 123,
    "next_page": 123
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

name
string

Nome da instituição financeira.

min_str_start_date
string

Data mínima de início da operação.

max_str_start_date
string

Data máxima de início da operação.

page_number
integer

Página atual que está sendo consultada.

page_size
integer

Quantidade de resultados por página.

Response

Successful Response

Representa a resposta completa da API de bancos.

data
Bank · object[]
required
pagination
Pagination · object
required

Representa os dados de paginação da resposta.