Recognise Bank 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:
    UnitNumber:
      description: Number that identifies the unit of a specific address .
      type: string
      example: A88
      minLength: 1
      maxLength: 16
    OBInternalStatementFeeType1Code:
      description: Fee type, in a coded form. For a full list of values see `OBInternalStatementFeeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.Annual
      x-namespaced-enum:
      - UK.OBIE.Annual
      - UK.OBIE.BalanceTransfer
      - UK.OBIE.CashAdvance
      - UK.OBIE.CashTransaction
      - UK.OBIE.ForeignCashTransaction
      - UK.OBIE.ForeignTransaction
      - UK.OBIE.Gambling
      - UK.OBIE.LatePayment
      - UK.OBIE.MoneyTransfer
      - UK.OBIE.Monthly
      - UK.OBIE.Overlimit
      - UK.OBIE.PostalOrder
      - UK.OBIE.PrizeEntry
      - UK.OBIE.StatementCopy
      - UK.OBIE.Total
      - UK.OBIE.InstalmentPlan
      - UK.OBIE.ReturnedPayment
    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
    OBExtendedProprietaryBankTransactionCode:
      type: object
      description: Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
      required:
      - Code
      properties:
        Code:
          type: string
          description: Proprietary bank transaction code to identify the underlying transaction.
          minLength: 1
          maxLength: 35
        Issuer:
          type: string
          description: Identification of the issuer of the proprietary bank transaction code.
          minLength: 1
          maxLength: 35
        Description:
          type: string
          description: Description of the code and its usage on the ASPSP channel
          minLength: 1
          maxLength: 500
    OBCashAccount6_0:
      type: object
      description: Unambiguous identification of the account of the creditor, in the case of a debit 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'
    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
    OBInternalStatementAmountType1Code:
      description: Amount type, in a coded form.
      type: string
      example: UK.OBIE.CreditLimit
      x-namespaced-enum:
      - UK.OBIE.ArrearsClosingBalance
      - UK.OBIE.AvailableBalance
      - UK.OBIE.AverageBalanceWhenInCredit
      - UK.OBIE.AverageBalanceWhenInDebit
      - UK.OBIE.AverageDailyBalance
      - UK.OBIE.BalanceTransferClosingBalance
      - UK.OBIE.CashClosingBalance
      - UK.OBIE.ClosingBalance
      - UK.OBIE.CreditLimit
      - UK.OBIE.CurrentPayment
      - UK.OBIE.DirectDebitPaymentDue
      - UK.OBIE.FSCSInsurance
      - UK.OBIE.MinimumPaymentDue
      - UK.OBIE.PendingTransactionsBalance
      - UK.OBIE.PreviousClosingBalance
      - UK.OBIE.PreviousPayment
      - UK.OBIE.PurchaseClosingBalance
      - UK.OBIE.StartingBalance
      - UK.OBIE.TotalAdjustments
      - UK.OBIE.TotalCashAdvances
      - UK.OBIE.TotalCharges
      - UK.OBIE.TotalCredits
      - UK.OBIE.TotalDebits
      - UK.OBIE.TotalPurchases
    OBSupplementaryData1:
      type: object
      properties: {}
      additionalProperties: true
      description: Additional information that can not be captured in the structured fields and/or any other specific block.
    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
    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
    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
    OBInternalStatementValueType1Code:
      description: Statement value type, in a coded form. For a full list of values see `OBInternalStatementValueType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.Credit
      x-namespaced-enum:
      - UK.OBIE.AirMilesPoints
      - UK.OBIE.AirMilesPointsBalance
      - UK.OBIE.Credits
      - UK.OBIE.Debits
      - UK.OBIE.HotelPoints
      - UK.OBIE.HotelPointsBalance
      - UK.OBIE.RetailShoppingPoints
      - UK.OBIE.RetailShoppingPointsBalance
    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
    StatementId:
      description: Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable.
      type: string
      example: 8sfhke-sifhkeuf-97813
      minLength: 1
      maxLength: 40
    EndDateTime:
      description: "Date and time at which the statement period ends. 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: '2017-07-12T00:00:00+00:00'
      format: date-time
    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
    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
    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
    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. 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
    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}$
    OBActiveOrHistoricCurrencyAndAmount_10:
      type: object
      required:
      - Amount
      - Currency
      description: Transaction charges to be paid by the charge bearer.
      properties:
        Amount:
          $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
        Currency:
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
    BuildingNumber:
      description: Number that identifies the position of a building on a street.
      type: string
      example: '11'
      minLength: 1
      maxLength: 16
    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
    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'
    File:
      type: object
      properties: {}
    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
    OBReadDataStatement2:
      type: object
      properties:
        Statement:
          type: array
          items:
            $ref: '#/components/schemas/OBStatement2'
      additionalProperties: false
    StreetName:
      description: Name of a street or thoroughfare.
      type: string
      example: Bank Street
      minLength: 1
      maxLength: 140
    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
    Floor:
      description: Number that identifies the level within a building
      type: string
      example: '11'
      minLength: 1
      maxLength: 70
    ProprietaryBankTransactionCodeStructure1:
      type: object
      required:
      - Code
      description: Set of elements to fully identify a proprietary bank transaction code.
      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
      additionalProperties: false
    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
    StatementReference:
      description: Unique reference for the statement. This reference may be optionally populated if available.
      type: string
      example: '002'
      minLength: 1
      maxLength: 35
    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
    OBInternalStatementBenefitType1Code:
      description: Benefit type, in a coded form. For a full list of values see `OBInternalStatementBenefitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      example: UK.OBIE.Cashback
      x-namespaced-enum:
      - UK.OBIE.Cashback
      - UK.OBIE.Insurance
      - UK.OBIE.TravelDiscount
      - UK.OBIE.TravelInsurance
    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
    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
           

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