Bank of Scotland Statements API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Statements API
  description: 'Swagger for Account and Transaction API Specification.


    **Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.

    '
  termsOfService: https://www.openbanking.org.uk/terms
  contact:
    name: Service Desk
    email: ServiceDesk@openbanking.org.uk
  license:
    name: open-licence
    url: https://www.openbanking.org.uk/open-licence
  version: 4.0.1
servers:
- url: /open-banking/v4.0/aisp
tags:
- name: Statements
paths:
  /accounts/{AccountId}/statements:
    get:
      tags:
      - Statements
      summary: Get Statements for an AccountId
      description: Enables an AISP to retrieve statement information for a specific PSU account.
      operationId: GetAccountsAccountIdStatements
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      - $ref: '#/components/parameters/FromStatementDateTimeParam'
      - $ref: '#/components/parameters/ToStatementDateTimeParam'
      - $ref: '#/components/parameters/x-client-id'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - accounts
  /accounts/{AccountId}/statements/{StatementId}:
    get:
      tags:
      - Statements
      summary: Get Statement by StatementId for an AccountId
      description: Enables an AISP to retrieve the statement information resource for a specific statement.
      operationId: GetAccountsAccountIdStatementsStatementId
      parameters:
      - $ref: '#/components/parameters/StatementId'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      - $ref: '#/components/parameters/x-client-id'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - accounts
  /accounts/{AccountId}/statements/{StatementId}/file:
    get:
      tags:
      - Statements
      summary: Get Statement file by StatementId for an AccountId
      description: Enables an AISP to retrieve a non-json representation of a specific statement.
      operationId: GetAccountsAccountIdStatementsStatementIdFile
      parameters:
      - $ref: '#/components/parameters/StatementId'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      - $ref: '#/components/parameters/x-client-id'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdFileRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - accounts
  /accounts/{AccountId}/statements/{StatementId}/transactions:
    get:
      tags:
      - Statements
      summary: Get Statement Transactions for an AccountId
      description: Enables an AISP to retrieve transactions that appear on a selected statement for a specific PSU account.
      operationId: GetAccountsAccountIdStatementsStatementIdTransactions
      parameters:
      - $ref: '#/components/parameters/StatementId'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      - $ref: '#/components/parameters/x-client-id'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - accounts
  /statements:
    get:
      tags:
      - Statements
      summary: Get Statements
      description: Enables an AISP to retrieve statement information for account(s) that the PSU has consented to.
      operationId: GetStatements
      parameters:
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/FromStatementDateTimeParam'
      - $ref: '#/components/parameters/ToStatementDateTimeParam'
      - $ref: '#/components/parameters/x-customer-user-agent'
      - $ref: '#/components/parameters/x-client-id'
      responses:
        '200':
          $ref: '#/components/responses/200StatementsRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - accounts
