GET
/
api
/
institutions
curl --request GET \
  --url https://api.atoa.me/api/institutions
[
  {
    "id": "lloyds",
    "name": "Lloyds (Personal)",
    "fullName": "Lloyds (Personal)",
    "media": [
      {
        "type": "icon",
        "source": "https://atoa-static-images.s3.eu-west-2.amazonaws.com/bank_logos/v3/lloyds_4x.webp"
      },
      {
        "type": "logo",
        "source": "https://atoa-static-images.s3.eu-west-2.amazonaws.com/bank_logos/v3/lloyds_4x.webp"
      }
    ],
    "features": [
      "INITIATE_DOMESTIC_SINGLE_PAYMENT",
      "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING",
      "ACCOUNT_TRANSACTIONS",
      "ACCOUNTS",
      "ACCOUNT",
      "READ_DOMESTIC_SINGLE_REFUND",
      "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING"
    ],
    "enabled": true,
    "orderBy": 999,
    "popularBank": false,
    "bankPhoneNumber": null,
    "transactionAmountLimit": null,
    "businessBank": null,
    "bankCode": "LOYD"
  },
  {
    "id": "bankofscotland",
    "name": "Bank of Scotland (Personal)",
    "fullName": "Bank of Scotland (Personal)",
    "media": [
      {
        "type": "logo",
        "source": "https://atoa-static-images.s3.eu-west-2.amazonaws.com/bank_logos/v3/bank_of_scotland_4x.webp"
      },
      {
        "type": "icon",
        "source": "https://atoa-static-images.s3.eu-west-2.amazonaws.com/bank_logos/v3/bank_of_scotland_4x.webp"
      }
    ],
    "features": [
      "INITIATE_DOMESTIC_SINGLE_PAYMENT",
      "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING",
      "ACCOUNT_TRANSACTIONS",
      "ACCOUNTS",
      "ACCOUNT",
      "READ_DOMESTIC_SINGLE_REFUND"
    ],
    "enabled": true,
    "orderBy": 999,
    "popularBank": false,
    "bankPhoneNumber": null,
    "transactionAmountLimit": null,
    "businessBank": null,
    "bankCode": "BOFS"
  },
  {
    "id": "rbs",
    "name": "Royal Bank of Scotland",
    "fullName": "Royal Bank of Scotland",
    "media": [
      {
        "type": "logo",
        "source": "https://atoa-static-images.s3.eu-west-2.amazonaws.com/bank_logos/v3/rbs_4x.webp"
      },
      {
        "type": "icon",
        "source": "https://atoa-static-images.s3.eu-west-2.amazonaws.com/bank_logos/v3/rbs_4x.webp"
      }
    ],
    "features": [
      "INITIATE_DOMESTIC_SINGLE_PAYMENT",
      "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING",
      "ACCOUNT_TRANSACTIONS",
      "ACCOUNTS",
      "ACCOUNT"
    ],
    "enabled": true,
    "orderBy": 999,
    "popularBank": false,
    "bankPhoneNumber": null,
    "transactionAmountLimit": null,
    "businessBank": null,
    "bankCode": "RBSS"
  }
]

Retrieve a comprehensive list of available institutions, accompanied by their respective images.

Response

id
string

Unique Institution id

name
string

Name of the Institution

fullName
string

Full name of the Institution

media
array
features
array

List of supported features for this institution (e.g., INITIATE_DOMESTIC_SINGLE_PAYMENT, ACCOUNT_TRANSACTIONS)

enabled
boolean

Whether the institution is currently enabled

orderBy
number

Sort order for displaying the institution

popularBank
boolean

Whether the institution is marked as a popular bank

bankPhoneNumber
string

Phone number of the bank (if available)

transactionAmountLimit
number

Transaction amount limit for the institution (if applicable)

businessBank
boolean

Whether this is a business banking institution

bankCode
string

Bank identifier code (e.g., SWIFT/BIC code)

Get RefundsCreate webhook event