openapi: "3.0.0"
info:
  title: "Account Information API"
  description: >
    In this document, you'll find the steps your organization needs to take to use our API services. Included in this guide are details of request and response messages used to support your organization’s integration.
    The intended audience for this document are **Technical Architects**, **Development Engineers**, **Test Engineers**, and **Operation & Maintenance Engineers** involved in development and support of your organization’s integration.
    Setting up our API Services is best completed with the assistance of your organization’s IT team, or someone with experience and knowledge of application programming interfaces. This should include experience with **JSON payloads**, **security** and **public key infrastructure (PKI)**.
    This Document describes the following request and response structure of **HSBC MI Vision - Account Information API**. For detail implementation guidelines, please refer to the respective section of Documentation page.
  version: "4.0"
tags:
  - name: "Account Access Consents"
  - name: "Accounts"
    description: "Manage Account Access Consents"
  - name: "Statements"
  - name: "Transactions"
  - name: "Balances"
paths:
  /account-access-consents:
    post:
      tags:
        - "Account Access Consents"
      summary: "Create Account Access Consents"
      description: This endpoint enables TPP to create account access consent. Supported product is Credit cards.
      operationId: "CreateAccountAccessConsents"
      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/Authorization1"
        - $ref: "#/components/parameters/x-customer-user-agent"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OBReadConsent1"
          application/jose+jwe:
            schema:
              $ref: "#/components/schemas/OBReadConsent1"
        description: "Default"
        required: true
      responses:
        "201":
          $ref: "#/components/responses/201AccountAccessConsentsCreated"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "415":
          $ref: "#/components/responses/415Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - TPPOAuth2Security:
            - "accounts"
  /account-access-consents/{ConsentId}:
    get:
      tags:
        - "Account Access Consents"
      summary: "Get Account Access Consents"
      description: This endpoint enables TPP to get account access consent by ConsentId. Supported product is Credit cards.
      operationId: "GetAccountAccessConsentsConsentId"
      parameters:
        - $ref: "#/components/parameters/ConsentId"
        - $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/Authorization1"
        - $ref: "#/components/parameters/x-customer-user-agent"
      responses:
        "200":
          $ref: "#/components/responses/200AccountAccessConsentsConsentIdRead"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - TPPOAuth2Security:
            - "accounts"
    delete:
      tags:
        - "Account Access Consents"
      summary: "Delete Account Access Consents"
      description: This endpoint enables TPP to delete account access consent. Supported product is Credit cards.
      operationId: "DeleteAccountAccessConsentsConsentId"
      parameters:
        - $ref: "#/components/parameters/ConsentId"
        - $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/Authorization1"
        - $ref: "#/components/parameters/x-customer-user-agent"
      responses:
        "204":
          $ref: "#/components/responses/204AccountAccessConsentsConsentIdDeleted"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - TPPOAuth2Security:
            - "accounts"
  /accounts:
    get:
      tags:
        - "Accounts"
      summary: "Get Accounts"
      description: This endpoint enables to get Accounts. Supported product is Credit cards.
      operationId: "GetAccounts"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
      responses:
        "200":
          $ref: "#/components/responses/200AccountsRead"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
  /accounts/{AccountId}:
    get:
      tags:
        - "Accounts"
      summary: "Get Accounts by AccountId"
      description: This endpoint enables to get Accounts by AccountId. Supported product is Credit cards.
      operationId: "GetAccountsAccountId"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
      responses:
        "200":
          $ref: "#/components/responses/200AccountsAccountIdRead"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
  /accounts/{AccountId}/balances:
    get:
      tags:
        - "Balances"
      summary: "Get Account Balances"
      description: This endpoint enables to get Balances by AccountId. Supported product is Credit cards.
      operationId: "GetAccountsAccountIdBalances"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
      responses:
        "200":
          $ref: "#/components/responses/200AccountsAccountIdBalancesRead"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
  /accounts/{AccountId}/statements:
    get:
      tags:
        - "Statements"
      summary: "Get Account Statements"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
        - $ref: "#/components/parameters/FromStatementDateTimeParam"
        - $ref: "#/components/parameters/ToStatementDateTimeParam"
      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:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
  /accounts/{AccountId}/statements/{StatementId}:
    get:
      tags:
        - "Statements"
      summary: "Get Statements by StatementId"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
      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:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
  /accounts/{AccountId}/statements/{StatementId}/transactions:
    get:
      tags:
        - "Transactions"
      summary: "Get Statement Transactions"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
      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:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
  /accounts/{AccountId}/transactions:
    get:
      tags:
        - "Transactions"
      summary: "Get Account Transactions"
      description: This endpoint enables to get account Transactions by AccountId. Supported product is Credit cards.
      operationId: "GetAccountsAccountIdTransactions"
      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/Authorization2"
        - $ref: "#/components/parameters/x-customer-user-agent"
        - $ref: "#/components/parameters/FromBookingDateTimeParam"
        - $ref: "#/components/parameters/ToBookingDateTimeParam"
      responses:
        "200":
          $ref: "#/components/responses/200AccountsAccountIdTransactionsRead"
        "400":
          $ref: "#/components/responses/400Error"
        "401":
          $ref: "#/components/responses/401Error"
        "403":
          $ref: "#/components/responses/403Error"
        "405":
          $ref: "#/components/responses/405Error"
        "406":
          $ref: "#/components/responses/406Error"
        "429":
          $ref: "#/components/responses/429Error"
        "500":
          $ref: "#/components/responses/500Error"
      security:
        - BearerAuth: []
        - PSUOAuth2Security:
            - "accounts"
servers:
  - url: "https://sandbox.ob.mivision.hsbc.co.uk/mock/obie/open-banking/v4.0/aisp"