components:
  schemas:
    OBTransactionCashBalance:
      type: object
      required:
      - CreditDebitIndicator
      - Type
      - Amount
      description: Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
      properties:
        CreditDebitIndicator:
          $ref: '#/components/schemas/OBCreditDebitCode_2'
        Type:
          $ref: '#/components/schemas/OBBalanceType1Code'
        Amount:
          type: object
          required:
          - Amount
          - Currency
          description: Amount of money of the cash balance after a transaction entry is applied to the account..
          properties:
            Amount:
              $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
            Currency:
              $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
      additionalProperties: false
    OBErrorResponse1:
      description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
      type: object
      properties:
        Id:
          description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
          type: string
          minLength: 1
          maxLength: 40
        Code:
          description: Deprecated <br />High level textual error code, to help categorise the errors.
          type: string
          minLength: 1
          example: 400 BadRequest
          maxLength: 40
        Message:
          description: Deprecated <br />Brief Error message
          type: string
          minLength: 1
          example: There is something wrong with the request parameters provided
          maxLength: 500
        Errors:
          items:
            $ref: '#/components/schemas/OBError1'
          type: array
          minItems: 1
      required:
      - Errors
      additionalProperties: false
    OBCreditDebitCode_2:
      description: "Indicates whether the balance is a credit or a debit balance. \nUsage: A zero balance is considered to be a credit balance.\n<br />\nFor a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)"
      type: string
      example: Credit
      enum:
      - Credit
      - Debit
    Rate:
      description: Rate associated with the statement rate type.
      type: string
      example: '0.224'
      maxLength: 40
      pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
    OBInternalStatementDateTimeType1Code:
      description: Date time type, in a coded form. For a full list of values see `OBInternalStatementDateTimeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.NextStatement
      x-namespaced-enum:
      - UK.OBIE.BalanceTransferPromoEnd
      - UK.OBIE.DirectDebitDue
      - UK.OBIE.LastPayment
      - UK.OBIE.LastStatement
      - UK.OBIE.NextStatement
      - UK.OBIE.PaymentDue
      - UK.OBIE.PurchasePromoEnd
      - UK.OBIE.StatementAvailable
    OBInternalAccountIdentification4Code:
      description: Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      x-namespaced-enum:
      - UK.OBIE.BBAN
      - UK.OBIE.IBAN
      - UK.OBIE.PAN
      - UK.OBIE.Paym
      - UK.OBIE.SortCodeAccountNumber
      - UK.OBIE.Wallet
    Identification_2:
      description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
      type: string
      minLength: 1
      maxLength: 35
    OBInternalStatementType1Code:
      description: Statement type, in a coded form. For a full list of values see `OBInternalStatementType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: RegularPeriodic
      enum:
      - AccountClosure
      - AccountOpening
      - Annual
      - Interim
      - RegularPeriodic
    OBInternalFinancialInstitutionIdentification4Code:
      description: Name of the identification scheme, in a coded form as published in an external list.<br/> For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.BICFI
      x-namespaced-enum:
      - UK.OBIE.BICFI
    CareOf:
      description: The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
      type: string
      example: Jane Smith
      minLength: 1
      maxLength: 140
    TransactionId:
      description: Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
      type: string
      minLength: 1
      maxLength: 210
    PostBox:
      description: Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
      type: string
      example: PO Box 123456
      minLength: 1
      maxLength: 16
    Name_1:
      description: Name by which an agent is known and which is usually used to identify that agent.
      type: string
      example: Agent Name
      minLength: 1
      maxLength: 140
    ISODateTime:
      description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
      type: string
      format: date-time
    OBInternalStatementInterestFrequency1Code:
      description: Specifies the statement fee type requested. For a full list of values see `OBInternalStatementInterestFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.Monthly
      x-namespaced-enum:
      - UK.OBIE.Daily
      - UK.OBIE.HalfYearly
      - UK.OBIE.Monthly
      - UK.OBIE.PerStatementDate
      - UK.OBIE.Quarterly
      - UK.OBIE.Weekly
      - UK.OBIE.Yearly
    OBTransactionCardInstrument1:
      type: object
      required:
      - CardSchemeName
      description: 'Set of elements to describe the card instrument used in the transaction. <br />

        For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
      properties:
        CardSchemeName:
          description: 'Name of the card scheme. <br />

            For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
          type: string
          enum:
          - AmericanExpress
          - Diners
          - Discover
          - MasterCard
          - VISA
        AuthorisationType:
          description: 'The card authorisation type. <br />

            For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
          type: string
          enum:
          - ConsumerDevice
          - Contactless
          - None
          - PIN
        Name:
          description: Name of the cardholder using the card instrument.
          type: string
          minLength: 1
          maxLength: 70
        Identification:
          description: Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
          type: string
          minLength: 1
          maxLength: 34
      additionalProperties: false
    OBActiveCurrencyAndAmount_SimpleType:
      description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
      type: string
      example: '1209.06'
      pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
    OBProxy1:
      description: Specifies an alternate assumed name for the identification of the account.
      type: object
      required:
      - Identification
      - Code
      properties:
        Identification:
          description: Identification used to indicate the account identification under another specified name.
          type: string
          example: '2360549017905188'
          minLength: 1
          maxLength: 2048
        Code:
          $ref: '#/components/schemas/ExternalProxyAccountType1Code'
        Type:
          type: string
          description: Type of the proxy identification.
          minLength: 1
          maxLength: 35
    Identification_0:
      description: Identification assigned by an institution to identify an account. This identification is known by the account owner.
      type: string
      example: '80200112344562'
      minLength: 1
      maxLength: 256
    OBStatement2:
      type: object
      description: Provides further details on a statement resource.
      required:
      - AccountId
      - Type
      - StartDateTime
      - EndDateTime
      - CreationDateTime
      properties:
        AccountId:
          $ref: '#/components/schemas/AccountId'
        StatementId:
          $ref: '#/components/schemas/StatementId'
        StatementReference:
          $ref: '#/components/schemas/StatementReference'
        Type:
          $ref: '#/components/schemas/OBInternalStatementType1Code'
        StartDateTime:
          $ref: '#/components/schemas/StartDateTime'
        EndDateTime:
          $ref: '#/components/schemas/EndDateTime'
        CreationDateTime:
          $ref: '#/components/schemas/CreationDateTime'
        StatementDescription:
          type: array
          items:
            description: Other descriptions that may be available for the statement resource.
            type: string
            example: August 2017 Statement
            minLength: 1
            maxLength: 500
        StatementBenefit:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a benefit or reward amount for the statement resource.
            required:
            - Type
            - Amount
            properties:
              Type:
                $ref: '#/components/schemas/OBInternalStatementBenefitType1Code'
              Amount:
                $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5'
        StatementFee:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a fee for the statement resource.
            required:
            - CreditDebitIndicator
            - Type
            - Amount
            properties:
              Description:
                $ref: '#/components/schemas/Description_1'
              CreditDebitIndicator:
                $ref: '#/components/schemas/OBCreditDebitCode_0'
              Type:
                $ref: '#/components/schemas/OBInternalStatementFeeType1Code'
              Rate:
                $ref: '#/components/schemas/OBRate1_0'
              RateType:
                $ref: '#/components/schemas/OBInternalStatementFeeRateType1Code'
              Frequency:
                $ref: '#/components/schemas/OBInternalStatementFeeFrequency1Code'
              Amount:
                $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6'
        StatementInterest:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a generic interest amount related to the statement resource.
            required:
            - CreditDebitIndicator
            - Type
            - Amount
            properties:
              Description:
                $ref: '#/components/schemas/Description_2'
              CreditDebitIndicator:
                $ref: '#/components/schemas/OBCreditDebitCode_0'
              Type:
                $ref: '#/components/schemas/OBInternalStatementInterestType1Code'
              Rate:
                $ref: '#/components/schemas/OBRate1_1'
              RateType:
                $ref: '#/components/schemas/OBInternalStatementInterestRateType1Code'
              Frequency:
                $ref: '#/components/schemas/OBInternalStatementInterestFrequency1Code'
              Amount:
                $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7'
        StatementAmount:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a generic amount for the statement resource.
            required:
            - CreditDebitIndicator
            - Type
            - Amount
            properties:
              CreditDebitIndicator:
                $ref: '#/components/schemas/OBCreditDebitCode_0'
              Type:
                $ref: '#/components/schemas/OBInternalStatementAmountType1Code'
              Amount:
                type: object
                required:
                - Amount
                - Currency
                description: Amount of money of the cash balance.
                properties:
                  Amount:
                    $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
                  Currency:
                    $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
                  SubType:
                    description: The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified
                    type: string
                    enum:
                    - BCUR
                    - LCUR
                    default: BCUR
              LocalAmount:
                type: object
                required:
                - Amount
                - Currency
                description: Optional component providing the equivalent of Amount in local currency.
                properties:
                  Amount:
                    $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
                  Currency:
                    $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
                  SubType:
                    description: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified
                    type: string
                    enum:
                    - BCUR
                    - LCUR
                    default: LCUR
        StatementDateTime:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a generic date time for the statement resource.
            required:
            - DateTime
            - Type
            properties:
              DateTime:
                $ref: '#/components/schemas/DateTime'
              Type:
                $ref: '#/components/schemas/OBInternalStatementDateTimeType1Code'
        StatementRate:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a generic rate related to the statement resource.
            required:
            - Rate
            - Type
            properties:
              Rate:
                $ref: '#/components/schemas/Rate'
              Type:
                $ref: '#/components/schemas/OBInternalStatementRateType1Code'
        StatementValue:
          type: array
          items:
            type: object
            description: Set of elements used to provide details of a generic number value related to the statement resource.
            required:
            - Value
            - Type
            properties:
              Value:
                $ref: '#/components/schemas/Value'
              Type:
                $ref: '#/components/schemas/OBInternalStatementValueType1Code'
        TotalValue:
          type: object
          description: Combined sum of all Amounts in the accounts base currency
          required:
          - Amount
          - Currency
          properties:
            Amount:
              $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
            Currency:
              $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
      additionalProperties: false
    OBSupplementaryData1:
      type: object
      properties: {}
      additionalProperties: true
      description: Additional information that can not be captured in the structured fields and/or any other specific block.
    Value:
      description: Value associated with the statement value type.
      type: string
      minLength: 1
      maxLength: 40
    StreetName:
      description: Name of a street or thoroughfare.
      type: string
      example: Bank Street
      minLength: 1
      maxLength: 140
    Name_0:
      description: 'The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP''s online channels.

        Note, the account name is not the product name or the nickname of the account.'
      type: string
      example: Jane Smith
      minLength: 1
      maxLength: 350
    OBError1:
      type: object
      properties:
        ErrorCode:
          $ref: '#/components/schemas/OBExternalStatusReason1Code'
        Message:
          description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''

            OBL doesn''t standardise this field'
          type: string
          minLength: 1
          maxLength: 500
        Path:
          description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
          type: string
          minLength: 1
          maxLength: 500
        Url:
          description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
          type: string
      required:
      - ErrorCode
      additionalProperties: false
      minProperties: 1
    TransactionReference:
      description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
      type: string
      minLength: 1
      maxLength: 210
    OBActiveOrHistoricCurrencyAndAmount_7:
      type: object
      required:
      - Amount
      - Currency
      description: Amount of money associated with the statement interest amount type.
      properties:
        Amount:
          $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
        Currency:
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
    TownName:
      description: Name of a built-up area, with defined boundaries, and a local government.
      type: string
      example: London
      minLength: 1
      maxLength: 140
    AddressLine:
      description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
      type: string
      minLength: 1
      maxLength: 70
    OBPostalAddress7:
      type: object
      description: Information that locates and identifies a specific address, as defined by postal services.
      properties:
        AddressType:
          $ref: '#/components/schemas/OBAddressType2Code'
        Department:
          description: Identification of a division of a large organisation or building.
          example: Finance
          type: string
          minLength: 1
          maxLength: 70
        SubDepartment:
          description: Identification of a sub-division of a large organisation or building.
          example: Payroll
          type: string
          minLength: 1
          maxLength: 70
        StreetName:
          $ref: '#/components/schemas/StreetName'
        BuildingNumber:
          $ref: '#/components/schemas/BuildingNumber'
        BuildingName:
          $ref: '#/components/schemas/BuildingName'
        Floor:
          $ref: '#/components/schemas/Floor'
        UnitNumber:
          $ref: '#/components/schemas/UnitNumber'
        Room:
          $ref: '#/components/schemas/Room'
        PostBox:
          $ref: '#/components/schemas/PostBox'
        TownLocationName:
          $ref: '#/components/schemas/TownName'
        DistrictName:
          $ref: '#/components/schemas/DistrictName'
        CareOf:
          $ref: '#/components/schemas/CareOf'
        PostCode:
          $ref: '#/components/schemas/PostCode'
        TownName:
          $ref: '#/components/schemas/TownName'
        CountrySubDivision:
          description: Identifies a subdivision of a country such as state, region, county.
          type: string
          minLength: 1
          maxLength: 35
        Country:
          description: Nation with its own government.
          type: string
          pattern: ^[A-Z]{2,2}$
        AddressLine:
          type: array
          items:
            description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
            type: string
            minLength: 1
            maxLength: 70
          minItems: 0
          maxItems: 7
    OBActiveOrHistoricCurrencyAndAmount_9:
      type: object
      required:
      - Amount
      - Currency
      description: Amount of money in the cash transaction entry.
      properties:
        Amount:
          $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
        Currency:
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
    OBReadDataTransaction6:
      type: object
      properties:
        Transaction:
          type: array
          items:
            $ref: '#/components/schemas/OBTransaction6'
      additionalProperties: false
    SecondaryIdentification:
      description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)."
      type: string
      example: '87562298675897'
      minLength: 1
      maxLength: 34
    Floor:
      description: Number that identifies the level within a building
      type: string
      example: '11'
      minLength: 1
      maxLength: 70
    OBUltimateDebtor1:
      description: Ultimate party that owes an amount of money to the (ultimate) creditor.
      type: object
      properties:
        Name:
          description: Name by which a party is known and which is usually used to identify that party.
          type: string
          minLength: 1
          maxLength: 140
        Identification:
          description: Identification assigned by an institution.
          type: string
          minLength: 1
          maxLength: 256
        LEI:
          $ref: '#/components/schemas/LEI'
        SchemeName:
          $ref: '#/components/schemas/OBInternalAccountIdentification4Code'
        PostalAddress:
          $ref: '#/components/schemas/OBPostalAddress7'
    Meta:
      title: MetaData
      type: object
      description: Meta Data relevant to the payload
      properties:
        TotalPages:
          type: integer
          format: int32
        FirstAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
        LastAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
      additionalProperties: false
    OBInternalStatementRateType1Code:
      description: Statement rate type, in a coded form. For a full list of values see `OBInternalStatementRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.AnnualCash
      x-namespaced-enum:
      - UK.OBIE.AnnualBalanceTransfer
      - UK.OBIE.AnnualBalanceTransferAfterPromo
      - UK.OBIE.AnnualBalanceTransferPromo
      - UK.OBIE.AnnualCash
      - UK.OBIE.AnnualPurchase
      - UK.OBIE.AnnualPu

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bank-of-scotland/refs/heads/main/openapi/bank-of-scotland-statements-api-openapi.yml