Barclays FCA Service Metrics API

openapi: 3.1.0
info:
  title: FCA Service Metrics
  description: FCA Service Metric API
  version: v1
x-method: searched
x-source: https://developer.barclays.com/api/apis/versions/59f96026-03d6-4c4e-9567-c3db4dd83e3a.bdn/design?specification=oas31
x-harvested: '2026-09-04'
x-harvested-note: Verbatim OpenAPI 3.1 design export from the Barclays API Exchange registry (developer.barclays.com), fetched
  anonymously. The untouched export is in openapi/_original/barclays-fca-service-metrics-openapi.json. The UK Open Banking
  documents carry OBIE (openbanking.org.uk) in info.contact/termsOfService because they are the OBIE standard contract as
  Barclays implements and publishes it — the API, the registry record and the host are Barclays'.
tags:
- name: FCSSRVMBCA
  description: Endpoint for getting FCA Business Current Accounts Service Metrics data
- name: FCSSRVMPCA
  description: Endpoint for getting FCA Personal Current Accounts Service Metrics data
paths:
  /fca-service-metrics/bca:
    get:
      tags:
      - FCSSRVMBCA
      description: Gets a list of all `FCA Service Metrics` objects.
      operationId: get__fca-service-metrics_bca
      parameters:
      - name: If-Modified-Since
        in: header
        description: Used for conditional request, to retrieve data only if modified since a given date
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if modified since a given date
          example: null
      - name: If-None-Match
        in: header
        description: Used for conditional request, to retrieve data only if the given Etag value does not match
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if the given Etag value does not match
          example: null
      responses:
        default:
          description: A standard error response.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaFault_default_schema_'
              example: null
        '200':
          description: Successful response with a list of `FCA Service Metrics` data
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Etag:
              description: A unique ID identifying whether this resource has changed
              schema:
                description: A unique ID identifying whether this resource has changed
                example: null
            Cache-Control:
              description: Describes how long this response can be cached
              schema:
                default: max-age=28800
                description: Describes how long this response can be cached
                example: null
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaResponseMessage_200_schema_'
              example: null
        '400':
          description: You have sent a request which could not be understood.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaFault_400_schema_'
              example: null
        '500':
          description: An error occurred on the server. No further information is available.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaFault_500_schema_'
              example: null
        '503':
          description: The service is temporarily unavailable.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaFault_503_schema_'
              example: null
        '429':
          description: You have requested this resource too often. Slow down.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaFault_429_schema_'
              example: null
        '408':
          description: Your client has failed to submit a request, and a timeout has occurred.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_bcaFault_408_schema_'
              example: null
    head:
      tags:
      - FCSSRVMBCA
      description: Gets header information on the current set of `FCA Service Metrics` data
      operationId: head__fca-service-metrics_bca
      parameters:
      - name: If-Modified-Since
        in: header
        description: Used for conditional request, to retrieve data only if modified since a given date
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if modified since a given date
          example: null
      - name: If-None-Match
        in: header
        description: Used for conditional request, to retrieve data only if the given Etag value does not match
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if the given Etag value does not match
          example: null
      responses:
        default:
          description: No response
          content:
            application/prs.openbanking.opendata.v1.0+json: {}
  /fca-service-metrics/pca:
    get:
      tags:
      - FCSSRVMPCA
      description: Gets a list of all `FCA Service Metrics` objects.
      operationId: get__fca-service-metrics_pca
      parameters:
      - name: If-Modified-Since
        in: header
        description: Used for conditional request, to retrieve data only if modified since a given date
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if modified since a given date
          example: null
      - name: If-None-Match
        in: header
        description: Used for conditional request, to retrieve data only if the given Etag value does not match
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if the given Etag value does not match
          example: null
      responses:
        default:
          description: A standard error response.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaFault_default_schema_'
              example: null
        '200':
          description: Successful response with a list of `FCA Service Metrics` data
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Etag:
              description: A unique ID identifying whether this resource has changed
              schema:
                description: A unique ID identifying whether this resource has changed
                example: null
            Cache-Control:
              description: Describes how long this response can be cached
              schema:
                default: max-age=28800
                description: Describes how long this response can be cached
                example: null
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaResponseMessage_200_schema_'
              example: null
        '400':
          description: You have sent a request which could not be understood.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaFault_400_schema_'
              example: null
        '500':
          description: An error occurred on the server. No further information is available.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaFault_500_schema_'
              example: null
        '503':
          description: The service is temporarily unavailable.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaFault_503_schema_'
              example: null
        '429':
          description: You have requested this resource too often. Slow down.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaFault_429_schema_'
              example: null
        '408':
          description: Your client has failed to submit a request, and a timeout has occurred.
          headers:
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                default: DENY
                description: Prevent this request from being loaded in any iframes
                example: null
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                default: max-age=31536000
                description: HTTPS strict transport security header
                example: null
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                default: nosniff
                description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
                example: null
            Status_Code:
              description: The HTTP status code defining the error
          content:
            application/prs.openbanking.opendata.v1.0+json:
              schema:
                $ref: '#/components/schemas/get__fca-service-metrics_pcaFault_408_schema_'
              example: null
    head:
      tags:
      - FCSSRVMPCA
      description: Gets header information on the current set of `FCA Service Metrics` data
      operationId: head__fca-service-metrics_pca
      parameters:
      - name: If-Modified-Since
        in: header
        description: Used for conditional request, to retrieve data only if modified since a given date
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if modified since a given date
          example: null
      - name: If-None-Match
        in: header
        description: Used for conditional request, to retrieve data only if the given Etag value does not match
        required: false
        schema:
          description: Used for conditional request, to retrieve data only if the given Etag value does not match
          example: null
      responses:
        default:
          description: No response
          content:
            application/prs.openbanking.opendata.v1.0+json: {}
