openapi: 3.2.0
info:
  description: Public API of Diebold Nixdorf for Banking Core Systems integration
  version: 4.3.0
  title: DN Open Backend Account Information API
  contact:
    name: Thorsten Brinkmann
    email: Thorsten.Brinkmann@dieboldnixdorf.com
  termsOfService: /terms-of-use
servers:
- url: https://localhost:8080/OB-API-REST/v2
security:
- basic: []
- bearer: []
tags:
- name: Account Information API
  description: Fetches account information.
paths:
  /accountList:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Get the account list of a consumer
      tags:
      - Account Information API
      operationId: accountList
      description: Retrieves a list of all accounts of a consumer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountListRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountListResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /accountInquiry:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns detail information of an account
      tags:
      - Account Information API
      operationId: accountInquiry
      description: Returns detail information of an account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountInquiryRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountInquiryResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getAccountMovement:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns the list of all the transactions processed in an account
      tags:
      - Account Information API
      operationId: getAccountMovement
      description: Returns the list of all the transactions processed in an account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getAccountMovementRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAccountMovementResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getAccountStopHold:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns list of holds and stop payments on an account
      tags:
      - Account Information API
      operationId: getAccountStopHold
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getAccountStopHoldRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAccountStopHoldResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getAccountWarnings:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns list of Account Warnings on an account
      tags:
      - Account Information API
      operationId: getAccountWarnings
      description: Returns list of Account Warnings on an account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getAccountWarningsRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAccountWarningsResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getAccountListWarnings:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns list of Account Warnings on every account
      tags:
      - Account Information API
      operationId: getAccountListWarnings
      description: Returns list of Account Warnings on every account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getAccountListWarningsRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAccountListWarningsResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getBusinessDate:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns the Business Date
      tags:
      - Account Information API
      operationId: getBusinessDate
      description: Returns the Business Date.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getBusinessDateRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getBusinessDateResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getCardList:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns list of Cards of an account
      tags:
      - Account Information API
      operationId: getCardList
      description: Returns list of Cards of an account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getCardListRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCardListResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getCheckIssuerDetails:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns details of a check
      tags:
      - Account Information API
      operationId: getCheckIssuerDetails
      description: Returns details of a check.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getCheckIssuerDetailsRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCheckIssuerDetailsResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /getScheduledTransactions:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Returns the list of all the transactions that are yet to be in an account
      tags:
      - Account Information API
      operationId: getScheduledTransactions
      description: Returns the list of all the transactions that are yet to be in an account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/getScheduledTransactionsRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScheduledTransactionsResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /accountHold:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Creates a hold on an account
      tags:
      - Account Information API
      operationId: accountHold
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountHoldRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountHoldResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /cancelAccountHold:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Cancels the hold on an account
      tags:
      - Account Information API
      operationId: cancelAccountHold
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cancelAccountHoldRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transactionConfirmationResponseUpdatedBalance'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /updateAccountNickName:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: update the account nickname
      tags:
      - Account Information API
      operationId: updateAccountNickName
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAccountNickNameRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transactionConfirmationResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
components:
  schemas:
    getAccountListWarningsResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accountWarnings
            properties:
              accountInformationList:
                type: array
                items:
                  $ref: '#/components/schemas/AccountListWarning'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    Credit:
      type: object
      description: Credit amounts to be represnted in amounts as CREDIT_LIMIT, AVAILABLE_CREDIT, LAST_CHARGE_DUE, INTEREST_PAID_YEAR_TO_DATE, INTEREST_PAID_PREVIOUS_YEAR_TO_DATE, INTEREST_AMOUNT, MINIMUM_AMOUNT_DUE, REWARD_BALANCE, LAST_STATEMENT_BALANCE
      properties:
        interestRate:
          type: number
          format: double
          description: Interest rate for this account
          example: 2.34
    StopHoldType:
      type: string
      enum:
      - HOLD
      - STOP_PAYMENT
      example: HOLD
      description: Specifies if this is a hold or a stop payment
    ClientTransactionTime:
      type: string
      description: 'In Local Timezone <br> For ''selfService'' channel, the local time the transaction takes place. <br><br>

        For ''network'' channel, data element DE12 - the local time the transaction takes place at the card acceptor location.'
      example: '164052'
    transactionConfirmationResponseUpdatedBalance:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              accountDetails:
                $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    getAccountListWarningsRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accounts
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            accounts:
              type: array
              items:
                $ref: '#/components/schemas/AccountRef'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    TransactionResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/TransactionWithStandin'
      description: Exact replica of the request 'transaction' object which must be returned by the host
    getCardListResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - cards
            properties:
              cards:
                type: array
                items:
                  $ref: '#/components/schemas/Cards'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    Address:
      type: object
      properties:
        street:
          type: string
          description: The name of the street.
          example: Mainstreet
        streetno:
          type: string
          description: The street number of this address.
          example: '119'
        city:
          type: string
          description: The name of the city.
          example: New York City
        zipcode:
          type: string
          description: The zip code of this city.
          example: N5467
        countrycode:
          type: string
          description: Country code
          example: USA
    AccountHoldResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - confirmationNumber
            properties:
              confirmationNumber:
                allOf:
                - $ref: '#/components/schemas/ConfirmationNumber'
                description: The unique identifier for the hold created
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              accountDetails:
                $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    getCardListRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    getAccountStopHoldRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          properties:
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CardHandlingIndicator:
      type: string
      enum:
      - OUT
      - RETAIN
      - CHAINING_ALLOWED
      - RETAIN_ON_SUCCESS
      description: Card Handling Indicator
      example: OUT
    AdditionalProperties:
      type: object
      additionalProperties:
        type: string
      description: Additional properties can be provided within this object
    Date:
      type: string
      format: yyyy-MM-dd
      description: The date pattern is defined 'yyyy-MM-dd', with yyyy as 4-digit year, MM as 2-digit month and dd as 2-digit date of month
      example: '2020-07-23'
    accountListResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accounts
            properties:
              accounts:
                type: array
                items:
                  $ref: '#/components/schemas/AccountInfo'
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    getAccountMovementResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accountMovements
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              accountMovements:
                type: array
                items:
                  $ref: '#/components/schemas/AccountMovements'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    SupplementaryData:
      type: object
      description: 'Additional information incorporated as an extension to the message by mixins based on the transaction type          '
    Loan:
      type: object
      description: Loan balance to be represented in amounts as LOAN_BALANCE, INTEREST_AMOUNT, REGULAR_PAYMENT_AMOUNT, REGULAR_PAYMENT_DUE, PRINCIPLE_BALANCE, MINIMUM_AMOUNT_DUE, LAST_PAYMENT_AMOUNT, LAST_CHARGE_DUE, INTEREST_PAID_YEAR_TO_DATE, INTEREST_PAID_PREVIOUS_YEAR_TO_DATE
      properties:
        loanType:
          $ref: '#/components/schemas/LoanType'
        loanMaturityDate:
          $ref: '#/components/schemas/Date'
    DateTime:
      type: string
      description: The date and time expressed in the pattern 'yyyy-MM-dd'T'HH:mm:ssZ', where yyyy is 4-digit year, MM is 2-digit month, dd is 2-digit date of month, HH is hours, mm is minutes and ss is seconds
      format: yyyy-MM-dd'T'HH:mm:ssZ
      example: 2020-07-23T12:00:00+0000
    ServiceResponse:
      type: object
      required:
      - responseCode
      properties:
        responseCode:
          $ref: '#/components/schemas/ResponseCode'
        extendedResponse:
          $ref: '#/components/schemas/ExtendedResponse'
    AccountPermissions:
      type: object
      properties:
        accessPermission:
          $ref: '#/components/schemas/AccessPermission'
        markedForDepositOnly:
          type: boolean
          example: false
          description: Flag to identify if the account is for Deposit only
    ExtendedResponseCode:
      type: string
      enum:
      - OK
      - SERVER_FAILURE
      - NO_RESULT
      - ACCOUNT_NOT_FOUND
      - ACCOUNT_CLOSED
      - ACCOUNT_TYPE_INVALID
      - LIMIT_EXCEEDED
      - INSUFFICIENT_FUNDS
      - REQUEST_DATA_INVALID
      - TRX_NOT_PERMITTED_TO_ACCOUNT
      - TRANSACTION_NOT_POSSIBLE
      - HOST_OFFLINE
      - HOST_CANCEL
      - HOST_BUSINESS_ERROR
      - RESPONSE_FEE_CONFIRM_REQUIRED
      - OVERDRAFT_CONFIRM_REQUIRED
      - PIN_VALIDATION_FAILED
      - FCC_CONFIRM_REQUIRED
      - DIRECT_CURRENCY_CONVERSION_CONFIRM_REQUIRED
      - MULTI_CONFIRM_REQUIRED
      - CARD_NOT_FOUND
      - CARD_NOT_FOUND_FOR_EXPIRY_DATE
      - CARD_BLOCKED
      - CARD_EXPIRED
      - CARD_MANIPULATED
      - PIN_INACTIVE
      - PIN_TRY_LIMIT_EXCEEDED
      - PINS_DIFFER
      - OFFLINE_OKAY
      - SERVER_NOT_READY
      example: OK
      description: Extended Response Code Mapping
    getBusinessDateResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - businessDate
            properties:
              businessDate:
                $ref: '#/components/schemas/Date'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountHold:
      type: object
      required:
      - id
      - effectiveDate
      - expiryDate
      - type
      - code
      - amount
      properties:
        id:
          type: string
          description: The unique identifier for the hold
          minLength: 1
          example: 123
        expiryDate:
          $ref: '#/components/schemas/Date'
        effectiveDate:
          $ref: '#/components/schemas/Date'
        type:
          $ref: '#/components/schemas/StopHoldType'
        code:
          type: string
          description: The code for this hold
          example: '1'
        amount:
          $ref: '#/components/schemas/Amount'
        description:
          type: string
          description: The description for the hold
          example: Hold for this account
    getAccountWarningsResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accountWarnings
            - isBankEmployee
            properties:
              accountWarnings:
                type: array
                items:
                  $ref: '#/components/schemas/Warning'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountSubType:
      description: Represents the SubType of an account for AccountType
      type: string
      example: Savings account
    ResponseCode:
      type: string
      enum:
      - OK
      - FAIL
      - RESUBMIT
      example: OK
    getAccountStopHoldResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accountHoldList
            properties:
              accountHoldList:
                type: array
                items:
                  $ref: '#/components/schemas/AccountHold'
              accountStopPaymentList:
                type: array
                items:
                  $ref: '#/components/schemas/AccountStop'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    getCheckIssuerDetailsResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - checkIssuerDetails
            properties:
              checkIssuerDetails:
                $ref: '#/components/schemas/CheckIssuerDetails'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    CheckIssuerDetails:
      type: object
      properties:
        id:
          type: string
          description: Unqiue identifier for the check
          example: edc856895cee42b5a859acec7f332ca3
        transactionNumber:
          type: string
          description: Transaction number
          example: '12489891247987'
        score:
          type: integer
          description: Check score
        state:
          type: string
          description: Check state
          example: OPEN
        suspectedFraud:
          type: boolean
          description: True if check is suspected as fraud.
        checkNumber:
          type: string
          example: '214214'
        micr:
          type: string
          example: 09879078
        checkType:
          $ref: '#/components/schemas/CheckType'
        bankRoutingId:
          type: string
          description: Contains the BIC (bank identifier code)
          example: '335668810'
        accountNumber:
          type: string
          description: Account Number
          example: 913131234"
        accountType:
          $ref: '#/components/schemas/AccountType'
        rejectedBy:
          type: string
          description: check rejected by.
          example: UNDEFINED
        rejectedReason:
          type: integer
          description: reason for check rejection.
    Cards:
      type: array
      items:
        $ref: '#/components/schemas/Card'
    getBusinessDateRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AccountStop:
      type: object
      required:
      - id
      - effectiveDate
      - expiryDate
      - type
      - code
      - checkNumberStart
      - checkNumberEnd
      properties:
        id:
          type: string
          description: The unique identifier for the stop payment
          minLength: 1
          example: 123
        expiryDate:
          $ref: '#/components/schemas/Date'
        effectiveDate:
          $ref: '#/components/schemas/Date'
        type:
          $ref: '#/components/schemas/StopHoldType'
        code:
          type: string
          description: The code for this stop payment
          example: STOL
        description:
          type: string
          description: The description for the stop payment
          example: Stop for this account
        checkNumberStart:
          type: string
          description: The beginning check number for stop payment
          example: '123'
        checkNumberEnd:
          type: string
          description: The ending check number for stop payment
          example: '789'
    IsStandin:
      type: boolean
      description: Standin request indicator
      example: false
    AccountScopeInformation:
      type: string
      description: The scope from where the the account list has to be returned in response
      enum:
      - INTERNAL
      - EXTERNAL
      example: INTERNAL
    NetworkId:
      type: string
      description: Id of the acquiring network (scheme specific)
      example: MAC
    getScheduledTransactionsRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    PointOfInteraction:
      properties:
        clientId:
          type: string
          description: Client Id
          example: '123'
        clientType:
          $ref: '#/components/schemas/ClientType'
        institutionId:
          type: string
          description: The id of the institute
          example: '1234'
        tellerId:
          type: string
          description: The id of the teller
          example: ''
        branchCode:
          type: string
          description: Branch code
          example: ''
        clientTransactionDate:
          $ref: '#/components/schemas/ClientTransactionDate'
        clientTransactionTime:
          $ref: '#/components/schemas/ClientTransactionTime'
        channel:
          $ref: '#/components/schemas/Channel'
        address:
          $ref: '#/components/schemas/AddressPOI'
        networkId:
          $ref: '#/components/schemas/NetworkId'
        merchantCategory:
          $ref: '#/components/schemas/MerchantCategory'
    AccountAmountType:
      type: string
      enum:
      - LEDGER_BALANCE
      - AVAILABLE_BALANCE
      - AVAILABLE_CREDIT
      - CREDIT_LIMIT
      - OVERDRAFT_LIMIT
      - LOAN_BALANCE
      - INTEREST_AMOUNT
      - REGULAR_PAYMENT_AMOUNT
      - REGULAR_PAYMENT_DUE
      - PRINCIPLE_BALANCE
      - CURRENT_AMOUNT_DUE
      - LAST_PAYMENT_AMOUNT
      - LAST_CHARGE_DUE
      - INTEREST_PAID_YEAR_TO_DATE
      - INTEREST_PAID_PREVIOUS_YEAR_TO_DATE
      - OFF_HOST_DEBIT_AMOUNT
      - OFF_HOST_CREDIT_AMOUNT
      - TOTAL_DEBIT_AMOUNT
      - TOTAL_CREDIT_AMOUNT
      - PAYOFF_AMOUNT
      - OWING_AMOUNT
      - AMOUNT_ALREADY_DRAWN_ON
      - MEMBER_PROVIDED_FEE_AMOUNT
      - REMAINING_PREAUTHORIZED_AMOUNT
      - HEALTHCARE_ELIGIBILITY_AMOUNT
      - PRESCRIPTION_ELIGIBILITY_AMOUNT
      - PREPAID_ONLINE_BILL_PAY_FEE_AMOUNT
      - CASH_BACK
      - ORIGINAL_AMOUNT
      - POI_AMOUNT
      - CO_PAY_AMOUNT
      - MINIMUM_AMOUNT_DUE
      - REWARD_BALANCE
      - LAST_STATEMENT_BALANCE
      example: AVAILABLE_BALANCE
      description: Amount types for account
    ClientType:
      type: string
      description: The type of the hardware terminal device
      enum:
      - ADMINISTRATIVE_TERMINAL
      - POS_TERMINAL
      - ATM
      - HOME_TERMINAL
      - ECR
      - DIAL_TERMINAL
      - TRAVELERS_CHECK_MACHINE
      - FUEL_MACHINE
      - SCRIP_MACHINE
      - COUPON_MACHINE
      - TICKET_MACHINE
      - POINT_OF_BANKING_TERMINAL
      - TELLER
      - FRANCHISE_TELLER
      - PERSONAL_BANKING
      - PUBLIC_UTILITY
      - VENDING
      - SELF_SERVICE
      - AUTHORIZATION
      - PAYMENT
      - VRU
      - SMART_PHONE
      - INTERACTIVE_TELEVISION
      - PERSONAL_DIGITAL_ASSISTANT
      - SCREEN_PHONE
      - INTERNET_TERMINAL
      - MICR_TERMINAL
      - MOBILE_ACCEPTANCE_SOLUTION
      - UNKNOWN
      - NOT_CARDHOLDER_ACTIVATED
      - LEVEL_1_CAT_ATM_WITH_PIN
      - LEVEL_2_CAT_SELF_SERVICE_TERMINAL
      - LEVEL_3_CAT_LIMITED_AMOUNT_TERMINAL
      - LEVEL_4_CAT_IN_FLIGHT_COMMERCE
      - LEVEL_6_CAT_ECOMMERCE
      - LEVEL_7_CAT_TRANSPONDER_TRANSACTION
      - LEVEL_8_CAT_MOBILE_INITIATED
      - LEVEL_9_CAT_MPOS_ACCEPTANCE_DEVICE
      example: ATM
    accountHoldRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - amount
          - expiryDate
          - accountRef
          properties:
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            amount:
              $ref: '#/components/schemas/Amount'
            fee:
              $ref: '#/components/schemas/TransactionFeeAmountOnly'
            expiryDate:
              $ref: '#/components/schemas/Date'
            expiryDateTime:
              $ref: '#/components/schemas/DateTime'
            effectiveDate:
              $ref: '#/components/schemas/Date'
            holdType:
              $ref: '#/components/schemas/HoldType'
            remark:
              type: string
              description: Transaction comments
              example: Hold for this account
            payeeName:
              type: string
              description: The name of the payee when the holdType is CHECK_HOLD
              example: Betty
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AccountStatus:
      type: string
      description: The status of the account
      enum:
      - ACTIVE
      - APPROVED
      - CLOSED
      - DORMANT
      - PENDING_CLOSED
      - CHARGEOFF
      - INACTIVE
      - NON_ACCRUAL
      - MATURED
      - ESCHEAT
      - ASSUMED
      - LOAN_DENIED
      - ORIGINATING
      - REDEEMED
      - MATURED_NOT_REDEEMED
      - NO_DEBIT
      - NO_CREDIT
      - NO_POST
      - FROZEN_NON_ACCRUAL
      - CHARGEDOFF_NON_ACCRUAL
      - OCCUPIED
      - NOT_AVAILABLE
      - UNOCCUPIED
      - ACTIVE_NO_POD
      - DO_NOT_CLOSE_ON_ZERO_BALANCE
      - FROZEN_ACCRUAL
      - OPEN_PRIMARY_ACCOUNT
      - RESTRICTED_PRIMARY_ACCOUNT
      - RESTRICTED_TO_DEPOSIT
      - NOT_SPECIFIED
      example: ACTIVE
    ExtendedResponseMessage:
      type: string
      description: Extended Response Message
      example: OK
    LoanType:
      type: string
      enum:
      - LOAN
      - CONSUMER_LOAN
      - COMMERCIAL_LOAN
      - MORTGAGE_LOAN
      - EXTERNAL_LOAN
      - LOAN_DENIAL
      example: MORTGAGE_LOAN
      description: All the possible account types for LOAN Accounts
    getAccountMovementRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            startDate:
              $ref: '#/components/schemas/Date'
            endDate:
              $ref: '#/components/schemas/Date'
            maxRecords:
              $ref: '#/components/schemas/MaxRecords'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    BestMatchedElement:
      type: string
      example: TRACK_2
      description: Best matched element for Consumer Identification
      enum:
      - TRACK_2
      - NFC
      - EMV
      - CUSTOM
    TransactionFeeAmountOnly:
      type: object
      required:
      - amount
      properties:
        amount:
          type: object
          description: "The fee amount for this transaction. Always an unsigned value. \n\nThe value in this field is just for information purpose. It is already included in calculations for the 'amount' field.\n"
          required:
          - value
          - currency
          properties:
            value:
              description: The amount value of the given currency.
              type: string
              pattern: '[0-9]{1,13}\.[0-9]{1,3}'
              minimum: 0
              example: '2.00'
            currency:
              description: Currency code
              type: string
              minLength: 3
              pattern: '[A-Z]{3,3}'
              example: USD
    ConfirmationNumber:
      type: string
      description: The unique identifier for the transaction
      example: '998087999'
    PointOfInteractionSettlementDate:
      type: string
      description: 'In Local Timezone <br> For ''selfService'' channel, ATM booking date for the transaction. <br><br>

        For ''network'' channel, data element DE15 - the  month and day funds are transferred between the acquirer and issuer.'
      format: MMDD
      example: 0921
    Channel:
      type: string
      enum:
      - selfService
      - network
      - teller
      - mobile
      - undefined
      description: Channel through which transaction is initiated.
    CardPan:
      type: object
      required:
      - pan
      properties:
        bestMatchedElement:
          $ref: '#/components/schemas/BestMatchedElement'
        pan:
          type: string
          minLength: 1
          description: Primary Account Number (PAN) of the card
          example: '4490739000000895'
        track2:
          type: string
          example: 4490739000000895D161222366
          description: ISO track 2 issued from the magnetic stripe card or from the ICC
        emvData:
          type: array
          items:
            $ref: '#/components/schemas/EMVTagData'
        cardSequenceNumber:
          type: string
          example: '05'
          description: Identify a card or a payment token inside a set of cards with the same PAN
        expiryDate:
          type: string
          description: Expiry date of the card expressed in YYMM format
          example: '2107'
        consumerGroup:
          type: string
          description: Consumer Group Name
          example: CG_ON_US_DEBIT
    AccessPermission:
      type: string
      enum:
      - NO_PERMISSION
      - FULL_PERMISSION
      - DEPOSIT_ONLY_PERMISSION
      - WITHDRAWAL_ONLY_PERMISSION
      example: FULL_PERMISSION
      description: The Access permission of the Account
    AccountName:
      type: string
      description: The account name which is displayed to the user
      example: Your Savings account
    AccountOwnership:
      type: string
      enum:
      - PRIMARY
      - JOINT
      - NOT_SPECIFIED
      - CUSTODIAN
      - TRUSTEE
      - POWER_OF_ATTORNEY
      - AUTHORIZED_SIGNER
      - TRUSTOR
      - CO_BORROWER
      - CO_SIGNER
      - CO_OWNER
      - CO_MAKER
      - CORPORATION
      - BORROWER
      - CORPORATE_OWNER
      - JOINT_PRIMARY
      - JOINT_SECONDARY
      - JOINT_AND
      - JOINT_OR
      - ENDORSER
      - GUARANTOR
      - GRANTOR
      - LANDLORD
      - SECONDARY
      - TENANT
      - SOLE_PROPRIETOR
      - GUARDIAN
      - EXECUTOR
      example: PRIMARY
    getAccountWarningsRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          properties:
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CheckType:
      type: string
      enum:
      - ON_US
      - OFF_US
      - GOVERNMENT
      - NOT_SPECIFIED
      example: ON_US
      description: The Check Type value of the check
    AccountListWarning:
      type: object
      required:
      - accountRef
      - isBankEmployee
      - accountWarnings
      properties:
        accountRef:
          $ref: '#/components/schemas/AccountRef'
        isBankEmployee:
          type: boolean
          description: Is Bank Employee.
        accountWarnings:
          type: array
          items:
            $ref: '#/components/schemas/Warning'
        additionalProperties:
          $ref: '#/components/schemas/AdditionalProperties'
    TransactionWithStandin:
      type: object
      allOf:
      - $ref: '#/components/schemas/TransactionBase'
      - type: object
        properties:
          isStandin:
            $ref: '#/components/schemas/IsStandin'
    getScheduledTransactionsResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accountMovements
            properties:
              accountMovements:
                type: array
                items:
                  $ref: '#/components/schemas/AccountMovements'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    accountInquiryRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          properties:
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            pin:
              $ref: '#/components/schemas/Pin'
            scope:
              $ref: '#/components/schemas/AccountScopeInformation'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    Amounts:
      type: array
      items:
        $ref: '#/components/schemas/AccountAmount'
    AccountMovements:
      type: object
      required:
      - transactionDate
      - amount
      - accountRef
      properties:
        effectiveDate:
          $ref: '#/components/schemas/Date'
        transactionId:
          type: string
          description: Transaction Id
          example: '212423521525'
        type:
          type: string
          description: transaction Type
          example: credit
        transactionDate:
          $ref: '#/components/schemas/Date'
        primanota:
          type: string
          description: Primanota for this account movement
          example: '87536789'
        amount:
          $ref: '#/components/schemas/Amount'
        accountRef:
          $ref: '#/components/schemas/AccountRef'
        remarks:
          type: string
          description: information on the transaction.
          example: Misc Debit with description.
        additionalProperties:
          $ref: '#/components/schemas/AdditionalProperties'
    Conductor:
      type: object
      required:
      - conductorId
      - firstName
      properties:
        conductorId:
          type: string
          example: '4562893742'
        firstName:
          type: string
          example: Betty
        lastName:
          type: string
          example: Adams
        role:
          type: string
          example: PRIMARY
        primaryIdentifier:
          type: integer
          example: 1
        accountPermissions:
          type: array
          items:
            $ref: '#/components/schemas/AccountPermissions'
    MerchantCategory:
      type: string
      description: Identifier representing the merchant's type of business product or service
      example: '6011'
    accountInquiryResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            required:
            - accountDetails
            properties:
              accountDetails:
                $ref: '#/components/schemas/AccountInfo'
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    ConsumerId:
      type: string
      description: A unique identifier of a consumer
      example: '123456'
    TransactionBase:
      type: object
      required:
      - id
      - type
      - operation
      properties:
        id:
          type: string
          minLength: 1
          example: '212423521525'
        transactionTime:
          type: string
          description: Transaction time
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2020-09-01T16:40:52+0000
        poiSettlementDate:
          $ref: '#/components/schemas/PointOfInteractionSettlementDate'
        businessCorrelationId:
          type: string
          description: Unique ID for a transaction business case
          maxLength: 50
          example: 7f2b9fcde28b42abbc10b0b9640f6ede
        type:
          $ref: '#/components/schemas/TransactionTypes'
        operation:
          type: string
          minLength: 1
          description: Operation performed for the given transaction type given by the 'type' property
        retrievalReferenceNumber:
          type: string
          example: '827364775848'
          description: 'A numeric value containing the unique transaction reference number '
        authorizationIdentificationResponse:
          type: string
          example: '000123'
          description: A numeric value containing the authorization code
    getCheckIssuerDetailsRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - check
          properties:
            check:
              $ref: '#/components/schemas/Check'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AccountInformationBase:
      type: object
      required:
      - accountType
      - accountNumber
      - amounts
      properties:
        accountNumber:
          description: Account number
          type: string
          minLength: 5
          example: '19023456789'
        accountCurrency:
          description: Currency code
          type: string
          pattern: '[A-Z]{3,3}'
          example: USD
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountSubType:
          $ref: '#/components/schemas/AccountSubType'
        accountName:
          $ref: '#/components/schemas/AccountName'
        instituteName:
          description: The name or identifier of the institute
          type: string
          example: Deutsche Bank
        effectiveDateTime:
          type: string
          description: The date and time stamp in UTC from which the balances specified in the 'amounts' property are effective
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2024-06-01T00:00:00+0000
        amounts:
          $ref: '#/components/schemas/Amounts'
    Payment:
      type: object
      description: Payment amounts to be represnted in amounts as REGULAR_PAYMENT_AMOUNT, REGULAR_PAYMENT_DUE, PRINCIPAL_BALANCE, PAYOFF_AMOUNT, LAST_PAYMENT_AMOUNT
      properties:
        regularPaymentDueDate:
          $ref: '#/components/schemas/Date'
        regularPaymentFrequency:
          type: string
          description: Regular payment frequency. This can be DAILY| MONTHLY|WEEKLY|YEARLY
          example: MONTHLY
        lastPaymentDate:
          $ref: '#/components/schemas/Date'
        paymentMethod:
          type: string
          description: The payment method of this account.
    AccountRef:
      type: object
      description: "The account on which the transaction is to be performed. \n"
      required:
      - accountNumber
      - accountType
      properties:
        accountNumber:
          description: Account number
          type: string
          minLength: 1
          example: A0123456789
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountName:
          $ref: '#/components/schemas/AccountName'
        accountSubType:
          $ref: '#/components/schemas/AccountSubType'
    AccountAmount:
      type: object
      properties:
        amountType:
          $ref: '#/components/schemas/AccountAmountType'
        value:
          description: The amount value of the given currency
          type: string
          pattern: '[0-9]{1,13}\.[0-9]{1,3}'
          minimum: 0
          example: '100.50'
        currency:
          description: Currency code
          type: string
          pattern: '[A-Z]{3,3}'
          example: USD
    accountListRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            pin:
              $ref: '#/components/schemas/Pin'
            scope:
              $ref: '#/components/schemas/AccountScopeInformation'
            maxRecords:
              $ref: '#/components/schemas/MaxRecords'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    Card:
      type: object
      required:
      - pan
      properties:
        pan:
          type: string
          minLength: 1
          description: Card number of the consumer
          example: '4512665599887762'
        cardState:
          type: string
          description: Defines the state of the card (Active, Blocked etc)
          enum:
          - ACTIVE
          - CLOSED
          - EXPIRED
          - BLOCKED
          - ISSUED
          - HOTCARD
        cardStateReasonCode:
          type: string
          description: Card State Reason Code
          enum:
          - LOST
          - STOLEN
          - EXPIRED
          - DAMAGED
          - SUSPECTED_FRAUD
          - FRAUD
          - CLOSED_BY_CUSTOMER
          - AUTOMATIC_AGREEMENT_COPY
          - DO_NOT_HONOUR
        cardStateReasonDescription:
          type: string
          description: Card State Reason Description
          example: Activate Card
    cancelAccountHoldRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - holdId
          - accountRef
          properties:
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            holdId:
              type: string
              description: The unique identifier used to identify the hold to be cancelled. This is the identifier received in accountHold API response as the confirmationNumber
              example: '998087999'
            cancelEffectiveDate:
              $ref: '#/components/schemas/Date'
            amount:
              $ref: '#/components/schemas/Amount'
            fee:
              $ref: '#/components/schemas/TransactionFeeAmountOnly'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AccountInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountInformationBase'
      - type: object
        properties:
          accountOwnerName:
            type: string
            description: 'The owner of the account. '
            example: JOHN DOE
          accountOwnership:
            $ref: '#/components/schemas/AccountOwnership'
          accountStatus:
            $ref: '#/components/schemas/AccountStatus'
          cardNumber:
            type: string
            description: Card number
            example: 3999821321
          branchCode:
            description: The branch code of the bank
            type: string
            example: 1234
          bankCode:
            description: Contains the BIC (bank identifier code)
            type: string
            example: '11133444'
          nickName:
            type: string
            description: NickName
            example: Nick
          openDate:
            $ref: '#/components/schemas/Date'
          accountMaturityDate:
            $ref: '#/components/schemas/Date'
          conductors:
            type: array
            items:
              $ref: '#/components/schemas/Conductor'
          possibleTransactionsAsSourceAccount:
            type: array
            items:
              $ref: '#/components/schemas/TransactionTypes'
          possibleTransactionsAsTargetAccount:
            type: array
            items:
              $ref: '#/components/schemas/TransactionTypes'
          loan:
            $ref: '#/components/schemas/Loan'
          credit:
            $ref: '#/components/schemas/Credit'
          payment:
            $ref: '#/components/schemas/Payment'
          accountWarnings:
            type: array
            items:
              $ref: '#/components/schemas/Warning'
    MaxRecords:
      type: integer
      description: Maximum number of records to fetch
      example: 50
    ExtendedResponse:
      type: object
      required:
      - code
      properties:
        code:
          $ref: '#/components/schemas/ExtendedResponseCode'
        message:
          $ref: '#/components/schemas/ExtendedResponseMessage'
    Check:
      type: object
      required:
      - checkNumber
      properties:
        checkNumber:
          type: string
          example: '214214'
        micr:
          type: string
          example: 09879078
        checkType:
          $ref: '#/components/schemas/CheckType'
        bankRoutingId:
          type: string
          description: Contains the BIC (bank identifier code)
          example: '335668810'
        accountNumber:
          type: string
          description: Account Number
          example: '1248131234'
    HostResponseData:
      type: object
      description: Host Response details
      properties:
        hostResponseCode:
          type: string
          description: Host response code
          example: '00000'
        hostTransactionTime:
          type: string
          description: Host transaction datetime in milliseconds
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2020-09-01T16:40:52+0000
        hostMessage:
          type: string
          description: Host response message
          example: Success
    ClientTransactionDate:
      type: string
      description: 'In Local Timezone <br> For ''selfService'' channel, the local month and day the transaction takes place. <br><br>

        For ''network'' channel, data element DE13 - the local month and day the transaction takes place at the card acceptor location.'
      format: MMDD
      example: 0921
    updateAccountNickNameRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          - accountName
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            accountName:
              type: string
              minLength: 1
              example: SAVINGS
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    EMVTagData:
      type: object
      properties:
        tag:
          $ref: '#/components/schemas/EMVTags'
        value:
          type: string
          description: Hex Encoded value of EMVTag
          example: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
    AddressPOI:
      type: object
      allOf:
      - $ref: '#/components/schemas/Address'
      - type: object
        properties:
          state:
            type: string
            description: The name of the state.
            example: New York
          longitude:
            type: number
            description: The longitude coordinate of this location.
          latitude:
            type: number
            description: The latitude coordinate of this location
    TransactionTypes:
      type: string
      enum:
      - sbLogin
      - sbLogout
      - sbRelogin
      - sbOpenConsumer
      - sbCardlessLogin
      - sbAccountMovement
      - sbAccountOverview
      - sbCheckCashing
      - sbDeposit
      - sbMixedMediaPayment
      - sbTransfer
      - sbWithdrawal
      - sbPinChange
      - sbPrestagedCashOut
      - sbPrestagedCashIn
      - sbEReceipt
      - sbLoadCustomerPreferences
      - sbSaveCustomerPreferences
      - sbAssistedWithdrawal
      - sbAssistedDeposit
      - sbLimitApproval
      - sbRequestSupport
      - sbCreditorSelection
      - withdrawal
      - balanceInquiry
      - transfer
      - purchase
      - deposit
      - payment
      - refund
      - purchaseCashback
      - cashDisbursement
      - consumerProfile
      - moneyTransferDebit
      - moneyTransferCredit
      - paymentDebit
      - paymentCredit
      - adjustmentDebit
      - adjustmentCredit
      - financialProfile
      - quasiCash
      - requestCurrencyExchangeRates
      description: Type of Transaction or BusinessCase performed
    HoldType:
      type: string
      enum:
      - GENERAL_PURPOSE_HOLD
      - CHECK_HOLD
      - NOT_SPECIFIED
      - DEBIT_HOLD
      - CREDIT_HOLD
      example: GENERAL_PURPOSE_HOLD
      description: Type of Hold on Account
    Pin:
      type: object
      required:
      - encryptedPin
      properties:
        encryptedPin:
          type: string
          description: Hex encoded value of PIN block
          example: B1D2AC6236D99348
        format:
          type: string
          description: Encryption format for provided PIN
          example: VISA_1
        zpkGeneration:
          type: string
          description: Generation of Zone PIN Key used to encrypt the PIN
          example: '2'
    Amount:
      description: "The basic type of an amount. \nAlways an unsigned value. \nThe host must perform operations on this value as per the context of the transaction.\n\ne.g. \nFor a withdrawal transaction, the value must be debited, whereas for a deposit transaction, the value must be credited.\n"
      type: object
      required:
      - value
      - currency
      properties:
        value:
          description: The amount value of the given currency.
          type: string
          pattern: '[0-9]{1,13}\.[0-9]{1,3}'
          minimum: 0
          example: '100.00'
        currency:
          description: Currency code
          type: string
          minLength: 3
          pattern: '[A-Z]{3,3}'
          example: USD
    EMVTags:
      type: string
      example: EMV_57
      enum:
      - ISSUER_SCRIPTS
      - ISSUER_SCRIPTS_RESULT
      - EMV_42
      - EMV_4F
      - EMV_50
      - EMV_57
      - EMV_5A
      - EMV_5F28
      - EMV_5F55
      - EMV_5F56
      - EMV_5F57
      - EMV_61
      - EMV_6F
      - EMV_70
      - EMV_73
      - EMV_77
      - EMV_80
      - EMV_81
      - EMV_82
      - EMV_83
      - EMV_84
      - EMV_86
      - EMV_87
      - EMV_88
      - EMV_89
      - EMV_8A
      - EMV_8B
      - EMV_8C
      - EMV_8D
      - EMV_8E
      - EMV_8F
      - EMV_90
      - EMV_91
      - EMV_92
      - EMV_93
      - EMV_94
      - EMV_95
      - EMV_97
      - EMV_98
      - EMV_99
      - EMV_9A
      - EMV_9B
      - EMV_9C
      - EMV_9D
      - EMV_5F20
      - EMV_5F24
      - EMV_5F25
      - EMV_5F2A
      - EMV_5F2D
      - EMV_5F30
      - EMV_5F34
      - EMV_5F36
      - EMV_5F50
      - EMV_5F53
      - EMV_5F54
      - EMV_9F01
      - EMV_9F02
      - EMV_9F03
      - EMV_9F04
      - EMV_9F05
      - EMV_9F06
      - EMV_9F07
      - EMV_9F08
      - EMV_9F09
      - EMV_9F0B
      - EMV_9F0D
      - EMV_9F0E
      - EMV_9F0F
      - EMV_9F10
      - EMV_9F11
      - EMV_9F12
      - EMV_9F13
      - EMV_9F14
      - EMV_9F15
      - EMV_9F16
      - EMV_9F17
      - EMV_9F18
      - EMV_9F19
      - EMV_9F1A
      - EMV_9F1B
      - EMV_9F1C
      - EMV_9F1D
      - EMV_9F1E
      - EMV_9F1F
      - EMV_9F20
      - EMV_9F21
      - EMV_9F22
      - EMV_9F23
      - EMV_9F24
      - EMV_9F26
      - EMV_9F27
      - EMV_9F2D
      - EMV_9F2E
      - EMV_9F2F
      - EMV_9F32
      - EMV_9F33
      - EMV_9F34
      - EMV_9F35
      - EMV_9F36
      - EMV_9F37
      - EMV_9F38
      - EMV_9F39
      - EMV_9F3A
      - EMV_9F3B
      - EMV_9F3C
      - EMV_9F3D
      - EMV_9F40
      - EMV_9F41
      - EMV_9F42
      - EMV_9F43
      - EMV_9F44
      - EMV_9F45
      - EMV_9F46
      - EMV_9F47
      - EMV_9F48
      - EMV_9F49
      - EMV_9F4A
      - EMV_9F4B
      - EMV_9F4C
      - EMV_9F4D
      - EMV_9F4E
      - EMV_9F4F
      - EMV_9F53
      - EMV_9F5B
      - EMV_A5
      - EMV_BF0C
      - EMV_C0
      - EMV_6E
      - EMV_E7
      - EMV_DF01
      - EMV_DF02
      - EMV_DF03
      - EMV_DF04
    transactionConfirmationResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountType:
      type: string
      enum:
      - UNSPECIFIED
      - GIRO
      - SAVINGS
      - SECURITIES_DEPOSIT
      - SAVINGS_SECURITIES_DEPOSIT
      - GIRO_SECURITIES_DEPOSIT
      - FIXED_TERM_DEPOSIT
      - CREDIT_CARD
      - LOAN
      - MORTGAGE
      - FOREIGN_CURRENCY
      - EXTERNAL
      - CHECKING
      - UNIVERSAL
      - SPENDING_POWER
      - FEE_COLLECTION_ACCOUNT
      - ATM
      - VENDOR
      - SHAREHOLDER
      - GENERAL_LEDGER
      - CASH_RESERVE
      - LOAN_DENIAL
      - LEASE
      - CONSUMER_LOAN
      - COMMERCIAL_LOAN
      - RETIREMENT_LOAN
      - EXTERNAL_LOAN
      - SHARE
      - INDIVIDUAL_RETIREMENT
      - CARD_PAN
      - HEALTH_SAVINGS
      - CREDIT
      - CREDIT_LINE
      - CERTIFIED_DEPOSIT
      - INSTALLMENT
      - OTHER
      - DEFAULT_INVESTMENT_ACCOUNT
      - CASH_BENEFIT
      - OTHER_LOAN
      - DEBIT_CARD
      - DEFERRED_DEBIT_CARD
      - CHARGE_ACCOUNT
      - PREPAID
      - EMPLOYEE_BENEFIT
      example: SAVINGS
      description: '| Symbolic name              | Comment                                                        | |----------------------------|----------------------------------------------------------------| | UNSPECIFIED                | Default value for unknown accounts.                              | | GIRO                       | Giro account.                                                  | | SAVINGS                    | Savings account.  | SECURITIES_DEPOSIT         | Depot of securities (shares and so on).                        | | SAVINGS_SECURITIES_DEPOSIT | Savings securities.                                            | | GIRO_SECURITIES_DEPOSIT    | Giro securities.                                               | | FIXED_TERM_DEPOSIT         | Fixed term deposit.                                            | | CREDIT_CARD                | Credit card account. (ISO 8583; MC DE.54->30 / VISA DE.54->30).| | LOAN                       | An account that covers a credit and its balance and movements. | | MORTGAGE                   | Security for a loan.                                           | | FOREIGN_CURRENCY           | An account that holds money in a foreign curreny.              | | EXTERNAL                   | An account that represents an account of a foreign institution.| | CHECKING                   | Checking account. (ISO 8583; MC DE.54->20 / VISA DE.54->20)    |  | UNIVERSAL                  | ISO 8583; VISA DE.54->40)                                      |  | SPENDING_POWER             | ISO 8583; VISA DE.54->64)                                      |  | FEE_COLLECTION_ACCOUNT     | used to collect fees                                           |  | ATM                        | ATM                                                            | | VENDOR                     | Vendor                                                         | | SHAREHOLDER                | Shareholder                                                    | | GENERAL_LEDGER             | General ledger                                                 | | CASH_RESERVE               | Cash Reserve Line of Credit                                    | | LOAN_DENIAL                | Load denial                                                    | | LEASE                      | Lease                                                          | | CONSUMER_LOAN              | Consumer loan                                                  | | COMMERCIAL_LOAN            | Cemercial loan                                                 | | RETIREMENT_LOAN            | Retirement loan                                                | | EXTERNAL_LOAN              | External loan                                                  | | SHARE                      | Share                                                          | | INDIVIDUAL_RETIREMENT      | Individual Retirement Account(IRA)                             |'
    Warning:
      type: object
      required:
      - warningCode
      - effectiveDate
      properties:
        effectiveDate:
          $ref: '#/components/schemas/Date'
        expirationDate:
          $ref: '#/components/schemas/Date'
        warningCode:
          type: string
          example: 94
          description: The warning code for warning.
        description:
          type: string
          description: The description for this warning.
        category:
          type: string
          description: The category for this warning.
  examples:
    ServiceResponseFailExample:
      value:
        responseCode: FAIL
        extendedResponse:
          code: SERVER_FAILURE
          message: SERVER_FAILURE
  parameters:
    timestamp:
      name: timestamp
      in: header
      description: timestamp of the transaction
      required: true
      schema:
        type: string
        format: yyyy-MM-dd'T'HH:mm:ssZ
        description: Timestamp
        example: 2020-09-01T16:40:52+0000
    initiatingPartyName:
      name: initiatingPartyName
      in: header
      description: The name of the initiating party.
      required: true
      schema:
        type: string
        minLength: 1
        example: DieboldNixdorf
    version:
      name: version
      in: header
      description: Version of DN Open Backend API being used.
      required: true
      schema:
        type: string
        minLength: 1
        example: 4.3.0
    referenceId:
      name: referenceId
      in: header
      description: Unique identifier for the transaction request.
      required: true
      schema:
        type: string
        example: A123F34
    productName:
      name: productName
      in: header
      description: The name of the product which is consuming the service (business product name).
      required: true
      schema:
        type: string
        minLength: 1
        example: Transaction Middleware
    authorization:
      name: Authorization
      in: header
      description: 'In case the Authentication type is BASIC_AUTH, Authorization will contain base 64 encoded userName:password string using HTTP Basic Authentication.<br> In case the Authentication Type is JWE/TOKEN, Authorization will contain token received using getToken request as Bearer Token. '
      schema:
        type: string
        example: Basic afae1wad213da OR Bearer T2131241
    initiatingPartyId:
      name: initiatingPartyId
      in: header
      description: Identifier of the party that has initiated this transaction, in this case Diebold Nixdorf's ID.
      required: true
      schema:
        type: string
        minLength: 1
        example: DieboldNixdorf
  securitySchemes:
    basic:
      type: http
      description: Authorization will contain base 64 encoded userName:password string
      scheme: basic
    bearer:
      type: http
      description: Authorization will contain token received using getToken request as Bearer Token
      scheme: bearer
      bearerFormat: Any string
    jweBearer:
      type: http
      description: Authorization will contain Bearer encryptedJWT. JWT will be encrypted with backend endpoint public key
      scheme: bearer
      bearerFormat: Any string
externalDocs:
  url: /docs
  description: Find more information here