TRtruelayer
Payments providers

Get payments provider

Returns payments provider details.

This API can be called without the need for authentication.

get/v3/payments-providers/{id}

Request

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

Path parameters

idstring required

Unique ID for the Provider

Example:ob-bank-name

ID of the payment provider.

Query parameters

client_idstring

ID of the client.

icon_typestring

Configuration for the type of icon. Available options are:

  • default: Default icon with no background (SVG).
  • extended: Extended to a square with an appropriate background colour (SVG).
  • extended_small: Extended icon with a 192x192 pixel resolution (JPEG).
  • extended_medium: Extended icon with a 432x432 pixel resolution (JPEG).
  • extended_large: Extended icon with an 864x864 pixel resolution (JPEG).

Response

Payment provider

idstring required

Unique ID for the Provider

display_namestring
icon_uristring uri
logo_uristring uri
bg_colorstring

pattern: ^#[A-F0-9]{6}$

country_code'AT' | 'BE' | 'DE' | 'DK' | 'ES' | 'FI' | 'FR' | 'GB' | 'IE' | 'IT' | 'LT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO'
swift_codestring

ISO 9362 international standard for Business Identifier Codes (BIC)

Example response

{
  "id": "ob-bank-name",
  "display_name": "Bank Name",
  "icon_uri": "https://truelayer-provider-assets.s3.amazonaws.com/global/icon/generic.svg",
  "logo_uri": "https://truelayer-provider-assets.s3.amazonaws.com/global/logos/generic.svg",
  "bg_color": "#000000",
  "swift_code": "MOCKGB01XXX",
  "capabilities": {
    "payments": {
      "bank_transfer": {
        "schemes": [
          {
            "id": "faster_payments_service"
          }
        ]
      }
    },
    "mandates": {
      "vrp_commercial": {
        "use_cases": [
          "charity"
        ]
      }
    }
  },
  "bin_ranges": [
    {
      "from": 51685900,
      "to": 51685999
    }
  ]
}

Changes

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