components:
  schemas:
    get__fca-service-metrics_bcaFault_400_schema_:
      type: object
      additionalProperties: false
      properties:
        status:
          type: string
          enum:
          - '400'
        title:
          type: string
          enum:
          - Bad request
        description:
          type: string
          enum:
          - You have sent a request which could not be understood.
      required:
      - description
      - status
      - title
      title: 400 Error object
    get__fca-service-metrics_pcaFault_429_schema_:
      type: object
      additionalProperties: false
      properties:
        status:
          type: string
          enum:
          - '429'
        title:
          type: string
          enum:
          - Too many requests
        description:
          type: string
          enum:
          - You have requested this resource too often. Slow down.
      required:
      - description
      - status
      - title
      title: 429 Error object
    get__fca-service-metrics_pcaResponseMessage_200_schema_:
      type: object
      additionalProperties: false
      properties:
        meta:
          type: object
          additionalProperties: false
          properties:
            LastUpdated:
              type: string
              format: date-time
            TotalResults:
              type: integer
            Agreement:
              type: string
              enum:
              - Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms
                and conditions
            License:
              type: string
              format: uri
              description: Open Banking License
              enum:
              - https://www.openbanking.org.uk/open-licence
            TermsOfUse:
              type: string
              format: uri
              description: Open Banking Terms of Use
              enum:
              - https://www.openbanking.org.uk/terms
          required:
          - Agreement
          - LastUpdated
          - License
          - TermsOfUse
          - TotalResults
          title: Meta data
        data:
          type: array
          items:
            type: object
            description: Brand owned by an organisation
            properties:
              Brand:
                type: array
                additionalProperties: false
                description: Brand owned by an organisation
                items:
                  type: object
                  description: Brand owned by an organisation
                  properties:
                    BrandName:
                      type: string
                      description: Brand Name that an organisation uses to market its products or services to a consumer
                      maxLength: 140
                      minLength: 1
                      title: BrandName
                    PublicationDate:
                      type: string
                      format: date
                      description: Date when this metrics was made available.
                      title: PublicationDate
                    MeasurementPeriodStartDate:
                      type: string
                      format: date
                      description: The start date of the current account measurement period
                      title: MeasurementPeriodStartDate
                    MeasurementPeriodEndDate:
                      type: string
                      format: date
                      description: The end date of the current account measurement period
                      title: MeasurementPeriodEndDate
                    Notes:
                      type: string
                      description: Specify any note that helps Banks to describe the Service Metrics Data related to a particular
                        Brand. One example to describe, why the Service Metrics data is not available.
                      maxLength: 2000
                      minLength: 1
                      title: Notes
                    ServicesMatterAvailability:
                      type: object
                      additionalProperties: false
                      description: This section hold info related to Matters(Services) which can be discussed by Banks customer.
                      properties:
                        ServicesMatterAvailabilityDetails:
                          type: array
                          additionalProperties: false
                          description: Hold info related to Services which can be discussed by an account holder
                          items:
                            type: object
                            description: Hold info related to Services which can be discussed by an account holder
                            properties:
                              MatterType:
                                type: string
                                enum:
                                - HelpOpeningAccount
                                - CheckBalanceTransaction
                                - CancellingCheque
                                - CashWithdrawalForexOutsideUK
                                - CollectPaymentViaCard
                                - SendingMoneyOutsideUK
                                - ReportFraudulentIncident
                                - DenialLackOfFunds
                                - Other
                                - PayingInCheque
                                - ProgressAccountCardSuspension
                                - ProblemUsingMobileInternetBanking
                                - SendingMoneyWithinUK
                                - AccessViaPowerOfAttorney
                                title: MatterType
                              24HourHelp:
                                type: string
                                description: Indicates whether this contact type  is available 24 hours.
                                enum:
                                - InSomeCases
                                - NotPossible
                                - 'No'
                                - 'Yes'
                                title: 24HourHelp
                              OtherMatterType:
                                type: array
                                additionalProperties: false
                                description: Other code set which is not available in the standard MatterAvailabilityCode
                                  set
                                items:
                                  type: object
                                  description: Other code set which is not available in the standard MatterAvailabilityCode
                                    set
                                  properties:
                                    Code:
                                      type: string
                                      description: The four letter Mnemonic used within an XML file to identify a code
                                      maxLength: 4
                                      minLength: 0
                                      pattern: ^\w{0,4}$
                                      title: Code
                                    Name:
                                      type: string
                                      description: Long name associated with the code
                                      maxLength: 70
                                      minLength: 1
                                      title: Name
                                    Description:
                                      type: string
                                      description: Description to describe the purpose of the code
                                      maxLength: 350
                                      minLength: 1
                                      title: Description
                                  required:
                                  - Description
                                  - Name
                                title: OtherMatterType
                              ContactDetails:
                                type: array
                                additionalProperties: false
                                description: Describes the communication channel detail which can be used by an account holder
                                  to either discuss a matter or do action
                                items:
                                  type: object
                    

# --- truncated at 32 KB (216 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/barclays/refs/heads/main/openapi/barclays-fca-service-metrics-openapi.yml