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 Processing 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 Processing API
  description: Performs a transaction.
paths:
  /credit:
    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: performs credit operation
      tags:
      - Account Processing API
      operationId: credit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/creditRequest'
        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'
  /debit:
    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: performs debit operation
      tags:
      - Account Processing API
      operationId: debit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/debitRequest'
        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'
  /pinCheck:
    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: Verify pin
      tags:
      - Account Processing API
      operationId: pinCheck
      description: Verify pin.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pinCheckRequest'
        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'
  /transfer:
    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: performs transfer operation
      tags:
      - Account Processing API
      operationId: transfer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferRequest'
        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/transferConfirmationResponseUpdatedBalance'
        '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'
  /reversal:
    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: Performs reversal for a transaction
      tags:
      - Account Processing API
      operationId: reversal
      description: Performs reversal for a transaction.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reversalRequest'
        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'
  /transferReversal:
    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: Performs reversal for a transfer transaction
      tags:
      - Account Processing API
      operationId: transferReversal
      description: Performs reversal for a transfer transaction.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferReversalRequest'
        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/transferReversalResponse'
        '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'
  /currencyTransactionReporting:
    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: performs transactions that consists of cash deposits, check deposits, cash…
      tags:
      - Account Processing API
      operationId: currencyTransactionReporting
      description: Allows consumers to create teller transactions that consist of cash deposits, check deposits, cash withdrawals, and cash checks. It also allow consumers to add teller currency transactions.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/currencyTransactionReportingRequest'
        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/currencyTransactionReportingResponse'
        '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 currency transaction reporting 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:
    ExtendedResponseMessage:
      type: string
      description: Extended Response Message
      example: OK
    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'
    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
    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
    CancelReason:
      type: string
      description: Reason for cancellation
      example: HARDWARE_ERROR
      enum:
      - UNDEFINED
      - TIME_OUT
      - CONSUMER_CANCEL
      - HARDWARE_ERROR
      - COMMUNICATION_ERROR
      - NOT_AUTHORIZED
      - DOOR_OPENED
      - LIMIT_EXCEEDED
      - WORKSTATION_CLOSED
      - CHIP_ERROR
      - MESSAGE_INVALID
      - HSM_STATE_INVALID
      - CARD_READ_ERROR
      - SERVER_ERROR
      - CLIENT_ERROR
      - APPLICATION_CANCEL
      - COUNTERFEIT_LIMIT_EXCEEDED
    ConsumerId:
      type: string
      description: A unique identifier of a consumer
      example: '123456'
    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'
    Channel:
      type: string
      enum:
      - selfService
      - network
      - teller
      - mobile
      - undefined
      description: Channel through which transaction is initiated.
    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'
    transferReversalRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - confirmationNumber
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            accountRefFrom:
              $ref: '#/components/schemas/AccountRef'
            accountRefTo:
              $ref: '#/components/schemas/AccountRef'
            amount:
              $ref: '#/components/schemas/Amount'
            fee:
              $ref: '#/components/schemas/TransactionFeeAmountOnly'
            confirmationNumber:
              allOf:
              - $ref: '#/components/schemas/ConfirmationNumber'
              description: the transaction confirmation number for the transaction to be reversed.
            remarks:
              type: string
              description: Remarks for the transaction
              example: Reversal for ACCT XXXX 4567
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            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
    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'
    TransactionResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/TransactionWithStandin'
      description: Exact replica of the request 'transaction' object which must be returned by the host
    currencyTransactionReportingRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            remark:
              type: string
              description: Currency transaction reporting comments
              example: CTR request in process
            conductorConsumerId:
              type: string
              example: A000013
            conductorNonConsumerId:
              type: string
              example: '243234'
            conductorType:
              type: string
              example: NonConsumer
            transactionMetaData:
              type: array
              items:
                $ref: '#/components/schemas/TransactionMetaData'
            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
    ResponseCode:
      type: string
      enum:
      - OK
      - FAIL
      - RESUBMIT
      example: OK
    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
    PaymentSubType:
      type: string
      description: Payment subtype
      enum:
      - PRINCIPAL
      - REGULAR
      - PAYOFF
      - INTEREST_ONLY
      - MINIMUM
      - NOT_SPECIFIED
    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
    IsStandin:
      type: boolean
      description: Standin request indicator
      example: false
    CheckWithAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Check'
      - type: object
        properties:
          checkAmount:
            $ref: '#/components/schemas/Amount'
    AccountName:
      type: string
      description: The account name which is displayed to the user
      example: Your Savings account
    transferReversalResponse:
      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'
              fromAccountDetails:
                $ref: '#/components/schemas/AccountInformationBase'
              toAccountDetails:
                $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    TransactionMetaData:
      type: object
      required:
      - amount
      properties:
        settlementType:
          type: string
          description: The type of settlement.
          example: CASH
        operationType:
          type: string
          description: The type of operation.
          example: Credit
        accountRef:
          $ref: '#/components/schemas/AccountRef'
        amount:
          $ref: '#/components/schemas/Amount'
        transactionRef:
          type: string
          description: Transaction reference.
          example: A12345
        transactionDescCode:
          type: string
          description: Transaction description code
          example: Deposit
        beneficiaryConsumerId:
          type: string
          description: Id of the beneficiary who is a consumer
          example: A000013
        beneficiaryNonConsumerId:
          type: string
          description: Id of the beneficiary who is a non-consumer
          example: '22343'
        beneficiaryType:
          type: string
          description: Type of the beneficiary
          example: Consumer
    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
    NetworkId:
      type: string
      description: Id of the acquiring network (scheme specific)
      example: MAC
    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
    debitRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - accountRef
          - amount
          properties:
            amount:
              $ref: '#/components/schemas/Amount'
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            check:
              $ref: '#/components/schemas/CheckWithAmount'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            remark:
              type: string
              description: Transaction comments
              example: Transaction remark
            clearingCategoryCode:
              $ref: '#/components/schemas/ClearingCategoryCode'
            type:
              type: string
              example: PAYOFF
            valueDate:
              $ref: '#/components/schemas/ValueDate'
            fundTypeCode:
              $ref: '#/components/schemas/FundTypeCode'
            cashBoxNumber:
              type: string
              description: Cash Box Number
              example: '1234'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            fee:
              $ref: '#/components/schemas/TransactionFeeAmountOnly'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AdditionalProperties:
      type: object
      additionalProperties:
        type: string
      description: Additional properties can be provided within this object
    pinCheckRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - card
          - pin
          properties:
            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'
    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
    CheckType:
      type: string
      enum:
      - ON_US
      - OFF_US
      - GOVERNMENT
      - NOT_SPECIFIED
      example: ON_US
      description: The Check Type value of the check
    SupplementaryData:
      type: object
      description: 'Additional information incorporated as an extension to the message by mixins based on the transaction type          '
    EMVTagData:
      type: object
      properties:
        tag:
          $ref: '#/components/schemas/EMVTags'
        value:
          type: string
          description: Hex Encoded value of EMVTag
          example: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
    TransactionWithStandin:
      type: object
      allOf:
      - $ref: '#/components/schemas/TransactionBase'
      - type: object
        properties:
          isStandin:
            $ref: '#/components/schemas/IsStandin'
    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
    ServiceResponse:
      type: object
      required:
      - responseCode
      properties:
        responseCode:
          $ref: '#/components/schemas/ResponseCode'
        extendedResponse:
          $ref: '#/components/schemas/ExtendedResponse'
    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
    reversalRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - confirmationNumber
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            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'
            confirmationNumber:
              allOf:
              - $ref: '#/components/schemas/ConfirmationNumber'
              description: the transaction confirmation number for the transaction to be reversed.
            remarks:
              type: string
              description: Remarks for the transaction
              example: Reversal for ACCT XXXX 4567
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    transferRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - accountRefTo
          - accountRefFrom
          - amount
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            remark:
              type: string
              description: Transaction comments
              example: Transaction remark
            type:
              $ref: '#/components/schemas/PaymentSubType'
            clearingCategoryCode:
              $ref: '#/components/schemas/ClearingCategoryCode'
            valueDate:
              $ref: '#/components/schemas/ValueDate'
            fundTypeCode:
              $ref: '#/components/schemas/FundTypeCode'
            accountRefTo:
              $ref: '#/components/schemas/AccountRef'
            accountRefFrom:
              $ref: '#/components/schemas/AccountRef'
            amount:
              $ref: '#/components/schemas/Amount'
            fee:
              $ref: '#/components/schemas/TransactionFeeAmountOnly'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    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
    Amounts:
      type: array
      items:
        $ref: '#/components/schemas/AccountAmount'
    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
    ValueDate:
      type: string
      description: Refers to some future point in time at which the value of an account or transaction becomes effective
      example: '2020-07-23'
    ClearingCategoryCode:
      type: string
      description: Defines type of transaction clearing IMED/MEMO
      enum:
      - IMED
      - MEMO
      example: IMED
    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
    currencyTransactionReportingResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              receiptId:
                type: string
                description: Receipt identification number of the transaction
                example: 998a87999
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    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'
    transferConfirmationResponseUpdatedBalance:
      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'
              fromAccountDetails:
                $ref: '#/components/schemas/AccountInformationBase'
              toAccountDetails:
                $ref: '#/components/schemas/AccountInformationBase'
              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)                             |'
    MerchantCategory:
      type: string
      description: Identifier representing the merchant's type of business product or service
      example: '6011'
    creditRequest:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionWithStandin'
        payload:
          type: object
          required:
          - accountRef
          - amount
          properties:
            amount:
              $ref: '#/components/schemas/Amount'
            consumerId:
              type: string
              example: '123456'
            check:
              $ref: '#/components/schemas/CheckWithAmount'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            remark:
              type: string
              description: Transaction comments
              example: Transaction remark
            clearingCategoryCode:
              $ref: '#/components/schemas/ClearingCategoryCode'
            type:
              $ref: '#/components/schemas/PaymentSubType'
            valueDate:
              $ref: '#/components/schemas/ValueDate'
            fundTypeCode:
              $ref: '#/components/schemas/FundTypeCode'
            cashBoxNumber:
              type: string
              description: Cash Box Number
              example: '1234'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            fee:
              $ref: '#/components/schemas/TransactionFeeAmountOnly'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    FundTypeCode:
      type: string
      enum:
      - CASH
      - CHECK
      example: CASH
  parameters:
    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
    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
    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
    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
    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
    initiatingPartyName:
      name: initiatingPartyName
      in: header
      description: The name of the initiating party.
      required: true
      schema:
        type: string
        minLength: 1
        example: DieboldNixdorf
  examples:
    ServiceResponseFailExample:
      value:
        responseCode: FAIL
        extendedResponse:
          code: SERVER_FAILURE
          message: SERVER_FAILURE
  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