GOgocardless
Institution

List institutions for Billing Request

Returns all institutions valid for a Billing Request.

This endpoint is currently supported only for FasterPayments.

<p class="restricted-notice"><strong>Restricted</strong>: this endpoint is restricted to [GoCardless Pro](https://gocardless.com/pricing) and [GoCardless Enterprise](https://gocardless.com/pricing) accounts with the [custom payment pages upgrade](https://hub.gocardless.com/s/article/Custom-payment-pages).</p>
get/billing_requests/{billing_request_id}/institutions

Request

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

Path parameters

billing_request_idstring required

The billing request id

Query parameters

searchstring
Example:monzo

A search substring for retrieving institution(s), based on the institution's name.

idsstring
Example:monzo,revolut,barclays

ID(s) of the institution(s) to retrieve. More than one ID can be specified using a comma-separated string.

country_codestring required

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
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",
      "country_code": "GB",
      "autocompletes_collect_bank_account": true,
      "status": "enabled"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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