Financial Institutions

GET https://api-sandbox.epag.io/financialInstitution

This endpoint retrieves the details of financial institutions.

Authorization

Header	Value
X-Auth-Token	MY_ACCESS_TOKEN

Example Request

200 - Success

Example Request

200 - Success

    curl --location 'https://api-sandbox.epag.io/financialInstitution?country=BR' \
    --header 'X-Auth-Token: MY_ACCESS_TOKEN'

Example Response

Header

  Content-Type: application/json

Body

    {
      "financial_institutions": [
        {
          "code": "246",
          "name": "BCO ABC BRASIL S.A.",
          "full_name": "Banco ABC Brasil S.A."
        }
      ],
      "refresh_token": "MY_ACCESS_TOKEN"
    }

200 - Filtered By Code

Example Request

200 - Filtered By Code

  curl --location 'https://api-sandbox.epag.io/financialInstitution/246?country=BR' \
  --header 'X-Auth-Token: MY_ACCESS_TOKEN'

Example Response

Header

  Content-Type: application/json

Body

    {
      "financial_institutions": [
        {
          "code": "246",
          "name": "BCO ABC BRASIL S.A.",
          "full_name": "Banco ABC Brasil S.A."
        }
      ],
      "refresh_token": "MY_ACCESS_TOKEN"
    }

401 - Unauthorized

Example Request

401 - Unauthorized

    curl --location 'https://api-sandbox.epag.io/financialInstitution?country=BR' \
    --header 'X-Auth-Token: INVALID_ACCESS_TOKEN'

Example Response

Header

  Content-Type: application/json

Body

  {
    "timestamp": "2024-05-15T19:52:26.833+00:00",
    "status": 401,
    "error": "Unauthorized",
    "message": "Access Denied",
    "path": "/financialInstitution"
  }