C. Hoare & Co. Statements API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Statements API
  description: OpenAPI for Account and Transaction API Specification
  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: v3.1.0
servers:
- url: https://api.hoaresbank.co.uk/open-banking/v3.1/aisp
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Statements
paths:
  /accounts/{AccountId}/statements:
    get:
      tags:
      - Statements
      summary: Get Statements
      operationId: GetAccountsAccountIdStatements
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/FromStatementDateTimeParam'
      - $ref: '#/components/parameters/ToStatementDateTimeParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - PSUOAuth2Security:
        - accounts
  /accounts/{AccountId}/statements/{StatementId}:
    get:
      tags:
      - Statements
      summary: Get Statements
      operationId: GetAccountsAccountIdStatementsStatementId
      parameters:
      - $ref: '#/components/parameters/StatementId'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - PSUOAuth2Security:
        - accounts
  /accounts/{AccountId}/statements/{StatementId}/file:
    get:
      tags:
      - Statements
      summary: Get Statements
      operationId: GetAccountsAccountIdStatementsStatementIdFile
      parameters:
      - $ref: '#/components/parameters/StatementId'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdFileRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - PSUOAuth2Security:
        - accounts
  /accounts/{AccountId}/statements/{StatementId}/transactions:
    get:
      tags:
      - Statements
      summary: Get Transactions
      operationId: GetAccountsAccountIdStatementsStatementIdTransactions
      parameters:
      - $ref: '#/components/parameters/StatementId'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - PSUOAuth2Security:
        - accounts
  /statements:
    get:
      tags:
      - Statements
      summary: Get Statements
      operationId: GetStatements
      parameters:
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/FromStatementDateTimeParam'
      - $ref: '#/components/parameters/ToStatementDateTimeParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200StatementsRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - PSUOAuth2Security:
        - accounts
