---
title: "List providers"
method: GET
path: "/v3/providers"
tags: ["Providers"]
---

# List providers

`GET /v3/providers`

Return a list of supported providers

## Query parameters

- `limit` number
- `country_code` 'FR' | 'ES' | 'IT' | 'PT' | 'DE' | 'BE' | 'NL' | 'LU' | 'PL' | 'HU' | 'IE' | 'MT' | 'CZ' | 'NO' | 'BG' | 'SE' | 'DK' | 'AT' | 'SK' | 'FI' | 'GB' | 'GR' | 'EE' | 'IS' | 'CY' | 'HR' | 'LV' | 'RO'
- `capabilities` 'aggregation' | 'account_check' | 'aggregation' | 'single_payment' | 'single_payment_scheduled' | 'instant_single_payment' | 'bulk_payment' | 'bulk_payment_scheduled'
- `aggregation_release_status` 'beta' | 'active' | 'deprecated' | 'retired'
- `payment_release_status` 'beta' | 'active' | 'deprecated' | 'retired'
- `segment` 'b2c' | 'b2b'
- `aggregation_provider_environments` 'prod' | 'sandbox'
- `payment_provider_environments` 'prod' | 'sandbox'

## Response `200`

List providers

- object — Represent paginated collection of resources.
  - `resources` Provider[]
    - `id` number, required — Provider's unique identifier
    - `name` string, required — Provider's name
    - `group_name` string — If the provider can be grouped, then we will expose its group name here
    - `country_code` 'FR' | 'ES' | 'IT' | 'PT' | 'DE' | 'BE' | 'NL' | 'LU' | 'PL' | 'HU' | 'IE' | 'MT' | 'CZ' | 'NO' | 'BG' | 'SE' | 'DK' | 'AT' | 'SK' | 'FI' | 'GB' | 'GR' | 'EE' | 'IS' | 'CY' | 'HR' | 'LV' | 'RO', required — Provider's ISO 3166-1 alpha-2 country code
    - `images` object — List of provider images, primarily logos
      - `logo` string, url — Provider's logo
    - `capabilities` string[], required — An array of the provider capabilities
    - `aggregation_metadata` object — Properties and available features relative to the aggregation and account capabilities
      - `release_status` 'beta' | 'active' | 'deprecated' | 'retired' — Deployment state of the providers' aggregation capabilities
    - `payment_metadata` object — Properties and available features relative to all the payment capabilities
      - `release_status` 'beta' | 'active' | 'deprecated' | 'retired' — Deployment state of the providers' payment capabilities
      - `nb_max_transactions` number — The maximum number of transactions allowed per payment
      - `max_size_label` number — The maximum length of the transaction label, in characters
      - `sender_iban_available` boolean — Indicates whether the sender's IBAN information (IBAN of the payer's account) is available
      - `provider_environments` string[] — Supported Bridge environments for using payment with this provider
      - `execution_status_available` boolean — Indicates if the provider can provide execution status for payments
    - `health_status` object — Provider's health status by capability
      - `aggregation` object — Health status for the aggregation and account check capabilities
        - `status` 'healthy' | 'degraded' | 'down'
      - `single_payment` object — Health status for the single payment capability
        - `status` 'healthy' | 'degraded' | 'down'
    - `tags` object — Complementary metadata about the institution abstracted by the provider
      - `segment` string[] — Specifies the target market of the provider with possible values being `b2c` for individual consumers and `b2b` for businesses
      - `region` unknown[] — Indicates the geographical areas where the provider operates
        - unknown
      - `keywords` string[] — Array of strings associated to the provider's name
  - `pagination` object
    - `next_uri` string, nullable

## Other responses

- `401` — Error 401

---

[API](https://skmtc.dev/bridgeapi/apis/bridge-api.md) · [All operations](https://skmtc.dev/bridgeapi/apis/bridge-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bridgeapi/bridge-api/revisions/9b9ad8010fd5/schema)