Coventry Building Society 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:
  responses:
    200AccountsAccountIdStatementsStatementIdTransactionsRead:
      description: Transactions Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBReadTransaction6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBReadTransaction6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBReadTransaction6'
    200AccountsAccountIdStatementsRead:
      description: Statements Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
        application/json:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
    500Error:
      description: Internal Server Error
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    200AccountsAccountIdStatementsStatementIdFileRead:
      description: 'Statements Read


        ASPSP will specify all available content types

        '
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/File'
        application/json:
          schema:
            $ref: '#/components/schemas/File'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/File'
    406Error:
      description: Not Acceptable
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    403Error:
      description: Forbidden
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    404Error:
      description: Not found
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    400Error:
      description: Bad request
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    405Error:
      description: Method Not Allowed
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    200AccountsAccountIdStatementsStatementIdRead:
      description: Statements Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
        application/json:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
    200StatementsRead:
      description: Statements Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
        application/json:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBReadStatement2'
    401Error:
      description: Unauthorized
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    429Error:
      description: Too Many Requests
      headers:
        Retry-After:
          description: Number in seconds to wait
          schema:
            type: integer
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
  schemas:
    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
    OBInternalStatementInterestType1Code:
      description: Interest amount type, in a coded form. For a full list of values see `OBInternalStatementInterestType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.Total
      x-namespaced-enum:
      - UK.OBIE.BalanceTransfer
      - UK.OBIE.Cash
      - UK.OBIE.EstimatedNext
      - UK.OBIE.Purchase
      - UK.OBIE.Total
      - UK.OBIE.InstalmentPlan
      - UK.OBIE.MoneyTransfer
    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}$
    Links:
      type: object
      description: Links relevant to the payload
      properties:
        Self:
          type: string
          format: uri
        First:
          type: string
          format: uri
        Prev:
          type: string
          format: uri
        Next:
          type: string
          format: uri
        Last:
          type: string
          format: uri
      additionalProperties: false
      required:
      - Self
    OBInternalStatementFeeRateType1Code:
      description: This code indicates the specific type of fee rate (e.g., AER, EAR). For a full list of values see `OBInternalStatementFeeRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.AER
      x-namespaced-enum:
      - UK.OBIE.AER
      - UK.OBIE.EAR
    OBExternalStatusReason1Code:
      description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      minLength: 4
      maxLength: 4
      example: U001
    PostCode:
      description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      type: string
      example: EC2N 4AG
      minLength: 1
      maxLength: 16
    BuildingNumber:
      description: Number that identifies the position of a building on a street.
      type: string
      example: '11'
      minLength: 1
      maxLength: 16
    ExternalProxyAccountType1Code:
      description: Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For more information and a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: TELE
      enum:
      - TELE
      - EMAL
      - DNAM
      - CINC
      - COTX
      - COID
      - CUST
      - DRLC
      - EIDN
      - EWAL
      - PVTX
      - LEIC
      - MBNO
      - NIDN
      - CCPT
      - SHID
      - SOSE
      - TOKN
      - UBIL
      - VIPN
      - BIID
    DateTime:
      description: "Date and time associated with the date time type. 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
      example: '2024-05-29T00:00:00Z'
      format: date-time
    OBInternalStatementFeeFrequency1Code:
      description: How frequently the fee is applied to the Account. For a full list of values see `OBInternalStatementFeeFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.StatementMonthly
      x-namespaced-enum:
      - UK.OBIE.ChargingPeriod
      - UK.OBIE.PerTransactionAmount
      - UK.OBIE.PerTransactionPercentage
      - UK.OBIE.Quarterly
      - UK.OBIE.StatementMonthly
      - UK.OBIE.Weekly
    OBReadStatement2:
      type: object
      required:
      - Data
      properties:
        Data:
          $ref: '#/components/schemas/OBReadDataStatement2'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
      additionalProperties: false
    TransactionInformation:
      description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text."
      type: string
      minLength: 1
      maxLength: 500
    Identification_2:
      description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
      type: string
      minLength: 1
      maxLength: 35
    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
    Description_2:
      description: Description that may be available for the statement interest.
      example: Interest occurred over statement duration
      type: string
      minLength: 1
      maxLength: 128
    OBMerchantDetails1:
      type: object
      description: Details of the merchant involved in the transaction.
      properties:
        MerchantName:
          description: Name by which the merchant is known.
          type: string
          minLength: 1
          maxLength: 350
        MerchantCategoryCode:
          description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
          type: string
          minLength: 3
          maxLength: 4
    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
    OBTransaction6:
      type: object
      description: Provides further details on an entry in the report.
      required:
      - AccountId
      - CreditDebitIndicator
      - Status
      - BookingDateTime
      - Amount
      properties:
        AccountId:
          $ref: '#/components/schemas/AccountId'
        TransactionId:
          $ref: '#/components/schemas/TransactionId'
        TransactionReference:
          $ref: '#/components/schemas/TransactionReference'
        StatementReference:
          type: array
          items:
            $ref: '#/components/schemas/StatementReference'
        CreditDebitIndicator:
          $ref: '#/components/schemas/OBCreditDebitCode_1'
        Status:
          $ref: '#/components/schemas/ExternalEntryStatus1Code'
        TransactionMutability:
          $ref: '#/components/schemas/OBInternalTransactionMutability1Code'
        BookingDateTime:
          $ref: '#/components/schemas/BookingDateTime'
        ValueDateTime:
          $ref: '#/components/schemas/ValueDateTime'
        TransactionInformation:
          $ref: '#/components/schemas/TransactionInformation'
        AddressLine:
          $ref: '#/components/schemas/AddressLine'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_9'
        ChargeAmount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_10'
        CurrencyExchange:
          $ref: '#/components/schemas/OBCurrencyExchange5'
        BankTransactionCode:
          $ref: '#/components/schemas/OBBankTransactionCodeStructure1'
        ProprietaryBankTransactionCode:
          $ref: '#/components/schemas/ProprietaryBankTransactionCodeStructure1'
        ExtendedProprietaryBankTransactionCodes:
          type: array
          items:
            $ref: '#/components/schemas/OBExtendedProprietaryBankTransactionCode'
        Balance:
          $ref: '#/components/schemas/OBTransactionCashBalance'
        MerchantDetails:
          $ref: '#/components/schemas/OBMerchantDetails1'
        CreditorAgent:
          $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_1'
        CreditorAccount:
          $ref: '#/components/schemas/OBCashAccount6_0'
        DebtorAgent:
          $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_2'
        DebtorAccount:
          $ref: '#/components/schemas/OBCashAccount6_1'
        CardInstrument:
          $ref: '#/components/schemas/OBTransactionCardInstrument1'
        SupplementaryData:
          $ref: '#/components/schemas/OBSupplementaryData1'
        CategoryPurposeCode:
          $ref: '#/components/schemas/ExternalCategoryPurpose1Code'
        PaymentPurposeCode:
          $ref: '#/components/schemas/OBExternalPurpose1Code'
        UltimateCreditor:
          $ref: '#/components/schemas/OBUltimateCreditor1'
        UltimateDebtor:
          $ref: '#/components/schemas/OBUltimateDebtor1'
        IntermediaryAgent1:
          $ref: '#/components/schemas/OBIntermediaryAgent'
        IntermediaryAgent2:
          $ref: '#/components/schemas/OBIntermediaryAgent'
        IntermediaryAgent3:
          $ref: '#/components/schemas/OBIntermediaryAgent'
      additionalProperties: false
    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'
    OBBankTransactionCodeStructure1:
      type: object
      required:
      - Code
      - SubCode
      description: Set of elements used to fully identify the type of underlying transaction resulting in an entry.
      properties:
        Code:
          description: Specifies the family within a domain.
          type: string
        SubCode:
          description: Specifies the sub-product family within a specific family.
          type: string
    OBCashAccount6_1:
      type: object
      description: Unambiguous identification of the account of the debtor, in the case of a credit transaction.
      properties:
        SchemeName:
          $ref: '#/components/schemas/OBInternalAccountIdentification4Code'
        Identification:
          $ref: '#/components/schemas/Identification_0'
        Name:
          $ref: '#/components/schemas/Name_0'
        SecondaryIdentification:
          $ref: '#/components/schemas/SecondaryIdentification'
        Proxy:
          $ref: '#/components/schemas/OBProxy1'
    BuildingName:
      description: Name of a referenced building.
      type: string
      minLength: 1
      maxLength: 140
    CreationDateTime:
      description: "Date and time at which the resource was created. 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
      example: '2024-05-29T00:00:00Z'
      format: date-time
    ValueDateTime:
      description: "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.\nUsage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.\nFor transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. 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
    ExternalCategoryPurpose1Code:
      description: Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk.  For all enum values see `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      enum:
      - BONU
      - CASH
      - CBLK
      - CCRD
      - CGWV
      - CIPC
      - CONC
      - CORT
      - DCRD
      - DIVI
      - DVPM
      - EPAY
      - FCDT
      - FCIN
      - FCOL
      - GOVT
      - GP2P
      - HEDG
      - ICCP
      - IDCP
      - INTC
      - INTE
      - LBOX
      - LOAN
      - MP2B
      - MP2P
      - OTHR
      - PENS
      - RPRE
      - RRCT
      - RVPM
      - SALA
      - SECU
      - SSBE
      - SUPP
      - SWEP
      - TAXS
      - TOPG
      - TRAD
      - TREA
      - VATX
      - VOST
      - WHLD
      - ZABA
    File:
      type: object
      properties: {}
    UnitNumber:
      description: Number that identifies the unit of a specific address .
      type: string
      example: A88
      minLength: 1
      maxLength: 16
    OBUltimateCreditor1:
      description: Ultimate party to which an amount of money is due.
      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'
    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'
    OBReadDataTransaction6:
      type: object
      properties:
        Transaction:
          type: array
          items:
            $ref: '#/components/schemas/OBTransaction6'
      additionalProperties: false
    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
    OBSupplementaryData1:
      type: object
      properties: {}
      additionalProperties: true
      description: Additional information that can not be captured in the structured fields and/or any other specific block.
    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
    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: '

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