components:
  schemas:
    AccountId:
      description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
      type: string
      minLength: 1
      maxLength: 40
    OBStatementInterest1:
      description: Set of elements used to provide details of a generic interest amount related to the statement resource.
      type: object
      properties:
        CreditDebitIndicator:
          type: string
          enum:
          - Credit
          - Debit
          description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
        Type:
          $ref: '#/components/schemas/OBExternalStatementInterestType1Code'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
      required:
      - CreditDebitIndicator
      - Type
      - Amount
      additionalProperties: false
    OBExternalStatementType1Code:
      description: Statement type, in a coded form.
      type: string
      enum:
      - AccountClosure
      - AccountOpening
      - Annual
      - Interim
      - RegularPeriodic
    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
    OBTransactionCashBalance:
      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.
      type: object
      properties:
        CreditDebitIndicator:
          type: string
          enum:
          - Credit
          - Debit
          description: "Indicates whether the balance is a credit or a debit balance. \nUsage: A zero balance is considered to be a credit balance."
        Type:
          $ref: '#/components/schemas/OBBalanceType1Code'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
      required:
      - CreditDebitIndicator
      - Type
      - Amount
      additionalProperties: false
    OBSupplementaryData1:
      description: Additional information that can not be captured in the structured fields and/or any other specific block.
      type: object
      properties: {}
      additionalProperties: false
    OBExternalStatementValueType1Code:
      description: Statement value type, in a coded form.
      type: string
      example:
      - UK.OBIE.AirMilesPoints
      - UK.OBIE.AirMilesPointsBalance
      - UK.OBIE.Credits
      - UK.OBIE.Debits
      - UK.OBIE.HotelPoints
      - UK.OBIE.HotelPointsBalance
      - UK.OBIE.RetailShoppingPoints
      - UK.OBIE.RetailShoppingPointsBalance
      minLength: 1
      maxLength: 40
    OBBranchAndFinancialInstitutionIdentification6:
      description: Financial institution servicing an account for the debtor.
      type: object
      properties:
        SchemeName:
          $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code'
        Identification:
          description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
          type: string
          minLength: 1
          maxLength: 35
        Name:
          description: Name by which an agent is known and which is usually used to identify that agent.
          type: string
          minLength: 1
          maxLength: 140
        PostalAddress:
          $ref: '#/components/schemas/OBPostalAddress6'
      additionalProperties: false
    OBExternalStatementInterestType1Code:
      description: Interest amount type, in a coded form.
      type: string
      example:
      - UK.OBIE.BalanceTransfer
      - UK.OBIE.Cash
      - UK.OBIE.EstimatedNext
      - UK.OBIE.Purchase
      - UK.OBIE.Total
      minLength: 1
      maxLength: 40
    OBStatementFee1:
      description: Set of elements used to provide details of a fee for the statement resource.
      type: object
      properties:
        CreditDebitIndicator:
          type: string
          enum:
          - Credit
          - Debit
          description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
        Type:
          $ref: '#/components/schemas/OBExternalStatementFeeType1Code'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
      required:
      - CreditDebitIndicator
      - Type
      - Amount
      additionalProperties: false
    OBCashAccount6:
      description: Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
      type: object
      properties:
        SchemeName:
          $ref: '#/components/schemas/OBExternalAccountIdentification4Code'
        Identification:
          description: Identification assigned by an institution to identify an account. This identification is known by the account owner.
          type: string
          minLength: 1
          maxLength: 256
        Name:
          description: 'Name of the account, as assigned by the account servicing institution.

            Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.'
          type: string
          minLength: 1
          maxLength: 70
        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
          minLength: 1
          maxLength: 34
      additionalProperties: false
    OBExternalCardAuthorisationType1Code:
      description: The card authorisation type.
      type: string
      enum:
      - ConsumerDevice
      - Contactless
      - None
      - PIN
    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
    OBStatement1Detail:
      description: Provides further details on a statement resource.
      type: object
      properties:
        AccountId:
          $ref: '#/components/schemas/AccountId'
        StatementId:
          description: Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
          type: string
          minLength: 1
          maxLength: 40
        StatementReference:
          description: Unique reference for the statement. This reference may be optionally populated if available.
          type: string
          minLength: 1
          maxLength: 35
        Type:
          $ref: '#/components/schemas/OBExternalStatementType1Code'
        StartDateTime:
          description: "Date and time at which the statement period starts.\nAll 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
        EndDateTime:
          description: "Date and time at which the statement period ends.\nAll 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
        CreationDateTime:
          description: "Date and time at which the resource was created.\nAll 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
        StatementDescription:
          items:
            type: string
            minLength: 1
            maxLength: 500
          type: array
          description: Other descriptions that may be available for the statement resource.
        StatementBenefit:
          items:
            $ref: '#/components/schemas/OBStatementBenefit1'
          type: array
          description: Set of elements used to provide details of a benefit or reward amount for the statement resource.
        StatementFee:
          items:
            $ref: '#/components/schemas/OBStatementFee1'
          type: array
          description: Set of elements used to provide details of a fee for the statement resource.
        StatementInterest:
          items:
            $ref: '#/components/schemas/OBStatementInterest1'
          type: array
          description: Set of elements used to provide details of a generic interest amount related to the statement resource.
        StatementDateTime:
          items:
            $ref: '#/components/schemas/OBStatementDateTime1'
          type: array
          description: Set of elements used to provide details of a generic date time for the statement resource.
        StatementRate:
          items:
            $ref: '#/components/schemas/OBStatementRate1'
          type: array
          description: Set of elements used to provide details of a generic rate related to the statement resource.
        StatementValue:
          items:
            $ref: '#/components/schemas/OBStatementValue1'
          type: array
          description: Set of elements used to provide details of a generic number value related to the statement resource.
        StatementAmount:
          items:
            $ref: '#/components/schemas/OBStatementAmount1'
          type: array
          description: Set of elements used to provide details of a generic amount for the statement resource.
      required:
      - AccountId
      - Type
      - StartDateTime
      - EndDateTime
      - CreationDateTime
      additionalProperties: false
    OBStatementBenefit1:
      description: Set of elements used to provide details of a benefit or reward amount for the statement resource.
      type: object
      properties:
        Type:
          $ref: '#/components/schemas/OBExternalStatementBenefitType1Code'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
      required:
      - Type
      - Amount
      additionalProperties: false
    OBError1:
      type: object
      properties:
        ErrorCode:
          description: Low level textual error code, e.g., UK.OBIE.Field.Missing
          type: string
          minLength: 1
          maxLength: 128
        Message:
          description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''

            OBIE 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
      - Message
      additionalProperties: false
      minProperties: 1
    OBBankTransactionCodeStructure1:
      description: Set of elements used to fully identify the type of underlying transaction resulting in an entry.
      type: object
      properties:
        Code:
          description: Specifies the family within a domain.
          type: string
        SubCode:
          description: Specifies the sub-product family within a specific family.
          type: string
      required:
      - Code
      - SubCode
      additionalProperties: false
    OBStatementAmount1:
      description: Set of elements used to provide details of a generic amount for the statement resource.
      type: object
      properties:
        CreditDebitIndicator:
          type: string
          enum:
          - Credit
          - Debit
          description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
        Type:
          $ref: '#/components/schemas/OBExternalStatementAmountType1Code'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
      required:
      - CreditDebitIndicator
      - Type
      - Amount
      additionalProperties: false
    OBExternalStatementRateType1Code:
      description: Statement rate type, in a coded form.
      type: string
      example:
      - UK.OBIE.AnnualBalanceTransfer
      - UK.OBIE.AnnualBalanceTransferAfterPromo
      - UK.OBIE.AnnualBalanceTransferPromo
      - UK.OBIE.AnnualCash
      - UK.OBIE.AnnualPurchase
      - UK.OBIE.AnnualPurchaseAfterPromo
      - UK.OBIE.AnnualPurchasePromo
      - UK.OBIE.MonthlyBalanceTransfer
      - UK.OBIE.MonthlyCash
      - UK.OBIE.MonthlyPurchase
      minLength: 1
      maxLength: 40
    OBMerchantDetails1:
      description: Details of the merchant involved in the transaction.
      type: object
      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
      additionalProperties: false
    OBCurrencyExchange5:
      description: Set of elements used to provide details on the currency exchange.
      type: object
      properties:
        SourceCurrency:
          description: Currency from which an amount is to be converted in a currency conversion.
          type: string
          pattern: ^[A-Z]{3,3}$
        TargetCurrency:
          description: Currency from which an amount is to be converted in a currency conversion.
          type: string
          pattern: ^[A-Z]{3,3}$
        UnitCurrency:
          description: Currency from which an amount is to be converted in a currency conversion.
          type: string
          pattern: ^[A-Z]{3,3}$
        ExchangeRate:
          description: 'Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

            Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).'
          type: number
        ContractIdentification:
          description: Unique identification to unambiguously identify the foreign exchange contract.
          type: string
          minLength: 1
          maxLength: 35
        QuotationDate:
          description: "Date and time at which an exchange rate is quoted.\nAll 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
        InstructedAmount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
      required:
      - SourceCurrency
      - ExchangeRate
      additionalProperties: false
    TransactionInformation:
      description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text."
      type: string
      minLength: 1
      maxLength: 500
    OBErrorResponse1:
      description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
      type: object
      properties:
        Code:
          description: High level textual error code, to help categorize the errors.
          type: string
          minLength: 1
          maxLength: 40
        Id:
          description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
          type: string
          minLength: 1
          maxLength: 40
        Message:
          description: Brief Error message, e.g., 'There is something wrong with the request parameters provided'
          type: string
          minLength: 1
          maxLength: 500
        Errors:
          items:
            $ref: '#/components/schemas/OBError1'
          type: array
          minItems: 1
      required:
      - Code
      - Message
      - Errors
      additionalProperties: false
    OBTransaction4Basic:
      description: Provides further details on an entry in the report.
      type: object
      properties:
        AccountId:
          $ref: '#/components/schemas/AccountId'
        TransactionId:
          description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
          type: string
          minLength: 1
          maxLength: 40
        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: 35
        StatementReference:
          items:
            type: string
            minLength: 1
            maxLength: 35
          type: array
          description: Unique reference for the statement. This reference may be optionally populated if available.
        CreditDebitIndicator:
          type: string
          enum:
          - Credit
          - Debit
          description: Indicates whether the transaction is a credit or a debit entry.
        Status:
          $ref: '#/components/schemas/OBEntryStatus1Code'
        BookingDateTime:
          description: "Date and time when a transaction entry is posted to an account on the account servicer's books.\nUsage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.\nAll 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
        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.\nAll 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
        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
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
        ChargeAmount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
        CurrencyExchange:
          $ref: '#/components/schemas/OBCurrencyExchange5'
        BankTransactionCode:
          $ref: '#/components/schemas/OBBankTransactionCodeStructure1'
        ProprietaryBankTransactionCode:
          description: Set of elements to fully identify a proprietary bank transaction code.
          type: object
          properties:
            Code:
              description: Proprietary bank transaction code to identify the underlying transaction.
              type: string
              minLength: 1
              maxLength: 35
            Issuer:
              description: Identification of the issuer of the proprietary bank transaction code.
              type: string
              minLength: 1
              maxLength: 35
          required:
          - Code
          additionalProperties: false
        CardInstrument:
          $ref: '#/components/schemas/OBTransactionCardInstrument1'
        SupplementaryData:
          $ref: '#/components/schemas/OBSupplementaryData1'
      required:
      - AccountId
      - CreditDebitIndicator
      - Status
      - BookingDateTime
      - Amount
      additionalProperties: false
    OBActiveOrHistoricCurrencyAndAmount:
      description: Amount of money of the cash balance after a transaction entry is applied to the account..
      type: object
      properties:
        Amount:
          $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
        Currency:
          description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
          type: string
          pattern: ^[A-Z]{3,3}$
      required:
      - Amount
      - Currency
      additionalProperties: false
    OBAddressTypeCode:
      description: Identifies the nature of the postal address.
      type: string
      enum:
      - Business
      - Correspondence
      - DeliveryTo
      - MailTo
      - POBox
      - Postal
      - Residential
      - Statement
    OBStatementRate1:
      description: Set of elements used to provide details of a generic rate related to the statement resource.
      type: object
      properties:
        Rate:
          description: Rate associated with the statement rate type.
          type: string
          minLength: 1
          maxLength: 10
          pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
        Type:
          $ref: '#/components/schemas/OBExternalStatementRateType1Code'
      required:
      - Rate
      - Type
      additionalProperties: false
    OBReadStatement1:
      type: object
      properties:
        Data:
          type: object
          properties:
            Statement:
              items:
                $ref: '#/components/schemas/OBStatement1'
              type: array
              description: Provides further details on a statement resource.
          additionalProperties: false
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Data
      - Links
      - Meta
      additionalProperties: false
    OBStatementDateTime1:
      description: Set of elements used to provide details of a generic date time for the statement resource.
      type: object
      properties:
        DateTime:
          description: "Date and time associated with the date time type.\nAll 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
        Type:
          $ref: '#/components/schemas/OBExternalStatementDateTimeType1Code'
      required:
      - DateTime
      - Type
      additionalProperties: false
    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
    OBTransaction4Detail:
      description: Provides further details on an entry in the report.
      type: object
      properties:
        AccountId:
          $ref: '#/components/schemas/AccountId'
        TransactionId:
          description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
          type: string
  

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/c-hoare-and-co/refs/heads/main/openapi/c-hoare-and-co-statements-api-openapi.yml