Diebold Nixdorf

DN Assist API

Diebold Nixdorf API for SelfService Assistance — remote assistance, session and device interaction operations against self-service terminals. 23 paths with basic, bearer and JWE-bearer authentication; OpenAPI 3.0.1, version 1.0.

Documentation GitHub OpenAPI

Operations 23

PUT /tellerReadiness Sets teller readiness status in TM for the corresponding teller id

GET /loadConfig/{tenantName} Retrieve configuration associated with tenantName

GET /twilioTaskRouter/{tenantName}/{tellerName} Retrieve twillio task router token

GET /terminalStatus/{tenantName} Retrieve terminal status details

GET /terminalData/{tenantName}/{workstationId} Retrieve terminal and associated cassette counter details

GET /sessionData/{tenantName}/{workstationId} Retrieve session data of current transaction

GET /customerData/{tenantName}/{externalCustomerId} Retrieve customer account details

GET /checkDetails/{tenantName}/{workstationId}/{transactionId} Retrieve checks details

PUT /updateCheckDetails/{tenantName} Update check details

GET /imagesFromTransaction/{tenantName}/{workstationId}/{transactionId} Retrieve list of images details #

GET /tokenZoomTeller/{tenantName} Gets zoom JWT for connecting to video meeting room

PUT /updateImage/{tenantName} Update image details

POST /saveImageFromTeller/{tenantName} Save image details

PUT /deleteImage/{tenantName} Delete image details

POST /limit/{tenantName} Save limit for a given business case

GET /limit/categories/{tenantName} Get the exception limit categories

PUT /getConsumer/{tenantName} Retrive consumers details

POST /setConsumer/{tenantName} Save consumer details

POST /sendCommand/{tenantName} Send command such as system shutdown, etc

GET /statusRequest/{tenantName} Get the status of host and server

POST /callForwarding/{tenantName} To create a task in Twillio task router for group call.

GET /validateToken/{tenantName} To validate the token

PUT /cancelTask/{tenantName} To cancel a group call in Twilio based on the given task sid.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/dn-assist-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.0.1
info:
  title: DN Assist API
  description: Diebold Nixdorf API for SelfService Assistance
  version: '1.0'
