---
title: "Get providers"
method: GET
path: "/v2/single-immediate-payments-providers"
tags: ["Payments"]
---

# Get providers

`GET /v2/single-immediate-payments-providers`

## Request

- Base URL: `https://pay-api.truelayer-sandbox.com`
- URL: `https://pay-api.truelayer-sandbox.com/v2/single-immediate-payments-providers`
- Auth: none required

Returns a list of providers supported. Various query parameters can be used to filter returned providers.

## Query parameters

- `account_type` string
- `auth_flow_type` string
- `currency` string
- `client_id` string
- `additional_input_type` string
- `country` string
- `release_channel` string

## Response `200`

List of providers

- ProvidersResponse
  - `results` Provider[]
    - `provider_id` string: This is the provider ID that you will send us in the create payment request.
    - `logo_url` string: This is the address of the logo asset in SVG form.
    - `icon_url` string: This is the address of the icon asset in SVG form.
    - `display_name` string: This is a readable name for the provider.
    - `country` string: The ISO 3166-1 alpha-2 country code for the provider.
    - `divisions` string[]: This array includes all divisions that are available on this provider, e.g. retail and business would indicate you can use this single provider to access both retail and business accounts.
    - `single_immediate_payment_schemes` SingleImmediatePaymentScheme[]
      - `scheme_id` 'faster_payments_service': A unique identifier for the scheme, shared across providers. This should be provided on the single_immediate_payment.scheme_id field on the initiation request.
      - `fee_options` FeeOption[]: If present, then fees are payable to make a payment on the scheme, and you must choose an option in this list when initiating a payment.
        - `fee_option_id` string: A unique identifier for the fee option, shared across providers. This should be provided on the single_immediate_payment.fee_option_id field on the initiation request.
        - `beneficiary_fee` 'free' | 'payable' | 'unknown': A value to indicate if the beneficiary would pay any fees on the transaction, when using this fee option.
        - `remitter_fee` 'free' | 'payable' | 'unknown': A value to indicate if the remitter would pay any fees on the transaction, when using this fee option.
      - `requirements` Requirement[]: Contains at least one set of requirements, one of which should be adhered to in order to create a valid initiation request for the scheme.
        - `auth_flow` AuthFlow
          - `types` 'embedded' | 'redirect', required
          - `embedded` Embedded
            - `additional_input_types` string[], required: A list of additional input field types that may be returned during the embedded authorisation flow (not inclusive of those required on initiation below).
            - `additional_inputs` union: An optional dictionary of ID to additional inputs that must be collected from the end user to initiate a payment. These inputs should be provided using the same IDs in the auth_flow.additional_inputs string dictionary on the initiation request
              - …
          - `redirect` Redirect
            - `psu_ip_address_required` boolean: Indicates if auth_flow.psu_ip_address is required on the initiation request.
            - `data_access_token_supported` boolean: Indicates if auth_flow.data_access_token can be provided on the initiation request, to maintain long lived consents across products (Data API and Payment API), where the provider only allows a single active consent across both AIS and PIS services.
            - `additional_inputs` union: An optional dictionary of ID to additional inputs that must be collected from the end user to initiate a payment. These inputs should be provided using the same IDs in the auth_flow.additional_inputs string dictionary on the initiation request
              - …
        - `single_immediate_payment` SingleImmediatePaymentRequirement
          - `currency` Currency
            - `supported_currencies` string[]
          - `beneficiary` Beneficiary
            - `account` Account, required: A list of account types supported by the scheme.
              - …
            - `name` object: An object detailing the requirements for the name, if omitted then setting the name on the initiation request is not supported for this scheme.
              - …
          - `remitter` Remitter
            - `account` Account, required: A list of account types supported by the scheme.
              - …
            - `name` object: An object detailing the requirements for the name, if omitted then setting the name on the initiation request is not supported for this scheme.
              - …
            - `mandatory` boolean
    - `availability` ProviderAvailability
      - `recommended_status` 'healthy' | 'unhealthy', required
      - `updated_at` string, date-time, required: The point in time when this data was collected. Value is in UTC.

## Other responses

- `403`: Your are not authorised for the action
- `500`: Internal error

---

[API](https://skmtc.dev/truelayer/apis/legacy-payments-api.md) - [All operations](https://skmtc.dev/truelayer/apis/legacy-payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/legacy-payments-api/revisions/cd2e1466caa0?raw)