components:
  parameters:
    FromBookingDateTimeParam:
      in: "query"
      name: "fromBookingDateTime"
      description: "The UTC ISO 8601 Date Time to filter transactions FROM\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component."
      schema:
        type: "string"
        format: "date-time"
      example: "2023-01-04T13:21:07+00:00"
    ToBookingDateTimeParam:
      in: "query"
      name: "toBookingDateTime"
      description: "The UTC ISO 8601 Date Time to filter transactions TO\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component."
      schema:
        type: "string"
        format: "date-time"
      example: "2023-02-04T13:21:07+00:00"
    FromStatementDateTimeParam:
      in: "query"
      name: "fromStatementDateTime"
      description: "The UTC ISO 8601 Date Time to filter statements FROM\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component."
      schema:
        type: "string"
        format: "date-time"
      example: "2023-01-04T13:21:07+00:00"
    ToStatementDateTimeParam:
      in: "query"
      name: "toStatementDateTime"
      description: "The UTC ISO 8601 Date Time to filter statements TO\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component."
      schema:
        type: "string"
        format: "date-time"
      example: "2023-02-04T13:21:07+00:00"
    ConsentId:
      name: "ConsentId"
      in: "path"
      description: "ConsentId"
      required: true
      schema:
        type: "string"
      example: "7404e99b-1a4d-4b08-b441-c327661527f0"
    AccountId:
      name: "AccountId"
      in: "path"
      description: "AccountId"
      required: true
      schema:
        type: "string"
      example: "ThR-RpLMV5lZzDu8vrfEFg"
    StatementId:
      name: "StatementId"
      in: "path"
      description: "StatementId"
      required: true
      schema:
        type: "string"
      example: "Du8vrfEFgThR-RpLMV5lZz"
    Authorization1:
      in: "header"
      name: "Authorization"
      required: true
      description: "An authorisation token which was obtained from an authorisation server using Client Credentials Grant (https://www.rfc-editor.org/rfc/rfc6749#section-4.4). The obtained token must be sent using 'Bearer' scheme (https://tools.ietf.org/html/rfc6750#section-2) for this request"
      example: "Bearer LbGDbcFVVfE-ngpjj8KaH5wrEfg"
      schema:
        type: "string"
    Authorization2:
      in: "header"
      name: "Authorization"
      required: true
      description: "An authorisation token which was obtained from an authorisation server using Authorisation Code Grant (https://www.rfc-editor.org/rfc/rfc6749#section-4.1). The obtained token must be sent using 'Bearer' scheme (https://tools.ietf.org/html/rfc6750#section-2) for this request"
      example: "Bearer GtbuGXK9ByYYHX-Fg9cT_8b31S8"
      schema:
        type: "string"
    x-customer-user-agent:
      in: "header"
      name: "x-customer-user-agent"
      description: "Indicates the user-agent that the PSU is using."
      required: false
      schema:
        type: "string"
      example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"
    x-fapi-customer-ip-address:
      in: "header"
      name: "x-fapi-customer-ip-address"
      required: false
      description: "The PSU's IP address if the PSU is currently logged in with the TPP."
      schema:
        type: "string"
        pattern: ^((((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\s?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\s?),?\s?)+$
      example: "12.201.45.125"
    x-fapi-auth-date:
      in: "header"
      name: "x-fapi-auth-date"
      required: false
      description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC"
      schema:
        type: "string"
        pattern: "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
      example: "Tue, 18 Apr 2023 14:42:25 UTC"
    x-fapi-interaction-id:
      in: "header"
      name: "x-fapi-interaction-id"
      required: false
      description: "An RFC4122 UID used as a correlation id."
      schema:
        type: "string"
      example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
  responses:
    201AccountAccessConsentsCreated:
      description: "Created"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadConsentResponse1"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadConsentResponse1"
    200AccountAccessConsentsConsentIdRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadConsentResponse1"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadConsentResponse1"
    204AccountAccessConsentsConsentIdDeleted:
      description: "No Content"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
          schema:
            type: "string"
    200AccountsRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadAccount6"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadAccount6"
    200AccountsAccountIdRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadAccount6"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadAccount6"
    200AccountsAccountIdBalancesRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "20177a90-5e29-43ba-bea0-cc6c344a9d32"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadBalance1"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadBalance1"
    200AccountsAccountIdStatementsRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadStatement2"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadStatement2"
    200AccountsAccountIdStatementsStatementIdRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadStatement2"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadStatement2"
    200AccountsAccountIdStatementsStatementIdTransactionsRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadTransaction6"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadTransaction6"
    200AccountsAccountIdTransactionsRead:
      description: "OK"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBReadTransaction6"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBReadTransaction6"
    400Error:
      description: "Bad request"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
          schema:
            type: "string"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OBErrorResponse1"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBErrorResponse1"
    401Error:
      description: "Unauthorized"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          schema:
            type: "string"
            example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"

    403Error:
      description: "Forbidden"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          schema:
            type: "string"
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
      content:
        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"
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
    405Error:
      description: "Method Not Allowed"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          schema:
            type: "string"
          example: "cc0fe5bf-0522-4cd4-8d08-417cf8f81841"
    406Error:
      description: "Not Acceptable"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          schema:
            type: "string"
          example: "7507f324-b4e6-43f4-8497-153930017bd9"
    415Error:
      description: "Unsupported Media Type"
      headers:
        x-fapi-interaction-id:
          description: "An RFC4122 UID used as a correlation id."
          required: true
          schema:
            type: "string"
          example: "7507f324-b4e6-43f4-8497-153930017bd9"
    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"
          example: "1452697e-68ff-499e-a1f2-980da8e2cea1"
    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:
          schema:
            $ref: "#/components/schemas/OBErrorResponse1"
        application/jose+jwe:
          schema:
            $ref: "#/components/schemas/OBErrorResponse1"
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization scheme used to authenticate & authorize access to a protected resource on a web server. It is used in conjunction with the OAuth 2.0 protocol for securing API endpoints.
    TPPOAuth2Security:
      type: oauth2
      description: TPP client credential authorisation flow with the ASPSP. Token URL to be used by TPP to obtain a token. Check the well-known configuration endpoint, the 'token_endpoint' property.
      flows:
        clientCredentials:
          tokenUrl: "/obie/open-banking/v1.1/oauth2/token"
          scopes:
            accounts: "Ability to read Accounts information"
    PSUOAuth2Security:
      type: oauth2
      description: OAuth flow, it is required when the PSU needs to perform SCA with
        the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU. Authorization URL to be used by TPP to redirect the PSU in order to start consent authorization journey. Check the well-known configuration endpoint, the 'authorization_endpoint' property. Token URL to be used by TPP to obtain a token. Check the well-known configuration endpoint, the 'token_endpoint' property.
      flows:
        authorizationCode:
          authorizationUrl: "/obie/open-banking/v1.1/oauth2/authorize"
          tokenUrl: "/obie/open-banking/v1.1/oauth2/token"
          scopes:
            accounts: "Ability to read Accounts information"
  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
      example: "WQEF7_6iy3HEWspIs8CDOw"
    ActiveOrHistoricCurrencyCode_0:
      description: "Identification of the currency in which the account is held. \nUsage: Currency should only be used in case one and the same account number covers several currencies\nand the initiating party needs to identify which currency needs to be used for settlement on the account."
      type: "string"
      pattern: "^[A-Z]{3,3}$"
      example: "x5555"
    ActiveOrHistoricCurrencyCode_1:
      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}$"
      example: "USD"
    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
      example: "17 Dean's Yard, Westminster, London"
    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"
      example: "2023-01-04T13:22:20+00:00"
    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"
      format: "date-time"
      example: "2023-01-04T13:22:20+00:00"
    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"
      format: "date-time"
      example: "2023-01-04T13:22:20+00:00"
    Description_0:
      description: "Specifies the description of the account type."
      type: "string"
      minLength: 1
      maxLength: 35
      example: "Test Description"
    Description_1:
      description: "Description that may be available for the statement fee."
      type: "string"
      minLength: 1
      maxLength: 128
      example: "Test Description"
    Description_2:
      description: "Description that may be available for the statement interest."
      type: "string"
      minLength: 1
      maxLength: 128
      example: "Test Description"
    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"
      format: "date-time"
      example: "2023-03-04T13:21:59+00:00"
    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"
      example: "2023-01-04T13:21:59+00:00"
    Identification_0:
      description: "Identification assigned by an institution to identify an account. This identification is known by the account owner."
      type: "string"
      minLength: 1
      maxLength: 256
      example: "Sample Identyfication0"
    Identification_1:
      description: "Unique and unambiguous identification of the servicing institution."
      type: "string"
      minLength: 1
      maxLength: 35
      example: "example for Identification_1"
    Identification_2:
      description: "Unique and unambiguous identification of a financial institution or a branch of a financial institution."
      type: "string"
      minLength: 1
      maxLength: 35
      example: "Identification_2"
    Links:
      type: "object"
      description: "Links relevant to the payload"
      properties:
        Self:
          description: "A link to the same resource used for the current request."
          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"
    MaturityDate:
      description: "Maturity date of the account.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"
      example: "2023-01-04T13:21:59+00:00"
    Meta:
      title: "MetaData"
      type: "object"
      description: "Meta Data relevant to the payload"
      properties:
        TotalPages:
          type: "integer"
        FirstAvailableDateTime:
          $ref: "#/components/schemas/ISODateTime"
        LastAvailableDateTime:
          $ref: "#/components/schemas/ISODateTime"
      additionalProperties: false
    Name_0:
      description: "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.\nNote, the account name is not the product name or the nickname of the account."
      type: "string"
      minLength: 1
      maxLength: 350
      example: "ABC"
    Name_1:
      description: "Name by which an agent is known and which is usually used to identify that agent."
      type: "string"
      minLength: 1
      maxLength: 140
      example: "ABC"
    Nickname:
      description: "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account."
      type: "string"
      minLength: 1
      maxLength: 70
      example: "CAB ALL CARE"
    OBAccount6:
      type: "object"
      description: "Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:\n\n  * Data.Currency  \n  * Data.AccountType  \n  * Data.AccountSubType\n\nFor all other accounts, the fields must be populated by the ASPSP."
      required:
        - "AccountId"
      properties:
        AccountId:
          $ref: "#/components/schemas/AccountId"
        Status:
          $ref: "#/components/schemas/OBInternalAccountStatus1Code"
        StatusUpdateDateTime:
          $ref: "#/components/schemas/StatusUpdateDateTime"
        Currency:
          $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_0"
        AccountCategory:
          $ref: "#/components/schemas/OBInternalAccountType1Code"
        AccountTypeCode:
          $ref: "#/components/schemas/OBExternalCashAccountType1Code"
        Description:
          $ref: "#/components/schemas/Description_0"
        Nickname:
          $ref: "#/components/schemas/Nickname"
        OpeningDate:
          $ref: "#/components/schemas/OpeningDate"
        MaturityDate:
          $ref: "#/components/schemas/MaturityDate"
        SwitchStatus:
          $ref: "#/components/schemas/OBInternalSwitchStatusCode"
        Account:
          type: "array"
          items:
            type: "object"
            description: "Provides the details to identify an account."
            required:
              - "SchemeName"
              - "Identification"
            properties:
              SchemeName:
                $ref: "#/components/schemas/OBInternalAccountIdentification4Code"
              Identification:
                $ref: "#/components/schemas/Identification_0"
              Name:
                $ref: "#/components/schemas/Name_0"
              LEI:
                $ref: "#/components/schemas/LEI"
        Servicer:
          $ref: "#/components/schemas/OBBranchAndFinancialInstitutionIdentification5_0"
        StatementFrequencyAndFormat:
          type: "array"
          items:
            $ref: "#/components/schemas/StatementFrequencyAndFormat"
      additionalProperties: false
    OBInternalAccountStatus1Code:
      description: >
        Specifies the status of account resource in code form.
        <dl>
          <dt>Enabled</dt><dd>Account can be used for its intended purpose.</dd>
          <dt>Disabled</dt><dd>Account cannot be used for its intended purpose, either temporarily or permanently.</dd>
          <dt>Deleted</dt><dd>Account cannot be used any longer.</dd>
          <dt>Proforma</dt><dd>Account is temporary and can be partially used for its intended purpose. The account will be fully available for use when the account servicer has received all relevant documents.</dd>
          <dt>Pending</dt><dd>Account change is pending approval.</dd>
        </dl>
      type: "string"
      enum:
        - "Enabled"
        - "Disabled"
        - "Deleted"
        - "Proforma"
        - "Pending"
      example: "Enabled"
    OBActiveCurrencyAndAmount_SimpleType:
      description: "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217."
      type: "string"
      pattern: "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
      example: "1000"
    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"
    OBActiveOrHistoricCurrencyAndAmount_5:
      type: "object"
      required:
        - "Amount"
        - "Currency"
      description: "Amount of money associated with the statement benefit type."
      properties:
        Amount:
          $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
        Currency:
          $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
    OBActiveOrHistoricCurrencyAndAmount_6:
      type: "object"
      required:
        - "Amount"
        - "Currency"
      description: "Amount of money associated with the statement fee type."
      properties:
        Amount:
          $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
        Currency:
          $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
    OBActiveOrHistoricCurrencyAndAmount_7:
      type: "object"
      required:
        - "Amount"
        - "Currency"
      description: "Amount of money associated with the statement interest amount type."
      properties:
        Amount:
          $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
        Currency:
          $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
    OBActiveOrHistoricCurrencyAndAmount_8:
      type: "object"
      required:
        - "Amount"
        - "Currency"
      description: "Amount of money associated with the amount type."
      properties:
        Amount:
          $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
        Currency:
          $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
    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"
    ExternalBalanceType1Code:
      description: >
        Balance type, in a coded form.
        <dl>
          <dt>CLAV</dt><dd>ClosingAvailable - Closing balance of amount of money that is at the disposal of the account owner on the date specified.</dd>
          <dt>CLBD</dt><dd>ClosingBooked - Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.</dd>
          <dt>XPCD</dt><dd>Expected	Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.</dd>
          <dt>FWAV</dt><dd>ForwardAvailable - Forward available balance of money that is at the disposal of the account owner on the date specified.</dd>
          <dt>INFO</dt><dd>Information - Balance for informational purposes.</dd>
          <dt>ITAV</dt><dd>InterimAvailable - Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.</dd>
          <dt>ITBD</dt><dd>InterimBooked - Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.</dd>
          <dt>OPAV</dt><dd>OpeningAvailable - Opening balance of amount of money that is at the disposal of the account owner on the date specified.</dd>
          <dt>OPBD</dt><dd>OpeningBooked - Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.</dd>
          <dt>PRCD</dt><dd>PreviouslyClosedBooked - Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.</dd>
        </dl>
      type: "string"
      enum:
        - "CLAV"
        - "CLBD"
        - "FWAV"
        - "INFO"
        - "ITAV"
        - "ITBD"
        - "OPAV"
        - "OPBD"
        - "PRCD"
        - "XPCD"
      example: "CLAV"
    ExternalBalanceSubType1Code:
      description: >
        Balance sub type, in a coded form.
        <dl>
          <dt>BCUR</dt><dd>BaseCurrency - Balance representing the amount in the domestic or base accounting currency.</dd>
          <dt>LCUR</dt><dd>LocalCurrency - Balance representing the amount in the local market currency for which the asset is held.</dd>
        </dl>
      type: "string"
      enum:
        - "BCUR"
        - "LCUR"
      example: "BCUR"
    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"
    OBBranchAndFinancialInstitutionIdentification5_0:
      type: "object"
      required:
        - "Identification"
        - "SchemeName"
      description: "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account."
      properties:
        Identification:
          $ref: "#/components/schemas/Identification_1"
        Name:
          $ref: '#/components/schemas/Name_1'
        SchemeName:
          $ref: "#/components/schemas/OBExternalFinancialInstitutionIdentification4Code"
    OBBranchAndFinancialInstitutionIdentification6_1:
      type: "object"
      description: "Financial institution servicing an account for the creditor."
      properties:
        SchemeName:
          $ref: "#/components/schemas/OBExternalFinancialInstitutionIdentification4Code"
        Identification:
          $ref: "#/components/schemas/Identification_2"
        Name:
          $ref: "#/components/schemas/Name_1"
        PostalAddress:
          $ref: "#/components/schemas/OBPostalAddress7"
        LEI:
          $ref: "#/components/schemas/LEI"
    OBBranchAndFinancialInstitutionIdentification6_2:
      type: "object"
      description: "Financial institution servicing an account for the debtor."
      properties:
        SchemeName:
          $ref: "#/components/schemas/OBExternalFinancialInstitutionIdentification4Code"
        Identification:
          $ref: "#/components/schemas/Identification_2"
        Name:
          $ref: "#/components/schemas/Name_1"
        PostalAddress:
          $ref: "#/components/schemas/OBPostalAddress7"
        LEI:
          $ref: "#/components/schemas/LEI"
    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/OBExternalAccountIdentification4Code"
        Identification:
          $ref: "#/components/schemas/Identification_0"
        Name:
          $ref: "#/components/schemas/Name_0"
        SecondaryIdentification:
          $ref: "#/components/schemas/SecondaryIdentification"
        Proxy:
          $ref: "#/components/schemas/OBProxy1"
    OBCashAccount6_1:
      type: "object"
      description: "Unambiguous identification of the account of the debtor, in the case of a crebit transaction."
      properties:
        SchemeName:
          $ref: "#/components/schemas/OBExternalAccountIdentification4Code"
        Identification:
          $ref: "#/components/schemas/Identification_0"
        Name:
          $ref: "#/components/schemas/Name_0"
        SecondaryIdentification:
          $ref: "#/components/schemas/SecondaryIdentification"
        Proxy:
          $ref: "#/components/schemas/OBProxy1"
    OBCreditDebitCode_0:
      description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
      type: "string"
      enum:
        - "Credit"
        - "Debit"
      example: "Credit"
    OBCreditDebitCode_1:
      description: "Indicates whether the transaction is a credit or a debit entry."
      type: "string"
      enum:
        - "Credit"
        - "Debit"
      example: "Debit"
    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."
      type: "string"
      enum:
        - "Credit"
        - "Debit"
      example: "Credit"
    OBCurrencyExchange5:
      type: "object"
      required:
        - "SourceCurrency"
        - "ExchangeRate"
      description: "Set of elements used to provide details on the currency exchange."
      properties:
        SourceCurrency:
          description: "Currency from which an amount is to be converted in a currency conversion."
          type: "string"
          pattern: "^[A-Z]{3,3}$"
          example: "EUR"
        TargetCurrency:
          description: "Currency into which an amount is to be converted in a currency conversion."
          type: "string"
          pattern: "^[A-Z]{3,3}$"
          example: "USD"
        UnitCurrency:
          description: "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP."
          type: "string"
          pattern: "^[A-Z]{3,3}$"
          example: "USD"
        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.\nUsage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency)."
          type: "number"
          example: "1"
        ContractIdentification:
          description: "Unique identification to unambiguously identify the foreign exchange contract."
          type: "string"
          minLength: 1
          maxLength: 35
          example: "7774890001212"
        QuotationDate:
          description: "Date and time at which an exchange rate is quoted.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"
        InstructedAmount:
          type: "object"
          required:
            - "Amount"
            - "Currency"
          description: "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party."
          properties:
            Amount:
              $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
            Currency:
              $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
    ExternalEntryStatus1Code:
      description: >
        Status of a transaction entry on the books of the account servicer.
        <dl>
          <dt>BOOK</dt><dd>Booked - Booked means that the transfer of money has been completed between account servicer and account owner. Usage: Status Booked does not necessarily imply finality of money as this depends on other factors such as the payment system used, the completion of the end-to-end transaction and the terms agreed between account servicer and owner. Status Booked is the only status that can be reversed.</dd>
          <dt>RJCT</dt><dd>Rejected - Entry was on the books of the account servicer and has been rejected.</dd>
          <dt>PDNG</dt><dd>Pending - Booking on the account owner's account in the account servicer's ledger has not been completed. Usage: this can be used for expected items, or for items for which some conditions still need to be fulfilled before they can be booked. If booking takes place, the entry will be included with status Booked in subsequent account report or statement. Status Pending cannot be reversed.</dd>
        </dl>
      type: "string"
      enum:
        - "BOOK"
        - "RJCT"
        - "PDNG"
      example: "BOOK"
    OBTransactionMutability1Code:
      description: "Specifies the Mutability of the Transaction record."
      type: "string"
      enum:
        - "Mutable"
        - "Immutable"
      example: "Mutable"
    OBError1:
      type: "object"
      properties:
        ErrorCode:
          description: "Low level textual error code, e.g., UK.OBIE.Field.Missing"
          type: "string"
          enum:
            - "UK.OBIE.Field.Expected"
            - "UK.OBIE.Field.Invalid"
            - "UK.OBIE.Field.InvalidDate"
            - "UK.OBIE.Field.Missing"
            - "UK.OBIE.Field.Unexpected"
            - "UK.OBIE.Header.Invalid"
            - "UK.OBIE.Header.Missing"
            - "UK.OBIE.Reauthenticate"
            - "UK.OBIE.Resource.ConsentMismatch"
            - "UK.OBIE.Resource.InvalidConsentStatus"
            - "UK.OBIE.Resource.InvalidFormat"
            - "UK.OBIE.Resource.NotFound"
            - "UK.OBIE.Rules.AfterCutOffDateTime"
            - "UK.OBIE.Rules.DuplicateReference"
            - "UK.OBIE.Signature.Invalid"
            - "UK.OBIE.Signature.InvalidClaim"
            - "UK.OBIE.Signature.Malformed"
            - "UK.OBIE.Signature.Missing"
            - "UK.OBIE.Signature.MissingClaim"
            - "UK.OBIE.Signature.Unexpected"
            - "UK.OBIE.UnexpectedError"
            - "UK.OBIE.Unsupported.AccountIdentifier"
            - "UK.OBIE.Unsupported.AccountSecondaryIdentifier"
            - "UK.OBIE.Unsupported.Currency"
            - "UK.OBIE.Unsupported.Frequency"
            - "UK.OBIE.Unsupported.LocalInstrument"
            - "UK.OBIE.Unsupported.Scheme"
        Message:
          description: "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field"
          type: "string"
          minLength: 1
          maxLength: 500
          example: "This action is not allowed on the account type in the request"
        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
    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
          example: "ABC"
        Id:
          description: "A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors."
          type: "string"
          minLength: 1
          maxLength: 40
          example: "1ec1bb5f-0dbd-46b9-a9eb-fa49a4e38315"
        Message:
          description: "Brief Error message, e.g., 'There is something wrong with the request parameters provided'"
          type: "string"
          minLength: 1
          maxLength: 500
          example: "test error message"
        Errors:
          items:
            $ref: "#/components/schemas/OBError1"
          type: "array"
          minItems: 1
      required:
        - "Code"
        - "Message"
        - "Errors"
      additionalProperties: false
    OBExternalAccountIdentification4Code:
      description: "Name of the identification scheme, in a coded form as published in an external list."
      type: "string"
      enum:
        - "UK.OBIE.BBAN"
        - "UK.OBIE.IBAN"
        - "UK.OBIE.PAN"
        - "UK.OBIE.Paym"
        - "UK.OBIE.SortCodeAccountNumber"
      example: "UK.OBIE.BBAN"
    OBExternalCashAccountType1Code:
      description: >
        Specifies the sub type of account (product family group)
        <dl>
          <dt>CHAR</dt><dd>Account used for charges if different from the account for payment.</dd>
          <dt>CARD</dt><dd>Account used for credit card payments.</dd>
          <dt>CACC</dt><dd>Account used to post debits and credits when no specific account has been nominated.</dd>
          <dt>LOAN</dt><dd>Account used for loans.</dd>
          <dt>MORT</dt><dd>Account is used for mortgage account</dd>
          <dt>SVGS</dt><dd>Account used for savings.</dd>
        </dl>
      type: "string"
      enum:
        - "CHAR"
        - "CARD"
        - "CACC"
        - "LOAN"
        - "MORT"
        - "SVGS"
      example: "CHAR"
    OBInternalAccountType1Code:
      description: >
        Specifies the type of account (personal or business).
        <dl>
          <dt>Personal</dt><dd>Specifies that the type of account is personal.</dd>
          <dt>Business</dt><dd>Specifies that the type of account is business.</dd>
        </dl>
      type: "string"
      enum:
        - "Personal"
        - "Business"
      example: "Personal"
    OBExternalFinancialInstitutionIdentification4Code:
      description: "Name of the identification scheme, in a coded form as published in an external list."
      type: "string"
      example: "UK.OBIE.BICFI"
      enum:
        - "UK.OBIE.BICFI"
    OBInternalSwitchStatusCode:
      description: >
        The switch status for the account.
        <dl>
          <dt>UK.CASS.NotSwitched</dt><dd>Indicator to show that the account has not been switched to another ASPSP</dd>
          <dt>UK.CASS.SwitchCompleted</dt><dd>Indicator to show that the account has been switched and the switching process is complete</dd>
        </dl>
      type: "string"
      enum:
        - "UK.CASS.NotSwitched"
        - "UK.CASS.SwitchCompleted"
      example: "UK.CASS.NotSwitched"
    OBExternalStatementAmountType1Code:
      description: "Amount type, in a coded form."
      type: "string"
      example: "UK.OBIE.ArrearsClosingBalance"
      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"
    OBExternalStatementBenefitType1Code:
      description: "Benefit type, in a coded form."
      type: "string"
      example: "UK.OBIE.Insurance"
      enum:
        - "UK.OBIE.Cashback"
        - "UK.OBIE.Insurance"
        - "UK.OBIE.TravelDiscount"
        - "UK.OBIE.TravelInsurance"
    OBExternalStatementDateTimeType1Code:
      description: "Date time type, in a coded form."
      type: "string"
      example: "UK.OBIE.LastPayment"
      enum:
        - "UK.OBIE.BalanceTransferPromoEnd"
        - "UK.OBIE.DirectDebitDue"
        - "UK.OBIE.LastPayment"
        - "UK.OBIE.LastStatement"
        - "UK.OBIE.NextStatement"
        - "UK.OBIE.PaymentDue"
        - "UK.OBIE.PurchasePromoEnd"
        - "UK.OBIE.StatementAvailable"
    OBExternalStatementFeeFrequency1Code:
      description: "How frequently the fee is applied to the Account."
      type: "string"
      example: "UK.OBIE.Weekly"
      enum:
        - "UK.OBIE.ChargingPeriod"
        - "UK.OBIE.PerTransactionAmount"
        - "UK.OBIE.PerTransactionPercentage"
        - "UK.OBIE.Quarterly"
        - "UK.OBIE.StatementMonthly"
        - "UK.OBIE.Weekly"
    OBExternalStatementFeeRateType1Code:
      description: "Description that may be available for the statement fee rate type."
      type: "string"
      example: "UK.OBIE.AER"
      enum:
        - "UK.OBIE.AER"
        - "UK.OBIE.EAR"
        - "UK.OBIE.FixedRate"
    OBExternalStatementFeeType1Code:
      description: "Fee type, in a coded form."
      type: "string"
      example: "UK.OBIE.Gambling"
      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"
    OBExternalStatementInterestFrequency1Code:
      description: "Specifies the statement fee type requested"
      type: "string"
      example: "UK.OBIE.HalfYearly"
      enum:
        - "UK.OBIE.Daily"
        - "UK.OBIE.HalfYearly"
        - "UK.OBIE.Monthly"
        - "UK.OBIE.PerStatementDate"
        - "UK.OBIE.Quarterly"
        - "UK.OBIE.Weekly"
        - "UK.OBIE.Yearly"
    OBExternalStatementInterestRateType1Code:
      description: "Description that may be available for the statement Interest rate type."
      type: "string"
      example: "UK.OBIE.Net"
      enum:
        - "UK.OBIE.BOEBaseRate"
        - "UK.OBIE.FixedRate"
        - "UK.OBIE.Gross"
        - "UK.OBIE.LoanProviderBaseRate"
        - "UK.OBIE.Net"
    OBExternalStatementInterestType1Code:
      description: "Interest amount type, in a coded form."
      type: "string"
      example: "UK.OBIE.Cash"
      enum:
        - "UK.OBIE.BalanceTransfer"
        - "UK.OBIE.Cash"
        - "UK.OBIE.EstimatedNext"
        - "UK.OBIE.Purchase"
        - "UK.OBIE.Total"
    OBExternalStatementRateType1Code:
      description: "Statement rate type, in a coded form."
      type: "string"
      example: "UK.OBIE.AnnualCash"
      enum:
        - "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"
    OBExternalStatementType1Code:
      description: "Statement type, in a coded form."
      type: "string"
      example: "Interim"
      enum:
        - "AccountClosure"
        - "AccountOpening"
        - "Annual"
        - "Interim"
        - "RegularPeriodic"
    OBExternalStatementValueType1Code:
      description: "Statement value type, in a coded form."
      type: "string"
      example: "UK.OBIE.Debits"
      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"
    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
          example: "TDG00231"
        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
          example: "18245"
    OBPostalAddress7:
      description: "Postal address of a party"
      type: "object"
      properties:
        AddressType:
          $ref: "#/components/schemas/OBAddressType2Code"
        Department:
          description: "Identification of a division of a large organisation or building."
          type: "string"
          maxLength: 70
        SubDepartment:
          description: "Identification of a sub-division of a large organisation or building."
          type: "string"
          maxLength: 70
        StreetName:
          description: "Name of a street or thoroughfare."
          type: "string"
          maxLength: 70
        BuildingNumber:
          description: "Number that identifies the position of a building on a street."
          type: "string"
          maxLength: 16
        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"
          maxLength: 16
        TownName:
          description: "Name of a built-up area, with defined boundaries, and a local government."
          type: "string"
          maxLength: 35
        CountrySubDivision:
          description: "Identifies a subdivision of a country such as state, region, county."
          type: "string"
          maxLength: 35
        Country:
          description: "Nation with its own government."
          type: "string"
          pattern: "^[A-Z]{2,2}$"
        AddressLine:
          type: "array"
          items:
            description: "Information that locates and identifies a specific address, as defined by postal services, presented in free format text."
            type: "string"
            minLength: 1
            maxLength: 70
          minItems: 0
          maxItems: 7
        BuildingName:
          description: "Name of a referenced building."
          type: "string"
          maxLength: 140
        CareOf:
          description: "The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address.
          They will receive the mail for the individual."
          type: "string"
          maxLength: 140
        DistrictName:
          description: "Number that of the regional area, known as a district, which forms part of an address."
          type: "string"
          maxLength: 140
        Floor:
          description: "Number that identifies the level within a building."
          type: "string"
          maxLength: 70
        PostBox:
          description: "Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for."
          type: "string"
          maxLength: 16
        Room:
          description: "Information that locates and identifies a room to form part of an address."
          type: "string"
          maxLength: 70
        TownLocationName:
          description: "Name of a built-up area, with defined boundaries, and a local government."
          type: "string"
          maxLength: 140
        UnitNumber:
          description: "Number that identifies the unit of a specific address."
          type: "string"
          maxLength: 16
    OBAddressType2Code:
      description: >
        Identifies the nature of the postal address.
        <dl>
          <dt>BIZZ</dt><dd>Business - Address is the business address</dd>
          <dt>DLVY</dt><dd>Delivery - Address is the address to which delivery is to take place.</dd>
          <dt>MLTO</dt><dd>Mail To - Address is the address to which mail is sent.</dd>
          <dt>PBOX</dt><dd>PO Box - Address is a postal office (PO) box.</dd>
          <dt>ADDR</dt><dd>Postal - Address is the complete postal address.</dd>
          <dt>HOME</dt><dd>Residential - Address is the home address.</dd>
          <dt>CORR</dt><dd>Correspondence - Address is the address where the correspondence is sent.</dd>
          <dt>STAT</dt><dd>Statement - Address is the address where statements are sent.</dd>
        </dl>
      type: "string"
      enum:
        - "BIZZ"
        - "DLVY"
        - "MLTO"
        - "PBOX"
        - "ADDR"
        - "HOME"
        - "CORR"
        - "STAT"
      example: "BIZZ"
    OBRate1_0:
      description: "Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)"
      type: "number"
      example: "12"
    OBRate1_1:
      description: "field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary."
      type: "number"
      example: "12"
    OBReadAccount6:
      type: "object"
      required:
        - "Data"
      properties:
        Data:
          type: "object"
          properties:
            Account:
              type: "array"
              items:
                $ref: "#/components/schemas/OBAccount6"
        Links:
          $ref: "#/components/schemas/Links"
        Meta:
          $ref: "#/components/schemas/Meta"
      additionalProperties: false
    OBReadBalance1:
      type: "object"
      required:
        - "Data"
      properties:
        Data:
          type: "object"
          required:
            - "Balance"
          properties:
            Balance:
              type: "array"
              items:
                type: "object"
                description: "Set of elements used to define the balance details."
                required:
                  - "AccountId"
                  - "CreditDebitIndicator"
                  - "Type"
                  - "DateTime"
                  - "Amount"
                properties:
                  AccountId:
                    $ref: "#/components/schemas/AccountId"
                  CreditDebitIndicator:
                    $ref: "#/components/schemas/OBCreditDebitCode_2"
                  Type:
                    $ref: "#/components/schemas/ExternalBalanceType1Code"
                  DateTime:
                    description: "Indicates the date (and time) of the balance.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"
                    example: "test value"
                  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:
                        $ref: "#/components/schemas/ExternalBalanceSubType1Code"
                  CreditLine:
                    type: "array"
                    items:
                      type: "object"
                      description: "Set of elements used to provide details on the credit line."
                      required:
                        - "Included"
                      properties:
                        Included:
                          description: "Indicates whether or not the credit line is included in the balance of the account.\nUsage: If not present, credit line is not included in the balance amount of the account."
                          type: "boolean"
                          example: "True"
                        Type:
                          description: "Limit type, in a coded form."
                          type: "string"
                          example: "Credit"
                          enum:
                            - "Available"
                            - "Credit"
                            - "Emergency"
                            - "Pre-Agreed"
                            - "Temporary"
                        Amount:
                          type: "object"
                          required:
                            - "Amount"
                            - "Currency"
                          description: "Amount of money of the credit line."
                          properties:
                            Amount:
                              $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
                            Currency:
                              $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
              minItems: 1
        Links:
          $ref: "#/components/schemas/Links"
        Meta:
          $ref: "#/components/schemas/Meta"
      additionalProperties: false
    OBReadConsent1:
      type: "object"
      required:
        - "Data"
        - "Risk"
      properties:
        Data:
          type: "object"
          required:
            - "Permissions"
          properties:
            Permissions:
              type: "array"
              items:
                description: "Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP."
                type: "string"
                enum:
                  - "ReadAccountsBasic"
                  - "ReadAccountsDetail"
                  - "ReadBalances"
                  - "ReadOffers"
                  - "ReadPAN"
                  - "ReadParty"
                  - "ReadProducts"
                  - "ReadStatementsBasic"
                  - "ReadStatementsDetail"
                  - "ReadTransactionsBasic"
                  - "ReadTransactionsCredits"
                  - "ReadTransactionsDebits"
                  - "ReadTransactionsDetail"
              minItems: 1
            ExpirationDateTime:
              description: "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.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"
              example: "2022-11-15 09:14:41"
            TransactionFromDateTime:
              description: "Specified start date and time for the transaction query period.\nIf this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.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: "2022-11-15 09:14:45"
              example: "test value"
            TransactionToDateTime:
              description: "Specified end date and time for the transaction query period.\nIf this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.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"
              example: "2022-11-15 09:14:49"
        Risk:
          $ref: "#/components/schemas/OBRisk2"
      additionalProperties: false
    OBReadConsentResponse1:
      type: "object"
      required:
        - "Data"
        - "Risk"
      properties:
        Data:
          type: "object"
          required:
            - "ConsentId"
            - "CreationDateTime"
            - "Status"
            - "StatusUpdateDateTime"
            - "Permissions"
          properties:
            ConsentId:
              description: "Unique identification as assigned to identify the account access consent resource."
              type: "string"
              minLength: 1
              maxLength: 128
              example: "699588e-b5c9-48d5-b0fc-00d52b229f7d"
            CreationDateTime:
              $ref: "#/components/schemas/CreationDateTime"
            Status:
              $ref: "#/components/schemas/OBInternalConsentStatus1Code"
            StatusUpdateDateTime:
              $ref: "#/components/schemas/StatusUpdateDateTime"
            Permissions:
              type: "array"
              items:
                description: "Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP."
                type: "string"
                enum:
                  - "ReadAccountsBasic"
                  - "ReadAccountsDetail"
                  - "ReadBalances"
                  - "ReadOffers"
                  - "ReadPAN"
                  - "ReadParty"
                  - "ReadProducts"
                  - "ReadStatementsBasic"
                  - "ReadStatementsDetail"
                  - "ReadTransactionsBasic"
                  - "ReadTransactionsCredits"
                  - "ReadTransactionsDebits"
                  - "ReadTransactionsDetail"
              minItems: 1
            ExpirationDateTime:
              description: "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.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"
              example: "2022-11-15 09:14:45"
            TransactionFromDateTime:
              description: "Specified start date and time for the transaction query period.\nIf this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.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"
              example: "2022-11-15 09:14:45"
            TransactionToDateTime:
              description: "Specified end date and time for the transaction query period.\nIf this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.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"
              example: "2022-11-15 09:14:45"
            StatusReason:
              type: "array"
              items:
                $ref: "#/components/schemas/OBStatusReason"
        Risk:
          $ref: "#/components/schemas/OBRisk2"
        Links:
          $ref: "#/components/schemas/Links"
        Meta:
          $ref: "#/components/schemas/Meta"
      additionalProperties: false
    OBReadDataStatement2:
      type: "object"
      properties:
        Statement:
          type: "array"
          items:
            $ref: "#/components/schemas/OBStatement2"
      additionalProperties: false
    OBReadDataTransaction6:
      type: "object"
      properties:
        Transaction:
          type: "array"
          items:
            $ref: "#/components/schemas/OBTransaction6"
      additionalProperties: false
    OBReadStatement2:
      type: "object"
      required:
        - "Data"
      properties:
        Data:
          $ref: "#/components/schemas/OBReadDataStatement2"
        Links:
          $ref: "#/components/schemas/Links"
        Meta:
          $ref: "#/components/schemas/Meta"
      additionalProperties: false
    OBReadTransaction6:
      type: "object"
      required:
        - "Data"
      properties:
        Data:
          $ref: "#/components/schemas/OBReadDataTransaction6"
        Links:
          $ref: "#/components/schemas/Links"
        Meta:
          $ref: "#/components/schemas/Meta"
      additionalProperties: false
    OBRisk2:
      description: "The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info."
      type: "object"
      properties: { }
      additionalProperties: false
    OBStatement2:
      type: "object"
      description: "Provides further details on a statement resource."
      required:
        - "AccountId"
        - "StatementId"
        - "StatementReference"
        - "Type"
        - "StartDateTime"
        - "EndDateTime"
        - "CreationDateTime"
        - "StatementDescription"
        - "StatementFee"
        - "StatementInterest"
        - "StatementAmount"
      properties:
        AccountId:
          $ref: "#/components/schemas/AccountId"
        StatementId:
          $ref: "#/components/schemas/StatementId"
        StatementReference:
          $ref: "#/components/schemas/StatementReference"
        Type:
          $ref: "#/components/schemas/OBExternalStatementType1Code"
        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"
            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/OBExternalStatementBenefitType1Code"
              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:
              - "Description"
              - "CreditDebitIndicator"
              - "Type"
              - "Rate"
              - "RateType"
              - "Frequency"
              - "Amount"
            properties:
              Description:
                $ref: "#/components/schemas/Description_1"
              CreditDebitIndicator:
                $ref: "#/components/schemas/OBCreditDebitCode_0"
              Type:
                $ref: "#/components/schemas/OBExternalStatementFeeType1Code"
              Rate:
                $ref: "#/components/schemas/OBRate1_0"
              RateType:
                $ref: "#/components/schemas/OBExternalStatementFeeRateType1Code"
              Frequency:
                $ref: "#/components/schemas/OBExternalStatementFeeFrequency1Code"
              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:
              - "Description"
              - "CreditDebitIndicator"
              - "Type"
              - "Rate"
              - "RateType"
              - "Frequency"
              - "Amount"
            properties:
              Description:
                $ref: "#/components/schemas/Description_2"
              CreditDebitIndicator:
                $ref: "#/components/schemas/OBCreditDebitCode_0"
              Type:
                $ref: "#/components/schemas/OBExternalStatementInterestType1Code"
              Rate:
                $ref: "#/components/schemas/OBRate1_1"
              RateType:
                $ref: "#/components/schemas/OBExternalStatementInterestRateType1Code"
              Frequency:
                $ref: "#/components/schemas/OBExternalStatementInterestFrequency1Code"
              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/OBExternalStatementAmountType1Code"
              Amount:
                $ref: "#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_8"
        StatementDateTime:
          type: "array"
          items:
            type: "object"
            description: "Set of elements used to provide details of a generic date time for the statement resource."
            required:
              - "DateTime"
              - "Type"
            properties:
              DateTime:
                $ref: "#/components/schemas/DateTime"
              Type:
                $ref: "#/components/schemas/OBExternalStatementDateTimeType1Code"
        StatementRate:
          type: "array"
          items:
            type: "object"
            description: "Set of elements used to provide details of a generic rate related to the statement resource."
            required:
              - "Rate"
              - "Type"
            properties:
              Rate:
                $ref: "#/components/schemas/Rate"
              Type:
                $ref: "#/components/schemas/OBExternalStatementRateType1Code"
        StatementValue:
          type: "array"
          items:
            type: "object"
            description: "Set of elements used to provide details of a generic number value related to the statement resource."
            required:
              - "Value"
              - "Type"
            properties:
              Value:
                $ref: "#/components/schemas/Value"
              Type:
                $ref: "#/components/schemas/OBExternalStatementValueType1Code"
      additionalProperties: false
    OBSupplementaryData1:
      type: "object"
      properties: { }
      additionalProperties: true
      description: "Additional information that can not be captured in the structured fields and/or any other specific block."
    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/OBTransactionMutability1Code"
        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"
        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:
          description: "Code related to the type of services or goods and corresponds to the underlying purpose of the transaction."
          minLength: 4
          maxLength: 4
          type: "string"
        ExtendedProprietaryBankTransactionCodes:
          $ref: "#/components/schemas/OBExtendedProprietaryBankTransactionCode"
        UltimateCreditor:
          $ref: "#/components/schemas/OBUltimateCreditor1"
        UltimateDebtor:
          $ref: "#/components/schemas/OBUltimateDebtor1"
      additionalProperties: false
    OBTransactionCardInstrument1:
      type: "object"
      required:
        - "CardSchemeName"
      description: "Set of elements to describe the card instrument used in the transaction."
      properties:
        CardSchemeName:
          description: "Name of the card scheme."
          type: "string"
          enum:
            - "AmericanExpress"
            - "Diners"
            - "Discover"
            - "MasterCard"
            - "VISA"
        AuthorisationType:
          description: "The card authorisation type."
          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
    OBTransactionCashBalance:
      type: "object"
      required:
        - "CreditDebitIndicator"
        - "Type"
        - "Amount"
      description: "Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account."
      properties:
        CreditDebitIndicator:
          $ref: "#/components/schemas/OBCreditDebitCode_2"
        Type:
          $ref: "#/components/schemas/ExternalBalanceType1Code"
        Amount:
          type: "object"
          required:
            - "Amount"
            - "Currency"
          description: "Amount of money of the cash balance after a transaction entry is applied to the account.."
          properties:
            Amount:
              $ref: "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
            Currency:
              $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode_1"
      additionalProperties: false
    LEI:
      description: >
        Legal entity identification as an alternate identification for a party.
        Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
      type: "string"
      pattern: "^[A-Z0-9]{18,18}[0-9]{2,2}$"
      minLength: 1
      maxLength: 20
      example: "IZ9Q00LZEVUKWCQY6X15"
    OpeningDate:
      description: "Date on which the account and related basic services are effectively operational for the account owner.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"
      example: "2023-01-04"
    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
          example: "SGDI"
        Issuer:
          description: "Identification of the issuer of the proprietary bank transaction code."
          type: "string"
          minLength: 1
          maxLength: 35
          example: "NBP"
      additionalProperties: false
    Rate:
      description: "Rate associated with the statement rate type."
      type: "string"
      pattern: "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
      example: "0"
    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
      example: "4941202460847847"
    StartDateTime:
      description: "Date and time at which the statement period starts.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"
      example: "2023-01-04T00:00:00+00:00"
    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
      example: "HEWspIs8CDOwWQEF7_6iy3"
    StatementReference:
      description: "Unique reference for the statement. This reference may be optionally populated if available."
      type: "string"
      minLength: 1
      maxLength: 35
      example: "b55de0cd-0bd4-4903-8811-84e1e980f1c0"
    StatusUpdateDateTime:
      description: "Date and time at which the resource status was updated.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"
      example: "2023-01-04T00:00:00+00:00"
    TransactionId:
      description: "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable."
      type: "string"
      minLength: 1
      maxLength: 210
      example: "0432023004141005879040000-0326P10000000000000010000000000000010000000000OBP"
    TransactionInformation:
      description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text."
      type: "string"
      minLength: 1
      maxLength: 500
      example: "example TransactionInformation"
    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
      example: "example TransactionReference"
    Value:
      description: "Value associated with the statement value type."
      type: "string"
      minLength: 1
      maxLength: 40
      example: "10"
    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"
    StatementFrequencyAndFormat:
      description: "The frequency and format of the statements delivered for the account"
      type: "object"
      properties:
        CommunicationMethod:
          $ref: "#/components/schemas/OBExternalCommunicationMethod2Code"
        Format:
          $ref: "#/components/schemas/ExternalDocumentFormat1Code"
        Frequency:
          $ref: "#/components/schemas/OBFrequency2Code"
        DeliveryAddress:
          $ref: "#/components/schemas/OBPostalAddress7"
    OBExternalCommunicationMethod2Code:
      description: >
        <dl>
          <dt>EMAL</dt><dd>Email</dd>
          <dt>FAXI</dt><dd>Fax</dd>
          <dt>FILE</dt><dd>File</dd>
          <dt>ONLI</dt><dd>Online</dd>
          <dt>POST</dt><dd>Postal Service</dd>
        </dl>
      type: string
      enum:
        - "EMAL"
        - "FAXI"
        - "FILE"
        - "ONLI"
        - "POST"
      example: "EMAL"
    ExternalDocumentFormat1Code:
      description: >
        <dl>
          <dt>DPDF</dt><dd>Document format is PDF.</dd>
          <dt>DXML</dt><dd>Document format is XML.</dd>
          <dt>SDSH</dt><dd>Document format is a spreadsheet.</dd>
          <dt>WORD</dt><dd>Document format is Word.</dd>
          <dt>XSLT</dt><dd>Document format is XSLT.</dd>
        </dl>
      type: string
      enum:
        - "DPDF"
        - "DXML"
        - "SDSH"
        - "WORD"
        - "XSLT"
      example: "DPDF"
    OBFrequency2Code:
      description: >
        <dl>
          <dt>YEAR<dt><dd>Annual - Event takes place every year or once a year.</dd>
          <dt>DAIL<dt><dd>Daily - Event takes place every day.</dd>
          <dt>INDA<dt><dd>Intra-day - Event takes place several times a day.</dd>
          <dt>MNTH<dt><dd>Monthly - Event takes place every month or once a month.</dd>
          <dt>QURT<dt><dd>Quarterly - Event takes place every three months or four times a year.</dd>
          <dt>MIAN<dt><dd>Semi-annual - Event takes place every six months or two times a year.</dd>
          <dt>TEND<dt><dd>Ten days - Event takes place every ten business days.</dd>
          <dt>MOVE<dt><dd>Triggered by Movement	Event takes place at the end of the day if there was a movement on the account, otherwise nothing is sent that day.</dd>
          <dt>WEEK<dt><dd>Weekly - Event takes place once a week.</dd>
        </dl>
      type: string
      enum:
        - "YEAR"
        - "DAIL"
        - "INDA"
        - "MNTH"
        - "QURT"
        - "MIAN"
        - "TEND"
        - "MOVE"
        - "WEEK"
      example: "YEAR"
    ExternalCategoryPurpose1Code:
      description: >
        Specifies the high level purpose of the mandate based on a set of pre-defined categories.
        <dl>
          <dt>BONU</dt><dd>BonusPayment - Transaction is the payment of a bonus.</dd>
          <dt>CASH</dt><dd>CashManagementTransfer - Transaction is a general cash management instruction.</dd>
          <dt>CBLK</dt><dd>CardBulkClearing - A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.</dd>
          <dt>CCRD</dt><dd>CreditCardPayment - Transaction is related to a payment of credit card.</dd>
          <dt>CORT</dt><dd>TradeSettlementPayment - Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.</dd>
          <dt>DCRD</dt><dd>DebitCardPayment - Transaction is related to a payment of debit card.</dd>
          <dt>DIVI</dt><dd>Dividend - Transaction is the payment of dividends.</dd>
          <dt>DVPM</dt><dd>DeliverAgainstPayment - Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.</dd>
          <dt>EPAY</dt><dd>Epayment - Transaction is related to ePayment.</dd>
          <dt>FCIN</dt><dd>FeeCollectionAndInterest - Transaction is related to the payment of a fee and interest.</dd>
          <dt>FCOL</dt><dd>FeeCollection - A service that is settling card transaction related fees between two parties.</dd>
          <dt>GP2P</dt><dd>PersontoPersonPayment - General Person-to-Person Payment. Debtor and Creditor are natural persons.</dd>
          <dt>GOVT</dt><dd>GovernmentPayment - Transaction is a payment to or from a government department.</dd>
          <dt>HEDG</dt><dd>Hedging - Transaction is related to the payment of a hedging operation.</dd>
          <dt>ICCP</dt><dd>IrrevocableCreditCardPayment - Transaction is reimbursement of credit card payment.</dd>
          <dt>IDCP</dt><dd>IrrevocableDebitCardPayment - Transaction is reimbursement of debit card payment.</dd>
          <dt>INTC</dt><dd>IntraCompanyPayment - Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.</dd>
          <dt>INTE</dt><dd>Interest - Transaction is the payment of interest.</dd>
          <dt>LBOX</dt><dd>LockboxTransactions - Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.</dd>
          <dt>LOAN</dt><dd>Loan - Transaction is related to the transfer of a loan to a borrower.</dd>
          <dt>MP2B</dt><dd>Commercial - Mobile P2B Payment</dd>
          <dt>MP2P</dt><dd>Consumer - Mobile P2P Payment</dd>
          <dt>OTHR</dt><dd>OtherPayment - Other payment purpose.</dd>
          <dt>PENS</dt><dd>PensionPayment - Transaction is the payment of pension.</dd>
          <dt>RPRE</dt><dd>Represented - Collection used to re-present previously reversed or returned direct debit transactions.</dd>
          <dt>RRCT</dt><dd>ReimbursementReceivedCreditTransfer - Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.</dd>
          <dt>RVPM</dt><dd>ReceiveAgainstPayment - Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.</dd>
          <dt>SALA</dt><dd>SalaryPayment - Transaction is the payment of salaries.</dd>
          <dt>SECU</dt><dd>Securities - Transaction is the payment of securities.</dd>
          <dt>SSBE</dt><dd>SocialSecurityBenefit - Transaction is a social security benefit, ie payment made by a government to support individuals.</dd>
          <dt>SUPP</dt><dd>SupplierPayment  Transaction is related to a payment to a supplier.</dd>
          <dt>TAXS</dt><dd>TaxPayment  Transaction is the payment of taxes.</dd>
          <dt>TRAD</dt><dd>Trade - Transaction is related to the payment of a trade finance transaction.</dd>
          <dt>TREA</dt><dd>TreasuryPayment - Transaction is related to treasury operations. E.g. financial contract settlement.</dd>
          <dt>VATX</dt><dd>ValueAddedTaxPayment - Transaction is the payment of value added tax.</dd>
          <dt>WHLD</dt><dd>WithHolding - Transaction is the payment of withholding tax.</dd>
          <dt>SWEP</dt><dd>CashManagementSweepAccount - Classification: Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.</dd>
          <dt>TOPG</dt><dd>CashManagementTopAccount - Classification: Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.</dd>
          <dt>ZABA</dt><dd>CashManagementZeroBalanceAccount - Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.</dd>
          <dt>VOST</dt><dd>CrossborderMIPayments - Transaction to be processed as a domestic payment instruction originated from a foreign bank.</dd>
          <dt>FCDT</dt><dd>ForeignCurrencyDomesticTransfer - Foreign Currency Transaction that is processed between two domestic financial institutions.</dd>
          <dt>CIPC</dt><dd>CashInPreCredit - Transaction is a direct debit for a cash order of notes and/or coins.</dd>
          <dt>CONC</dt><dd>CashOutNotesCoins - Transaction is a direct debit for a cash order of notes and/or coins.</dd>
          <dt>CGWV</dt><dd>CarrierGuardedWholesaleValuables - Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.</dd>
        </dl>
      type: "string"
      enum:
        - "BONU"
        - "CASH"
        - "CBLK"
        - "CCRD"
        - "CORT"
        - "DCRD"
        - "DIVI"
        - "DVPM"
        - "EPAY"
        - "FCIN"
        - "FCOL"
        - "GP2P"
        - "GOVT"
        - "HEDG"
        - "ICCP"
        - "IDCP"
        - "INTC"
        - "INTE"
        - "LBOX"
        - "LOAN"
        - "MP2B"
        - "MP2P"
        - "OTHR"
        - "PENS"
        - "RPRE"
        - "RRCT"
        - "RVPM"
        - "SALA"
        - "SECU"
        - "SSBE"
        - "SUPP"
        - "TAXS"
        - "TRAD"
        - "TREA"
        - "VATX"
        - "WHLD"
        - "SWEP"
        - "TOPG"
        - "ZABA"
        - "VOST"
        - "FCDT"
        - "CIPC"
        - "CONC"
        - "CGWV"
      example: "BONU"
    OBProxy1:
      description: "Specifies an alternate assumed name for the identification of the account."
      type: "object"
      required:
        - "Identification"
        - "Code"
      properties:
        Code:
          $ref: "#/components/schemas/ExternalProxyAccountType1Code"
        Identification:
          description: "Identification used to indicate the account identification under another specified name."
          type: "string"
          maxLength: 2048
        Type:
          description: "Type of the proxy identification."
          type: "string"
          maxLength: 35
    ExternalProxyAccountType1Code:
      description: >
        Specifies the external proxy account type code, as published in the proxy account type external code set.
        <dl>
          <dt>TELE</dt><dd>TelephoneNumber - A telephone number in the format specified by the 'The international public telecommunication numbering plan ITU-T E.164.</dd>
          <dt>EMAL</dt><dd>EmailAddress - Internationalised address of an electronic mail box for internet messages.</dd>
          <dt>DNAM</dt><dd>DomainName - Internationalised internet domain name.</dd>
          <dt>CINC</dt><dd>CertificateOfIncorporationNumber - Corporate Identification issued by a national institution or regulator, used as account proxy. (applied for corporate account proxy).</dd>
          <dt>COTX</dt><dd>CorporateTaxIdentification - Unique government-issued tax Identification used as account proxy to identify the corporate (for example for government tax) and typically linked to the corporate bank account (applied for corporate account proxy).</dd>
          <dt>COID</dt><dd>CountryAuthorityIdentification - Identification issued by a national institution or regulator (different from a national scheme like a clearing provider), used as account proxy (applied for corporate or individual account proxy).</dd>
          <dt>CUST</dt><dd>CustomerIdentificationNumber - Any other customer identification number issued by a corporate, bank or other organization, used as account proxy. (applied for corporate or individual account proxy).</dd>
          <dt>DRLC</dt><dd>DriverLicenseNumber - Unique government-issued Identification used as account proxy to identify the individual (for example for government charges, road taxes and tolls,vaccination charges) and typically linked to the individual's bank account (applied for individual account proxy).</dd>
          <dt>EIDN</dt><dd>ElectronicIdentification - Government-issued Identification (different from a passport Identification or a national Identification). Used as account proxy to identify the individual (for example for public benefits) and typically linked to the individual's bank account (applied for individual account proxy).</dd>
          <dt>EWAL</dt><dd>EWalletIdentification - Market-adopted prepaid instruments like e-Wallets, payments to / from e-wallets from / to bank accounts (applied for corporate or individual account proxy).</dd>
          <dt>PVTX</dt><dd>IndividualTaxIdentification - Unique government-issued tax Identification used as account proxy to identify the individual for example for government tax) and typically linked to the individual's bank account (applied for individual account proxy).</dd>
          <dt>LEIC</dt><dd>LegalEntityIdentifierCode - Legal Entity Identifier used as account proxy (applied for corporate account proxy). Use cases: Can be used by corporates as a "government-issued" Identification for registration with payment schemes as a proxy. The proxy may be further used for payments and collections using the underlying instant payment rails for a variety of corporate use cases.</dd>
          <dt>MBNO</dt><dd>MobilePhoneNumber - Mobile phone number in the format specified by the “The international public telecommunication numbering plan ITU- T E 164" (applied for corporate or individual account proxy).</dd>
          <dt>NIDN</dt><dd>NationalIdentificationNumber - Unique government-issued Identification used as account proxy to identify the individual or corporate for example for public benefits, government subsidies) and typically linked to the individual's / corporate bank account. (applied for corporate or individual account proxy).</dd>
          <dt>CCPT</dt><dd>PassportNumber - Unique government-issued Identification used as account proxy to identify the individual (for example for government charges, road taxes, vaccination charges) and typically linked to the individual's bank account (applied for individual account proxy).</dd>
          <dt>SHID</dt><dd>SchemeIdentificationNumber - Account proxy issued by a payment scheme (applied for corporate or individual account proxy). Use cases: Any proxies issued by clearing systems, for example VPA (India), FPS Identifier (Hong Kong), Jompay (Malaysia) CCIN (Canada).</dd>
          <dt>SOSE</dt><dd>SocialSecurityNumber - Unique government-issued Identification used as account proxy to identify the individual (for example for public benefits) and typically linked to the individual's bank account (applied for individual account proxy).</dd>
          <dt>TOKN</dt><dd>TokenIdentification - Electronic Identification used, for example, to mask an account number as a means of data secrecy. (applied for corporate or individual account proxy).</dd>
          <dt>UBIL</dt><dd>UtilitiesSubscriptionIdentification - Subscriber Identification for utilities and services. As opposed to a biller Identification, this identification is used for the subscriber of the service (applied for corporate or individual account proxy).</dd>
          <dt>VIPN</dt><dd>VehicleIdentificationPlateNumber - Account proxy for receiving insurance claims, pay insurance premium, road tax payments, traffic tickets etc.(applied for corporate or individual account proxy).</dd>
          <dt>BIID</dt><dd>BillerSubscriberIdentification - Billers of specific utilities could register for a Biller Identification as supported in the clearing scheme, and use this identification for collections (applied for corporate account proxy).</dd>
        </dl>
      type: "string"
      enum:
        - "TELE"
        - "EMAL"
        - "DNAM"
        - "CINC"
        - "COTX"
        - "COID"
        - "CUST"
        - "DRLC"
        - "EIDN"
        - "EWAL"
        - "PVTX"
        - "LEIC"
        - "MBNO"
        - "NIDN"
        - "CCPT"
        - "SHID"
        - "SOSE"
        - "TOKN"
        - "UBIL"
        - "VIPN"
        - "BIID"
      example: "TELE"
    OBExtendedProprietaryBankTransactionCode:
      description: "Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction."
      type: "object"
      required:
        - "Code"
      properties:
        Code:
          description: "Proprietary bank transaction code to identify the underlying transaction."
          type: "string"
          maxLength: 35
        Issuer:
          description: "Identification of the issuer of the proprietary bank transaction code."
          type: "string"
          maxLength: 35
        Description:
          description: "Description of the code and its usage on the ASPSP channel"
          type: "string"
          maxLength: 500
    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"
          maxLength: 140
        Identification:
          description: "Identification assigned by an institution."
          type: "string"
          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"
          maxLength: 140
        Identification:
          description: "Identification assigned by an institution."
          type: "string"
          maxLength: 256
        LEI:
          $ref: "#/components/schemas/LEI"
        SchemeName:
          $ref: "#/components/schemas/OBInternalAccountIdentification4Code"
        PostalAddress:
          $ref: "#/components/schemas/OBPostalAddress7"
    OBInternalAccountIdentification4Code:
      description: >
        Name of the identification scheme, in a coded form as published in an external list.
        <dl>
          <dt>UK.OBIE.BBAN</dl><dd>Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.</dd>
          <dt>UK.OBIE.IBAN</dl><dd>An identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616. "Banking and related financial services - International Bank Account Number (IBAN)".</dd>
          <dt>UK.OBIE.PAN</dl><dd>Primary Account Number - identifier scheme used to identify a card account.
          <dt>UK.OBIE.Paym</dl><dd>Paym Scheme to make payments via mobile</dd>
          <dt>UK.OBIE.SortCodeAccountNumber</dl><dd>Sort Code and Account Number - identifier scheme used in the UK by financial institutions to identify the account of a customer. The identifier is the concatenation of the 6 digit UK sort code and 8 digit account number. The regular expression for this identifier is: ^[0-9]{6}[0-9]{8}$</dd>
          <dt>UK.OBIE.Wallet</dl><dd>A primary and unique account identifier used to identify a wallet. An ASPSP must document on their developer portal, the payment methods that supports this account identifier.</dd>
        </dl>
      type: "string"
      enum:
        - "UK.OBIE.BBAN"
        - "UK.OBIE.IBAN"
        - "UK.OBIE.PAN"
        - "UK.OBIE.Paym"
        - "UK.OBIE.Wallet"
        - "UK.OBIE.SortCodeAccountNumber"
      example: "UK.OBIE.BBAN"
    OBStatusReason:
      type: "object"
      properties:
        StatusReasonCode:
          $ref: "#/components/schemas/OBExternalStatusReason1Code"
        StatusReasonDescription:
          description: "Description supporting the StatusReasonCode."
          type: "string"
          maxLength: 500
        Path:
          description: "Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path."
          type: "string"
          maxLength: 500
    OBExternalStatusReason1Code:
      description: >
        Specifies the status reason in a code form.
        <dl>
          <dt>U001</dt><dd>Field is expected</dd>
          <dt>U002</dt><dd>Field is invalid</dd>
          <dt>U003</dt><dd>Field has a invalid date</dd>
          <dt>U004</dt><dd>A required field is missing</dd>
          <dt>U005</dt><dd>A value is provided when not required</dd>
          <dt>U006</dt><dd>Header is invalid</dd>
          <dt>U007</dt><dd>Header is missing</dd>
          <dt>U008</dt><dd>Mismatch between staged consent and payment order request</dd>
          <dt>U009</dt><dd>Unexpected consent status</dd>
          <dt>U010</dt><dd>Invalid schema</dd>
          <dt>U011</dt><dd>Resource cannot be found</dd>
          <dt>U012</dt><dd>Payment received after cutoff date and time</dd>
          <dt>U013</dt><dd>Reference found is duplicate</dd>
          <dt>U014</dt><dd>Payment outside control parameters</dd>
          <dt>U015</dt><dd>Invalid signature</dd>
          <dt>U016</dt><dd>Invalid claim in a signature</dd>
          <dt>U017</dt><dd>Invalid or missing claim in a signature</dd>
          <dt>U018</dt><dd>Signature is malformed</dd>
          <dt>U019</dt><dd>Missing information related to signature</dd>
          <dt>U020</dt><dd>Signature was not expected in header but was provided</dd>
          <dt>U021</dt><dd>Unsupported account identified has been provided</dd>
          <dt>U022</dt><dd>Unsupported secondary account identified has been provided</dd>
          <dt>U023</dt><dd>Unsupported currency is provided. Also use U002 or provide path.</dd>
          <dt>U024</dt><dd>Unsupported event type</dd>
          <dt>U025</dt><dd>Unsupported frequency</dd>
          <dt>U026</dt><dd>Unsupported localInstrument</dd>
          <dt>U027</dt><dd>Unsupported scheme</dd>
          <dt>U028</dt><dd>Reauthentication is required by PSU</dd>
          <dt>U029</dt><dd>Duplicate resource submitted</dd>
          <dt>U000</dt><dd>Can use this in conjunction with NARR code to specific the specific unexpected error
        </dl>
      type: "string"
      enum:
        - "U001"
        - "U002"
        - "U003"
        - "U004"
        - "U005"
        - "U006"
        - "U007"
        - "U008"
        - "U009"
        - "U010"
        - "U011"
        - "U012"
        - "U013"
        - "U014"
        - "U015"
        - "U016"
        - "U017"
        - "U018"
        - "U019"
        - "U020"
        - "U021"
        - "U022"
        - "U023"
        - "U024"
        - "U025"
        - "U026"
        - "U027"
        - "U028"
        - "U029"
        - "U000"
        - "AM06"
        - "AM07"
        - "AM09"
        - "AM10"
        - "AM11"
        - "AM12"
        - "AM13"
        - "AM14"
        - "AM15"
        - "AM16"
        - "AM17"
        - "AM18"
        - "AM19"
        - "AM20"
        - "AM21"
        - "AM22"
        - "AM23"
        - "BE01"
        - "BE04"
        - "BE05"
        - "BE06"
        - "BE07"
        - "BE08"
        - "BE09"
        - "BE10"
        - "BE11"
        - "BE12"
        - "BE13"
        - "BE14"
        - "BE15"
        - "BE16"
        - "BE17"
        - "BE18"
        - "BE19"
        - "BE20"
        - "BE21"
        - "BE22"
        - "BE23"
        - "CERI"
        - "CH03"
        - "CH04"
        - "CH07"
        - "CH09"
        - "CH10"
        - "CH11"
        - "CH12"
        - "CH13"
        - "CH14"
        - "CH15"
        - "CH16"
        - "CH17"
        - "CH19"
        - "CH20"
        - "CH21"
        - "CH22"
        - "CHQC"
        - "CNOR"
        - "CURR"
        - "CUST"
        - "DNOR"
        - "DS01"
        - "DS02"
        - "DS03"
        - "DS04"
        - "DS05"
        - "DS06"
        - "DS07"
        - "DS08"
        - "DS09"
        - "DS0A"
        - "DS0B"
        - "DS0C"
        - "DS0D"
        - "DS0E"
        - "DS0F"
        - "DS0G"
        - "DS0H"
        - "DS0K"
        - "DS10"
        - "DS11"
        - "DS12"
        - "DS13"
        - "DS14"
        - "DS15"
        - "DS16"
        - "DS17"
        - "DS18"
        - "DS19"
        - "DS20"
        - "DS21"
        - "DS22"
        - "DS23"
        - "DS24"
        - "DS25"
        - "DS26"
        - "DS27"
        - "DT01"
        - "DT02"
        - "DT03"
        - "DT04"
        - "DT05"
        - "DT06"
        - "DU01"
        - "DU02"
        - "DU03"
        - "DU04"
        - "DU05"
        - "DUPL"
        - "ED01"
        - "ED03"
        - "ED05"
        - "ED06"
        - "ERIN"
        - "FF01"
        - "FF02"
        - "FF03"
        - "FF04"
        - "FF05"
        - "FF06"
        - "FF07"
        - "FF08"
        - "FF09"
        - "FF10"
        - "FF11"
        - "G000"
        - "G001"
        - "G002"
        - "G003"
        - "G004"
        - "G005"
        - "G006"
        - "ID01"
        - "MD01"
        - "MD02"
        - "MD05"
        - "MD06"
        - "MD07"
        - "MS02"
        - "MS03"
        - "NARR"
        - "NERI"
        - "RC01"
        - "RC02"
        - "RC03"
        - "RC04"
        - "RC05"
        - "RC06"
        - "RC07"
        - "RC08"
        - "RC09"
        - "RC10"
        - "RC11"
        - "RC12"
        - "RCON"
        - "RECI"
        - "RF01"
        - "RR01"
        - "RR02"
        - "RR03"
        - "RR04"
        - "RR05"
        - "RR06"
        - "RR07"
        - "RR08"
        - "RR09"
        - "RR10"
        - "RR11"
        - "RR12"
        - "S000"
        - "S001"
        - "S002"
        - "S003"
        - "S004"
        - "SL01"
        - "SL02"
        - "SL03"
        - "SL11"
        - "SL12"
        - "SL13"
        - "SL14"
        - "TA01"
        - "TD01"
        - "TD02"
        - "TD03"
        - "TK01"
        - "TK02"
        - "TK03"
        - "TK09"
        - "TKCM"
        - "TKSG"
        - "TKSP"
        - "TKVE"
        - "TKXP"
        - "TM01"
        - "TS01"
        - "TS04"
        - "CN01"
        - "FOCR"
        - "FR01"
        - "NOCM"
        - "NOAS"
        - "RUTA"
        - "UPAY"
        - "ALAC"
        - "AEXR"
        - "ARFR"
        - "ARJR"
        - "ATNS"
        - "EDTR"
        - "EDTL"
        - "FRAD"
        - "IEDT"
        - "IRNR"
        - "NOAR"
        - "NOPG"
        - "NRCH"
        - "RTNS"
        - "REPR"
        - "SPII"
        - "PINS"
        - "UCRD"
        - "FF12"
        - "FF13"
        - "DC02"
        - "APAR"
      example: "U000"
    OBInternalConsentStatus1Code:
      description: >
        Specifies the status of consent resource in code form.
        <dl>
          <dt>AUTH</dt><dd>Authorised - The consent resource has been successfully authorised.</dd>
          <dt>AWAU</dt><dd>Awaiting Authorisation - The consent resource is awaiting PSU authorisation.</dd>
          <dt>RJCT</dt><dd>Rejected - The consent resource has been rejected.</dd>
          <dt>CANC</dt><dd>Consumed - The access has been cancelled at the ASPSP by either the PSU or the ASPSP.</dd>
        </dl>
      type: "string"
      enum:
        - "AWAU"
        - "AUTH"
        - "RJCT"
        - "CANC"
      example: "AWAU"