servers:
- url: https://localhost:8080/tm-assist-api/v1
tags:
- name: DN Assist API
paths:
  /tellerReadiness:
    put:
      summary: Sets teller readiness status in TM for the corresponding teller id
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Sets teller readiness status in TM for the corresponding teller id
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TellerReadinessRequest'
        required: true
      responses:
        '200':
          description: Successfully updated teller status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TellerStatusResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /loadConfig/{tenantName}:
    get:
      summary: Retrieve configuration associated with tenantName
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve configuration associated with institute
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/tenantName'
      - $ref: '#/components/parameters/idToken'
      responses:
        '200':
          description: Successfully retrieved institute configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstituteConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /twilioTaskRouter/{tenantName}/{tellerName}:
    get:
      summary: Retrieve twillio task router token
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve twillio task router token
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/tenantName'
      - $ref: '#/components/parameters/tellerName'
      - $ref: '#/components/parameters/idToken'
      responses:
        '200':
          description: Successfully retrieved twilio task router token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TwilioTaskRouterResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /terminalStatus/{tenantName}:
    get:
      summary: Retrieve terminal status details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve terminal status details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved terminal status details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalStatus'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /terminalData/{tenantName}/{workstationId}:
    get:
      summary: Retrieve terminal and associated cassette counter details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve terminal and associated cassette counter details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/workstationId'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved terminal status and cassette counter detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalDataResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /sessionData/{tenantName}/{workstationId}:
    get:
      summary: Retrieve session data of current transaction
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve session data of current transaction
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/workstationId'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved session data of current transaction
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionDataResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /customerData/{tenantName}/{externalCustomerId}:
    get:
      summary: Retrieve customer account details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve customer account details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/externalCustomerId'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved customer details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /checkDetails/{tenantName}/{workstationId}/{transactionId}:
    get:
      summary: Retrieve checks details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve checks details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/workstationId'
      - name: transactionId
        in: path
        description: Transaction Number
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/TransactionNo'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved checks details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCheckImagesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /updateCheckDetails/{tenantName}:
    put:
      summary: Update check details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Update checks details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckDetailsRequest'
        required: true
      responses:
        '200':
          description: Successfully updated checks details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckDetailsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /imagesFromTransaction/{tenantName}/{workstationId}/{transactionId}:
    get:
      summary: Retrieve list of images details
      operationId: getImagesByWorkstationIdAndTransactionId
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Retrieve list of images details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/workstationId'
      - $ref: '#/components/parameters/transactionId'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved the Images
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /tokenZoomTeller/{tenantName}:
    get:
      summary: Gets zoom JWT for connecting to video meeting room
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Gets zoom JWT for connecting to video meeting room
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/roleType'
      - $ref: '#/components/parameters/topic'
      - $ref: '#/components/parameters/userIdentity'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully gets zoom JWT for connecting to video meeting room
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenZoomTellerResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /updateImage/{tenantName}:
    put:
      summary: Update image details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Update image details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateImageRequest'
        required: true
      responses:
        '200':
          description: Successfully stored image into server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateImageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /saveImageFromTeller/{tenantName}:
    post:
      summary: Save image details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Save image details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageRequest'
        required: true
      responses:
        '200':
          description: Successfully stored image into an
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveImageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /deleteImage/{tenantName}:
    put:
      summary: Delete image details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Delete image details
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageDeleteRequest'
        required: true
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Image deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteImageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /limit/{tenantName}:
    post:
      summary: Save limit for a given business case
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Save limit for a given business case
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LimitRequest'
        required: true
      responses:
        '200':
          description: Limit has been successfully updated for a given business case
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /limit/categories/{tenantName}:
    get:
      summary: Get the exception limit categories
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Get the exception Limit Categories for an Account Number
      parameters:
      - $ref: '#/components/parameters/accountNumber'
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Limit categories are successfully fetched for a given Account Number
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExceptionLimitCategoriesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /getConsumer/{tenantName}:
    put:
      summary: Retrive consumers details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Get consumers by search criteria of customer name, address, etc.
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConsumerRequest'
      responses:
        '200':
          description: Successfully retrieved consumer details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /setConsumer/{tenantName}:
    post:
      summary: Save consumer details
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Save consumer details
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetConsumerRequest'
        required: true
      responses:
        '200':
          description: Successfully stored consumer details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveConsumerResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /sendCommand/{tenantName}:
    post:
      summary: Send command such as system shutdown, etc
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Send command such as system shutdown, etc
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCommandRequest'
            examples:
              exampleRequest:
                value:
                  payload:
                    workstationId: '80810'
                    commandList:
                    - commandType: sbCommand
                      commandName: shutdown
                      commandParameters:
                      - key: mode
                        value: immediately
                    - commandType: genericCommand
                      commandName: imageRescan
                      commandParameters:
                      - key: rescanRequired
                        value: 'true'
        required: true
      responses:
        '200':
          description: Successfully send command to server in a queue
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendCommandResponse'
              examples:
                exampleRequest:
                  value:
                    responseCode: OK
                    extendedResponseCode: OK
                    payload:
                      commandStatuses:
                      - commandType: sbCommand
                        commandName: shutdown
                        commandSendStatus: success
                      - commandType: genericCommand
                        commandName: imageRescan
                        commandSendStatus: success
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /statusRequest/{tenantName}:
    get:
      summary: Get the status of host and server
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: Get the status of host and server
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Successfully retrieved Host and Server status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /callForwarding/{tenantName}:
    post:
      summary: To create a task in Twillio task router for group call.
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: To create a task in Twillio task router for group call and return the task sid
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupTaskRequest'
        required: true
      responses:
        '200':
          description: Successfully generated token for group call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallForwardingResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /validateToken/{tenantName}:
    get:
      summary: To validate the token
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: To validate the given token , if the token is valid send ok else not valid
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      responses:
        '200':
          description: Ok if it's a valid token else not ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateTaskResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /cancelTask/{tenantName}:
    put:
      summary: To cancel a group call in Twilio based on the given task sid.
      security:
      - bearer: []
      tags:
      - DN Assist API
      description: To cancel a group call task in Twilio
      parameters:
      - $ref: '#/components/parameters/tellerToken'
      - $ref: '#/components/parameters/workstationID'
      - $ref: '#/components/parameters/idToken'
      - $ref: '#/components/parameters/tenantName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelGroupTaskRequestPayload'
        required: true
      responses:
        '200':
          description: The task is updated to cancelled status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelGroupTaskResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    ServiceResponse:
      required:
      - responseCode
      - extendedResponseCode
      type: object
      properties:
        responseCode:
          $ref: '#/components/schemas/ResponseCode'
        extendedResponseCode:
          $ref: '#/components/schemas/ExtendedResponseCode'
    UnauthorizedServiceResponse:
      required:
      - responseCode
      - extendedResponseCode
      type: object
      properties:
        responseCode:
          $ref: '#/components/schemas/FailResponseCode'
        extendedResponseCode:
          $ref: '#/components/schemas/ServiceResponse_extendedResponse'
    ResponseCode:
      type: string
      example: OK
      enum:
      - OK
      - FAIL
      - RESUBMIT
    FailResponseCode:
      type: string
      example: FAIL
      enum:
      - OK
      - FAIL
      - RESUBMIT
    ExtendedResponse:
      required:
      - code
      type: object
      properties:
        code:
          type: string
          example: OK
        message:
          type: string
          example: OK
    ExtendedResponseCode:
      type: string
      description: Extended response code mapping
      example: SERVER_FAILURE
      enum:
      - OK
      - SERVER_FAILURE
      - NO_RESULT
      - ACCOUNT_NOT_FOUND
      - ACCOUNT_CLOSED
      - ACCOUNT_TYPE_INVALID
      - LIMIT_EXCEEDED
      - INSUFFICIENT_FUNDS
      - SERVER_NOT_READY
      - 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
      - PARTIALLY_FAILED
      - FAILED
    ExtendedResponseMessage:
      type: string
      description: Extended response message
      example: SERVER_FAILURE
    TenantName:
      type: string
      description: Name of the tenant
      example: pqeautotmcbo2
    IDToken:
      type: string
      description: ID Token
      example: eyJhbGciO....xMlv3NLDw
    WorkstationId:
      type: string
      description: Workstation Id
      example: '80810'
    Remarks:
      type: string
      description: Reason for change
    TransactionId:
      type: string
      description: Transaction id
      example: '616621626623'
    TransactionNo:
      type: string
      description: TM Transaction Number
      example: '108'
    TerminalId:
      type: string
      description: Terminal Id
      example: 80810
    ImageId:
      type: string
      description: Image id
      example: 41492121a2694330842ffef4abb1ad7b
    ConsumerId:
      type: string
      description: Consumer id
      example: '627846278462'
    CommandType:
      type: string
      description: Command Type
      example: sbCommand
      enum:
      - sbCommand
      - genericCommand
    CommandName:
      type: string
      description: Command Name
      example: shutdown
      enum:
      - shutdown
      - restart
      - prestagedTransaction
      - imageRescan
    CommandSendStatus:
      type: string
      description: Status to show if command has been sent successfully to terminal
      example: success
      enum:
      - success
      - failure
    Command:
      description: Command to be sent
      type: object
      properties:
        commandType:
          $ref: '#/components/schemas/CommandType'
        commandName:
          $ref: '#/components/schemas/CommandName'
        commandParameters:
          type: array
          items:
            $ref: '#/components/schemas/CommandParameter'
    CommandStatus:
      description: Statuses of commands sent
      type: object
      properties:
        commandType:
          type: string
          description: Command Type
          example: sbCommand
        commandName:
          type: string
          description: Command Name
          example: shutdown
        commandSendStatus:
          $ref: '#/components/schemas/CommandSendStatus'
    CommandParameter:
      description: Command parameter
      type: object
      properties:
        key:
          $ref: '#/components/schemas/ParameterKey'
        value:
          $ref: '#/components/schemas/ParameterValue'
    ParameterKey:
      type: string
      description: Parameter key
      example: mode
    ParameterValue:
      type: string
      description: Parameter value
      example: immediately
    TellerReadinessRequest:
      properties:
        payload:
          type: object
          required:
          - tellerStatus
          - tellerName
          - tenantName
          properties:
            tellerStatus:
              $ref: '#/components/schemas/TellerStatus'
            tellerName:
              $ref: '#/components/schemas/TellerName'
            tenantName:
              $ref: '#/components/schemas/TenantName'
    TellerStatus:
      type: string
      description: Teller Status Type
      example: READY_TO_SERVE
      enum:
      - READY_TO_SERVE
      - PAUSED_TO_SERVE
    TellerName:
      type: string
      description: Teller Name
      example: QAUSER@GMAIL.COM
    SendCommandMode:
      type: string
      description: Command Modes , If controlled is used it will shutdown or restart gracefully based on command type.
      example: IMMEDIATELY
      enum:
      - IMMEDIATELY
      - CONTROLLED
    Image:
      type: object
      properties:
        imageId:
          $ref: '#/components/schemas/ImageId'
        documentType:
          $ref: '#/components/schemas/DocumentType'
        frontImage:
          $ref: '#/components/schemas/FrontImage'
        backImage:
          $ref: '#/components/schemas/BackImage'
        validationStatus:
          $ref: '#/components/schemas/ImageValidationStatus'
        dateTime:
          $ref: '#/components/schemas/dateTime'
    DocumentType:
      type: string
      description: Name of an image document
      example: Driver license
    ImageValidationStatus:
      type: string
      description: Validation status of an image
      example: PENDING
      enum:
      - VALIDATED
      - PENDING
      - REJECTED
    FrontImage:
      type: object
      description: Front part of document image
      properties:
        imageData:
          $ref: '#/compone

# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/diebold/refs/heads/main/openapi/diebold-dn-assist-api-openapi.yml