GOgocardless
Institution

List Institutions

Returns a list of supported institutions.

get/institutions

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

country_codestring

ISO 3166-1 alpha-2 code. The country code of the institution. If nothing is provided, institutions with the country code 'GB' are returned by default.

Example:GB
schemestring

The scheme that institutions support. The available options include faster_payments, sepa_credit_transfer, and sepa_instant_credit_transfer. If nothing is provided, no scheme filter is applied to the returned institutions.

Example:faster_payments
featurestring

The feature that institutions support. The available options include pis, vrp_sweeping, and vrp_commercial. If nothing is provided, institutions supporting 'pis' are returned by default.

Example:pis
branch_codestring

(Currently only supports UK sort-codes) The six-digit number that identifies both the bank and the specific branch where an account is held, eg. '601234'.

Example:601234
include_disabled'true' | 'false'

Indicates whether to include temporarily disabled institutions in the response. If not provided or set to false, only enabled institutions will be returned.

Example:true

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "institutions": [
    {
      "id": "monzo",
      "name": "VAT",
      "icon_url": "https://gocardless/assets/icons/monzo",
      "logo_url": "https://gocardless/assets/logos/monzo",
      "roles": [
        "corporate_accounts",
        "funds_confirmation"
      ],
      "country_code": "GB",
      "status": "enabled"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.