Site

List Institutions

List Institutions

get

This endpoint returns the list of available financial institutions.

scope: institutions.read

Query parameters
ispbstringOptional

Filter by ISPB of the institution

numberstringOptional

Filter by number of the institution

Header parameters
AcceptstringOptionalExample: application/json
Content-TypestringOptionalExample: application/json
X-API-KeystringRequiredExample: {{API_KEY}}
Responses
200

Success

application/json
get
GET /banking/v1/institutions HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Accept: */*

{
  "data": [
    {
      "id": "c97e8548-d870-462f-847d-57f06c95dc22",
      "ispb": "00000000",
      "name": "BCO DO BRASIL S.A.",
      "full_name": "Banco do Brasil S.A.",
      "number": "001",
      "display_name": "001 - 00000000 - Banco do Brasil S.A."
    },
    {
      "id": "e5fc9bca-4ac3-459f-b7dd-3ad9cfc7899d",
      "ispb": "00000208",
      "name": "BRB - BCO DE BRASILIA S.A.",
      "full_name": "BRB - BANCO DE BRASILIA S.A.",
      "number": "070",
      "display_name": "070 - 00000208 - BRB - BANCO DE BRASILIA S.A."
    }
  ]
}
PreviousInstitutionsNextCounterparties