Weatherbys Bank Branch API

openapi: 3.2.0
info:
  version: v2.3
  title: Open Data Branch API
  description: Latest Swagger specification for OpenData Branch Locator
servers:
- url: https://developer.openbanking.org.uk/open-banking/v2.3
tags:
- name: Branch
  description: Endpoint for getting Branch data
paths:
  /branches:
    get:
      tags:
      - Branch
      description: Gets a list of all `Branch` objects.
      parameters:
      - name: If-Modified-Since
        description: Used for conditional request, to retrieve data only if modified since a given date
        in: header
        required: false
        schema:
          type: string
      - name: If-None-Match
        description: Used for conditional request, to retrieve data only if the given Etag value does not match
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response with a list of `Branch` data
          headers:
            Strict-Transport-Security:
              description: HTTPS strict transport security header
              schema:
                type: string
                default: max-age=31536000
            Etag:
              description: A unique ID identifying whether this resource has changed
              schema:
                type: string
            Cache-Control:
              description: Describes how long this response can be cached
              schema:
                type: string
                default: max-age=28800
            X-Frame-Options:
              description: Prevent this request from being loaded in any iframes
              schema:
                type: string
                default: DENY
            X-Content-Type-Options:
              description: Ensures each page has a content type and prevents browsers from doing MIME type sniffing
              schema:
                type: string
                default: nosniff
          content:
            application/prs.openbanking.opendata.v2.3+json:
              schema:
                type: object
                properties:
                  meta:
                    title: Meta data
                    type: object
                    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:
                        description: Open Banking License
                        type: string
                        format: uri
                        enum:
                        - https://www.openbanking.org.uk/open-licence
                      TermsOfUse:
                        description: Open Banking Terms of Use
                        type: string
                        format: uri
                        enum:
                        - https://www.openbanking.org.uk/terms
                    required:
                    - LastUpdated
                    - TotalResults
                    - Agreement
                    - License
                    - TermsOfUse
                    additionalProperties: false
                  data:
                    type: array
                    items:
                      properties:
                        Brand:
                          description: Brand owned by an organisation
                          type: array
                          title: Brand
                          items:
                            description: Brand owned by an organisation
                            type: object
                            properties:
                              BrandName:
                                description: Brand Name that an organisation uses to market its products or services to a consumer
                                title: BrandName
                                type: string
                                minLength: 1
                                maxLength: 140
                              Branch:
                                description: Information that locates and identifies a specific branch of a financial institution.
                                type: array
                                title: Branch
                                items:
                                  description: Information that locates and identifies a specific branch of a financial institution.
                                  type: object
                                  properties:
                                    Identification:
                                      description: Unique and unambiguous identification of a branch of a financial institution.
                                      title: Identification
                                      type: string
                                      minLength: 1
                                      maxLength: 35
                                    SequenceNumber:
                                      description: Sequence Number that is used in conjunction with Identification to uniquely identify a branch. Physical branches should have 0 assigned, mobile and sub branches should have 1,2,3....etc. assigned.
                                      title: SequenceNumber
                                      type: string
                                      minLength: 1
                                      maxLength: 35
                                    Name:
                                      description: Name by which a branch is known and which is usually used to identify that branch.
                                      title: Name
                                      type: string
                                      minLength: 1
                                      maxLength: 140
                                    Type:
                                      description: Codeset to indicate if a branch is physically in 1 location or is mobile
                                      title: Type
                                      type: string
                                      enum:
                                      - Mobile
                                      - Physical
                                    SortCode:
                                      description: United Kingdom (UK) Sort Code - identifies British financial institutions on the British national clearing systems. The sort code, which is a six-digit number, is usually formatted as three pairs of numbers, for example 12-34-56. It identifies both the bank and the branch(s) where the account is held.
                                      title: SortCode
                                      type: array
                                      items:
                                        description: maxLength 8 text
                                        type: string
                                        minLength: 1
                                        maxLength: 8
                                    Photo:
                                      description: Image related to the branch
                                      title: Photo
                                      type: string
                                    CustomerSegment:
                                      description: The marketing segment which the branch is able to address in terms of customer type. Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another
                                      title: CustomerSegment
                                      type: array
                                      items:
                                        description: The marketing segment which the branch is able to address in terms of customer type. Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another
                                        type: string
                                        enum:
                                        - Business
                                        - Corporate
                                        - Other
                                        - Personal
                                        - Private
                                        - Premier
                                        - Select
                                        - SME
                                        - Wealth
                                      minItems: 1
                                    ServiceAndFacility:
                                      description: Service/Facilities offered at a branch.
                                      title: ServiceAndFacility
                                      type: array
                                      items:
                                        description: Service/Facilities offered at a branch.
                                        type: string
                                        enum:
                                        - AssistedServiceCounter
                                        - ExternalATM
                                        - AccountVerificationService
                                        - BusinessCounter
                                        - BureauDeChange
                                        - BusinessDepositTerminal
                                        - BusinessITSupport
                                        - CardIssuanceFacility
                                        - CollectionLockers
                                        - CounterServices
                                        - ExternalQuickServicePoint
                                        - InternalQuickServicePoint
                                        - InternalATM
                                        - LodgementDevice
                                        - MortgageAdvisor
                                        - MeetingRooms
                                        - NightSafe
                                        - OnlineBankingPoint
                                        - OnDemandCurrency
                                        - Other
                                        - Parking
                                        - PremierCounter
                                        - QuickDeposit
                                        - SaturdayCounterService
                                        - StatementPrinter
                                        - SelfServiceAccountOpening
                                        - VideoBanking
                                        - WiFi
                                    Accessibility:
                                      description: Accessibility is the ability and ease a customer can access a service, good, associate, or facility. Features which make the Bank accessible to disabled people
                                      title: Accessibility
                                      type: array
                                      items:
                                        description: Accessibility is the ability and ease a customer can access a service, good, associate, or facility. Features which make the Bank accessible to disabled people
                                        type: string
                                        enum:
                                        - AutomaticDoors
                                        - AudioCashMachine
                                        - ExternalRamp
                                        - HelpingHandUnit
                                        - InductionLoop
                                        - InternalRamp
                                        - LevelAccess
                                        - LowerLevelCounter
                                        - Other
                                        - WheelchairAccess
                                    Note:
                                      description: Summary description of services, facility and availability.
                                      title: Note
                                      type: string
                                      minLength: 1
                                      maxLength: 2000
                                    OtherCustomerSegment:
                                      description: Enter a new code , name and description for any other Customer Segment
                                      type: array
                                      title: OtherCustomerSegment
                                      items:
                                        description: Enter a new code , name and description for any other Customer Segment
                                        type: object
                                        properties:
                                          Code:
                                            description: The four letter Mnemonic used within an XML file to identify a code
                                            title: Code
                                            type: string
                                            pattern: ^\w{0,4}$
                                            minLength: 0
                                            maxLength: 4
                                          Name:
                                            description: Long name associated with the code
                                            title: Name
                                            type: string
                                            minLength: 1
                                            maxLength: 70
                                          Description:
                                            description: Description to describe the purpose of the code
                                            title: Description
                                            type: string
                                            minLength: 1
                                            maxLength: 350
                                        required:
                                        - Name
                                        - Description
                                      additionalProperties: false
                                    OtherAccessibility:
                                      description: Enter any new code , name and description for any other Accessibility
                                      type: array
                                      title: OtherAccessibility
                                      items:
                                        description: Enter any new code , name and description for any other Accessibility
                                        type: object
                                        properties:
                                          Code:
                                            description: The four letter Mnemonic used within an XML file to identify a code
                                            title: Code
                                            type: string
                                            pattern: ^\w{0,4}$
                                            minLength: 0
                                            maxLength: 4
                                          Name:
                                            description: Long name associated with the code
                                            title: Name
                                            type: string
                                            minLength: 1
                                            maxLength: 70
                                          Description:
                                            description: Description to describe the purpose of the code
                                            title: Description
                                            type: string
                                            minLength: 1
                                            maxLength: 350
                                        required:
                                        - Name
                                        - Description
                                      additionalProperties: false
                                    OtherServiceAndFacility:
                                      description: Enter any new code , name and description for any Other Facility
                                      type: array
                                      title: OtherServiceAndFacility
                                      items:
                                        description: Enter any new code , name and description for any Other Facility
                                        type: object
                                        properties:
                                          Code:
                                            description: The four letter Mnemonic used within an XML file to identify a code
                                            title: Code
                                            type: string
                                            pattern: ^\w{0,4}$
                                            minLength: 0
                                            maxLength: 4
                                          Name:
                                            description: Long name associated with the code
                                            title: Name
                                            type: string
                                            minLength: 1
                                            maxLength: 70
                                          Description:
                                            description: Description to describe the purpose of the code
                                            title: Description
                                            type: string
                                            minLength: 1
                                            maxLength: 350
                                        required:
                                        - Name
                                        - Description
                                      additionalProperties: false
                                    Availability:
                                      description: Days and times defining when the branch is available for use by a customer
                                      type: object
                                      title: Availability
                                      properties:
                                        StandardAvailability:
                                          description: Standard hours of availability for the branch of the organisation
                                          type: object
                                          title: StandardAvailability
                                          properties:
                                            Day:
                                              description: Working day information
                                              type: array
                                              title: Day
                                              items:
                                                description: Working day information
                                                type: object
                                                properties:
                                                  Name:
                                                    description: Specifies the day of the week
                                                    title: Name
                                                    type: string
                                                    enum:
                                                    - Friday
                                                    - Monday
                                                    - Saturday
                                                    - Sunday
                                                    - Thursday
                                                    - Tuesday
                                                    - Wednesday
                                                  Notes:
                                                    description: Specify any note that is related the particular opening day e.g. Closed half day on Monday
                                                    title: Notes
                                                    type: string
                                                    minLength: 1
                                                    maxLength: 2000
                                                  OpeningHours:
                                                    description: Opening & Closing Times of a branch of an organisation
                                                    type: array
                                                    title: OpeningHours
                                                    items:
                                                      description: Opening & Closing Times of a branch of an organisation
                                                      type: object
                                                      properties:
                                                        OpeningTime:
                                                          description: 'A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.

                                                            Note on the time format:

                                                            1) beginning / end of calendar day

                                                            00:00:00 = the beginning of a calendar day

                                                            24:00:00 = the end of a calendar day

                                                            2) fractions of second in time format

                                                            Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.'
                                                          title: OpeningTime
                                                          type: string
                                                          pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                                        ClosingTime:
                                                          description: 'A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.

                                                            Note on the time format:

                                                            1) beginning / end of calendar day

                                                            00:00:00 = the beginning of a calendar day

                                                            24:00:00 = the end of a calendar day

                                                            2) fractions of second in time format

                                                            Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.'
                                                          title: ClosingTime
                                                          type: string
                                                          pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                                      required:
                                                      - OpeningTime
                                                      - ClosingTime
                                                    additionalProperties: false
                                                    minItems: 1
                                                required:
                                                - Name
                                                - OpeningHours
                                              additionalProperties: false
                                              minItems: 1
                                              maxItems: 7
                                          additionalProperties: false
                                          required:
                                          - Day
                                        NonStandardAvailability:
                                          description: Non-standard hours of availability for a branch of an organisation
                                          type: array
                                          title: NonStandardAvailability
                                          items:
                                            description: Non-standard hours of availability for a branch of an organisation
                                            type: object
                                            properties:
                                              Name:
                                                description: Name provided for non-standard opening periods e.g. Christmas
                                                title: Name
                                                type: string
                                                minLength: 1
                                                maxLength: 140
                                              StartDate:
                                                description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.'
                                                title: StartDate
                                                type: string
                                                format: date
                                              EndDate:
                                                description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.'
                                                title: EndDate
                                                type: string
                                                format: date
                                              Notes:
                                                description: Notes related to the Non-standard hours e.g. During shrimp season, the branch has extended opening hours
                                                title: Notes
                                                type: string
                                                minLength: 1
                                                maxLength: 2000
                                              Day:
                                                description: Working day information
                                                type: array
                                                title: Day
                                                items:
                                                  description: Working day information
                                                  type: object
                                                  properties:
                                                    Name:
                                                      description: Specifies the day of the week
                                                      title: Name
                                                      type: string
                                                      enum:
                                                      - Friday
                                                      - Monday
                                                      - Saturday
                                                      - Sunday
                                                      - Thursday
                                                      - Tuesday
                                                      - Wednesday
                                                    Notes:
                                                      description: Specify any note that is related the particular opening day e.g. Closed half day on Monday
                                                      title: Notes
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 2000
                                                    OpeningHours:
                                                      description: Opening & Closing Times of a branch of an organisation
                                                      type: array
                                                      title: OpeningHours
                                                      items:
                                                        description: Opening & Closing Times of a branch of an organisation
                                                        type: object
                                                        properties:
                                                          OpeningTime:
                                                            description: 'A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.

                                                              Note on the time format:

                                                              1) beginning / end of calendar day

                                                              00:00:00 = the beginning of a calendar day

                                                              24:00:00 = the end of a calendar day

                                                              2) fractions of second in time format

                                                              Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.'
                                                            title: OpeningTime
                                                            type: string
                                                            pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                                          ClosingTime:
                                                            description: 'A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset for

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/weatherbys-bank/refs/heads/main/openapi/weatherbys-bank-branch-api-openapi.yml