---
title: "Get payments provider"
method: GET
path: "/v3/payments-providers/{id}"
tags: ["Payments providers"]
---

# Get payments provider

`GET /v3/payments-providers/{id}`

## Request

- Base URL: `https://api.truelayer-sandbox.com`
- URL: `https://api.truelayer-sandbox.com/v3/payments-providers/{id}`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://auth.truelayer.com/connect/token` scopes: `payments`
  - HTTP bearer
  - HTTP bearer

Returns payments provider details.

This API can be called without the need for authentication.

## Path parameters

- `id` string, required: Unique ID for the Provider

## Query parameters

- `client_id` string
- `icon_type` string

## Response `200`

Payment provider

- PaymentsProvider
  - `id` string, required: Unique ID for the Provider
  - `display_name` string
  - `icon_uri` string, uri
  - `logo_uri` string, uri
  - `bg_color` string: pattern: `^#[A-F0-9]{6}$`
  - `country_code` 'AT' | 'BE' | 'DE' | 'DK' | 'ES' | 'FI' | 'FR' | 'GB' | 'IE' | 'IT' | 'LT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO'
  - `swift_code` string: ISO 9362 international standard for Business Identifier Codes (BIC)
  - `capabilities` ProviderCapabilities, required: Describes the capabilities of this provider. By default, will only display capabilities in `general_availability` or `public beta`. If `client_id` is available, will display capabilities available to the client.
    - `payments` object: Single payment initiation capabilities.
      - `bank_transfer` object: Bank transfer capability.
        - `release_channel` 'general_availability' | 'public_beta' | 'private_beta' | 'alpha', required
        - `availability` ProviderAvailability: Whether the provider is currently available. > 🚧 This feature is in beta
          - `recommended_status` 'healthy' | 'unhealthy', required
          - `updated_at` string, date-time, required: The point in time when this data was collected. Value is in UTC.
        - `schemes` PaymentsProviderScheme[], required: List of payment schemes supported by this provider.
          - `id` string, required: The unique identifier for the scheme.
    - `mandates` object: Recurring payment mandate creation capabilities.
      - `vrp_sweeping` object: Mandates for the sweeping use case.
        - `release_channel` 'general_availability' | 'public_beta' | 'private_beta' | 'alpha', required
        - `availability` ProviderAvailability: Whether the provider is currently available. > 🚧 This feature is in beta
          - `recommended_status` 'healthy' | 'unhealthy', required
          - `updated_at` string, date-time, required: The point in time when this data was collected. Value is in UTC.
      - `vrp_commercial` object: Mandates for the commercial use case.
        - `release_channel` 'general_availability' | 'public_beta' | 'private_beta' | 'alpha', required
        - `availability` ProviderAvailability: Whether the provider is currently available. > 🚧 This feature is in beta
          - `recommended_status` 'healthy' | 'unhealthy', required
          - `updated_at` string, date-time, required: The point in time when this data was collected. Value is in UTC.
        - `use_cases` MandateVrpCommercialUseCase[], required: List of use cases supported by this provider.
      - `direct_debit` object: Direct Debit mandates.
        - `release_channel` 'general_availability' | 'public_beta' | 'private_beta' | 'alpha', required
  - `bin_ranges` object[]: A list of BIN (Bank Identification Numbers) ranges supported by the provider. Based on the ISO/IEC 7812-1:2017 BIN refers to the first eight numbers on a payment card, identifying the financial institution that issues the card.
    - `from` integer, required: The starting number of the BIN range (inclusive). A valid integer must represent the first eight digits of a payment card number.
    - `to` integer, required: The ending number of the BIN range (inclusive). A valid integer must represent the first eight digits of a payment card number.

## Other responses

- `404`: Provider Not Found
- `500`: Unknown Error

---

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