ProCash/DDC V3.

1/20
Message Protocol Extensions
Diebold Nixdorf
Version 31.20.3 / August 2018
Table of Contents
About this document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Purpose and Target Audience of the document . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Structure and content of the document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Change history. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
BLK Cash Messages Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
States. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Enhanced States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Currency Acceptor State (CIb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Write Command 3 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Write Command 20 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Basic Operational Command Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Enhanced Function Command Message (ID 7) . . . . . . . . . . . . . . . . . . . . . . . . 6
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Exceptions and Reject Reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
BLK Cheque Messages Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
States. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deposit State C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Enhanced States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Depositor State (DPb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Image Character Recognition State (ICb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Display Control Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Function Command Message (ID 4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Enhanced Function Command Message (ID 7) . . . . . . . . . . . . . . . . . . . . . . . 12
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
 Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Exceptions and Reject Reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Enhanced Function Command message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Supported fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Supported enhanced functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Deposit Emulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Supported Transaction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
States and Screens flow preconditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Typical Deposit Emulation transaction flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Suppress Unsolicited Status und Hardware Configuration . . . . . . . . . . . . . . . . . 17
Operation Key Buffer Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
FID and Screen Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Local Printer Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Regular expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Non supported Functions and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Enhanced States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Camera State (CMb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Enhanced Card Reader State (CRb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Get Encrypted PIN State (EPb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Service Code Check State (SVb). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Check PIN State (@Cb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Transaction Request State (@Ib) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Track Buffer Compare State (@Mb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Buffer Shift State (@Nb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Copy Buffer Data State (@Pb). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Multi-tasking State (@Xb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Bibliography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
ProCash/DDC V3.1/20 Message Protocol Extensions

Trademark Rights
As long as hardware and software names are contained in this document, they
may have been also registered as trademarks of their respective product
owners and shall be treated as such. Diebold Nixdorf has, in the main,
followed the manufacturers' spelling for product names.

Confidentiality Undertaking
Copyright © Wincor Nixdorf International GmbH 2018
The contents of this document may not be reproduced, exploited or published,
whether in whole or in part, without the prior written permission of Wincor
Nixdorf International GmbH.
The copyright applies to all forms of storage and reproduction in which this
information is incorporated including, but not limited to, magnetic memory,
computer printouts and visual displays.
Offenders will be prosecuted and liable for all cost and damages incurred by
the breach.
All rights, including rights created by patent grant or registration of a utility
model or design, are reserved. Right of any technical modifications reserved.

Names and Other Data

The names, e-mail addresses, telephone numbers and other data used in this
document are purely fictional (except the e-Mail addresses listed below to
return feedback to this document). Any resemblance to actual persons, living or
dead is coincidental.

Comments, Findings
In case there is something you want to tell us about this document please
inform us via our iSupport interface.
There you can open an incident to inform us regarding comments or findings
related to this document.
External: https://www.dieboldnixdorf.com/de-de/support/egate
Internal: https://ebusiness.wincor-nixdorf.com/OA_HTML/iSupportLogin.jsp

If you do not have access to iSupport and there is nobody known having an
account, please login to the Diebold Nixdorf Learning Suite
(https://training.wincor-nixdorf.com) and complete the iSupport Web-based
training (WBT) to receive access to iSupport.

August 2018 | Public Document version 31.20.3 1/26

ProCash/DDC V3.1/20 Message Protocol Extensions

About this document

Purpose and Target Audience of the document

This document describes the supported D91x features not covered in the
ProCash/DDC User Guide manual.
Additional information about formats, messages, etc. can be found in the Agilis® 3
91x™ Terminal Programming Manual.

Structure and content of the document

Information about the purpose and target audience of the document, the structure
and content of the document, responsibilities, status, etc. can be found in this
chapter.

Chapter BLK Cash Messages Extension documents the extension to support BLK
Cash In.

Chapter BLK Cheque Messages Extension describes the message extensions for
BLK Check In.

Chapter Enhanced Function Command message shows which enhanced function

commands are supported.

Chapter Deposit Emulation talks about what is supproed regarding Envelope Deposit
Emulation for Cash In.

Chapter Enhanced States lists details about supported States.

The last chapter Appendix contains the list of Abbreviations, the Bibliography and
Table Index.

August 2018 | Public Document version 31.20.3 2/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Change history
Table 1. Change History
Version Date Changes
3.1/00 March 2016 Initial version
3.1/10 July 2017 Added BLK Cash Messages Extension and BLK Cheque
Messages Extension
3.1/20 August Added Enhanced Function Command message, Deposit
2018 Emulation and Enhanced States.
New D91x compatible options parameter (
D91X_OPTIONS).
Enhanced Card Reader State (CRb) and Multi-tasking
State (@Xb) detailed.

August 2018 | Public Document version 31.20.3 3/26

ProCash/DDC V3.1/20 Message Protocol Extensions

BLK Cash Messages Extension

Since release 3.0/10 ProCash/DDC supports Diebold’s Bulk Notes Acceptor (BLK)
message protocol. The following sub sections give detailed instructions about the
DDC message format extensions and parameters which are necessary for the host
programmer to integrate the Diebold’s Bulk Notes Acceptor support in the DDC
network. It will also be described how to setup ProCash/DDC on the client side for
Bulk Notes Acceptor message processing.

This chapter describes following areas:

• Supported hardware systems

• Messages and field extensions
• Parameters and options related to BLK message processing
• Restrictions

Supported Hardware

Diebold’s Bulk Notes Acceptor messages are supported on the following pure cash
deposit devices and cash recycling systems which are released by ProCash/DDC.

For further details please read ProCashIn/Online Installation & Configuration Manual
chapter Supported Hardware and Dependencies and Supported Hardware of other
vendors.

Messages

The following sections describe the DDC host to terminal and terminal to host
messages which are involved if Diebold’s Bulk Notes Acceptor message processing
is enabled.

August 2018 | Public Document version 31.20.3 4/26

ProCash/DDC V3.1/20 Message Protocol Extensions

States

Cash Deposit transactions can be built either via multiple states or via multiple
function commands sent via Function Command Message sent by the host.

This section describes the relevant states which are needed to perform Cash Deposit
transactions via the navigation through the state table. In the Diebold protocol are
defined several extended states, where the switch provider can decide which of
those states are needed to be used for Cash Deposit processing.

Enhanced States

Currency Acceptor State (CIb)

The Currency Acceptor State (CIb) directs the terminal to perform specific cash
deposit operations. It can be used for single note and bundle notes processing.

ProCash/DDC in general provides full support of this state, but because of the wide
area of configuration and different customer solution design additional local
configuration settings, or code changes might be necessary to fulfill the requirements
in the customer project.

Host To Terminal messages

This chapter describes the host to terminal messages and relevant extensions for
BLK message processing.

Write Command 3 Message

The Write Command 3 message configures terminal parameters and timers.

Bit 5 (value 32) of Miscellaneous Features 4 specifies if expanded MDS status

information of a Bulk Cash Recycler should be reported. This feature is not
supported by ProCash/DDC.

Write Command 20 Message

The Write Command 20 message is used to enable or disable selected note types.

August 2018 | Public Document version 31.20.3 5/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Basic Operational Command Message

This message has different command codes which specify the type of the
operational command message.

Involved Command Codes for BLK information:

Code 3 - Configuration Information Request

The host sends terminal command 1|||3 to retrieve the terminal
configuration.

Code ; - Retrieve Enhanced Supply Counts

The host sends terminal command 1|||; to retrieve the terminal supply
counters.

Code < - Retrieve Then Set or Clear Enhanced Supply Counts

The host sends terminal command 1|||< to retrieve the terminal supply
counters.

Enhanced Function Command Message (ID 7)

The host sends an Enhanced Function Command Message with function data (CIb)
for the Currency acceptor to the terminal.

August 2018 | Public Document version 31.20.3 6/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Terminal To Host messages

This chapter describes the terminal to host messages and relevant extensions for the
BLK message processing.

Solicited Status

Hardware Configuration Status (DID = B)

In response to the Basic Operational Command Message 1|||3
"Configuration Information Request", the terminal sends the Hardware
Configuration Status (DID = B) message to the central.

Retrieve Enhanced Supply Counts

In response to the Basic Operational Command Message 1|||; "Retrieve
Enhanced Supply Counts", the terminal sends the supply counters of the
terminal, which includes the cash deposit counters, to the central.

Retrieve Then Set or Clear Enhanced Supply Counts

In response to the Basic Operational Command Message 1|||< "Retrieve
Then Set or Clear Enhanced Supply Counts", the terminal sends the new
supply counters of the terminal, which includes the cleared cash deposit
counters, to the central.

Enhanced Status (solicited) (Status Descriptor = J)

Currency Acceptor device status solicited messages are sent as Enhanced
Status via four digit Device ID ’CI01’.

Unsolicited Status

Enhanced Status (unsolicited) (Status Descriptor = J)

Currency Acceptor device status unsolicited messages are sent as Enhanced
Status via four digit Device ID ’CI01’.

Consumer Request Message

The terminal sends multiple Buffer ID’s with cash deposit data to the central.

Exceptions and Reject Reasons

This section describes the Exceptions and Restrictions of BLK message processing.

• The BLK message processing does not support coin deposits

• Mixed Media processing of Checks and notes is not supported

August 2018 | Public Document version 31.20.3 7/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Terminal Configuration

The following table lists the local terminal parameters which are involved to enable
BLK message processing. Please refer to the ProCash/DDC 3.1/10 Installation &
Configuration manual.

Table 2. Bulk Cash In parameters

SECTION in "CUSTOM.PPF" REGISTRY LOCATION
[CCCASHINTRANSACTIONFW] [HKEY_LOCAL_MACHINE\SOFTWARE\
Wincor
Nixdorf\ProTopas\CurrentVersion\LYNXC
AIN\CCCASHINTRANSACTIONFW]
PARAMETER NAME REGISTRY PARAMETER
MESSAGE_MODE MESSAGE_MODE

August 2018 | Public Document version 31.20.3 8/26

ProCash/DDC V3.1/20 Message Protocol Extensions

BLK Cheque Messages Extension

Since release 3.0/20 ProCash/DDC supports Diebold’s Bulk Cheque Deposit (BLK)
message protocol. The following sub sections give detailed instructions about the
DDC message format extensions and parameters which are necessary for the host
programmer to integrate the Diebold’s Bulk Cheque Deposit support in the DDC
network. It will also be described how to setup ProCash/DDC on the client side for
Bulk Cheque Deposit message processing.

The BLK Cheque Messages Extension also has included the description for Single
Cheque processing on single Cheque deposit devices.

This chapter describes following areas:

• Supported hardware systems

• States (without ProFlex)
• Screens (without ProFlex)
• Messages and field extensions
• Parameters and options related to BLK message processing
• Restrictions

Supported Hardware

Diebold’s Bulk Cheque Deposit messages are supported on the following Cheque
deposit devices which are released by ProCash/DDC.

For further details please read ProChequeIn Installation & Configuration Manual
chapter Supported Hardware and Dependencies and Supported Hardware of other
vendors.

August 2018 | Public Document version 31.20.3 9/26

ProCash/DDC V3.1/20 Message Protocol Extensions

States

Cheque Deposit transactions can be built either via multiple states or via multiple
function commands sent via Function Command Message sent by the host. This
section describes the relevant states which are needed to perform Cheque Deposit
transactions via the navigation through the state table. In the Diebold protocol are
defined several basic and extended states, where the switch provider can decide
which of those states are needed to be used for the Single and / or Bundle Cheque
deposit processing.

Deposit State C

The Deposit State (C) tells the terminal how to process a deposit operation.

Enhanced States

Depositor State (DPb)

The Deposit State (DPb) can be used for Single and Bulk Cheque deposit
processing. The deposit state data directs the terminal to perform specific deposit
operations.

Image Character Recognition State (ICb)

The Image Character Recognition State (ICb) determines how a given document is
interpreted, which fields on the document to recognize and where to store the
information found in those field locations. Using this state requires the installation of
Image recognition software (e.g. A2iA Check Reader). The fields and zones, which
are needed to be recognized, have to be defined in the customer project.

August 2018 | Public Document version 31.20.3 10/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Screens

This section describes just the part how to display Check images on consumer
screens.

Display Control Sequences

Check Images on the consumer screen can be displayed via escape control
sequence ESC Q or ESC @ nnn.

ESC Q
This control sequence displays a front side Cheque image on screen, which is
locally configured via parameter CHQ_FRONT_IMG, where file name and file
path is specified. The width and height of the image can be defined via
parameter CHQ_SIZE.
Refer to ProChequeIn Installation & Configuration Manual for detailed
parameter descriptions.

ESC @ nnn
This control sequence can display either a front side or back side Cheque
image on screen in two resolutions, 640x240 or 320x120 pixels. The types of
images are locally configured via parameters CHQ_FRONT_IMG and
CHQ_BACK_IMG, where the file names and file paths are specified.
Refer to ProChequeIn 3.1/10 Installation & Configuration Manual for detailed
parameter descriptions.

Messages

The following sections describe the DDC host to terminal and terminal to host
messages which are involved if Diebold’s Bulk Cheque Deposit message processing
is enabled.

Host To Terminal messages

This chapter describes the host to terminal messages and relevant extensions for
BLK Cheque Deposit message processing.

August 2018 | Public Document version 31.20.3 11/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Function Command Message (ID 4)

The host can send following Function Commands in a Function Command Message
(ID 4) for Cheque Deposit processing to the terminal:

• Deposit Check to Escrow (R) (not supported)

• Return Check if on Escrow (S) (rollback and Eject Cheque)
• Retain Check if on Escrow (T) (deposit Cheque)

Enhanced Function Command Message (ID 7)

The host sends an Enhanced Function Command Message with function data (DPb)
for Cheque Deposit processing to the terminal.

Terminal To Host messages

This chapter describes the terminal to host messages and relevant extensions for the
BLK Cheque Deposit message processing.

Solicited Status

Hardware Configuration Status (DID = B)

In response to the Basic Operational Command Message 1|||3 "Configuration
Information Request", the terminal sends the Hardware Configuration Status
(DID = B) message to the central.

Enhanced Status (solicited) (Status Descriptor = J)

Cheque Deposit device status solicited messages are sent as Enhanced Status
via four digit Device ID ’DP01’.

Unsolicited Status

Enhanced Status (unsolicited) (Status Descriptor = J)

Cheque Deposit device status unsolicited messages are sent as Enhanced
Status via four digit Device ID ’DP01’.

Consumer Request Message

The terminal sends multiple Buffer ID’s with Cheque deposit data to the central.

August 2018 | Public Document version 31.20.3 12/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Exceptions and Reject Reasons

This section describes the Exceptions and Restrictions of BLK Cheque message
processing.

• Mixed Media processing of Checks and notes is not supported

Terminal Configuration

The following table lists the local terminal parameters which are involved to enable
BLK message processing. Please refer to the ProCash/DDC Installation &
Configuration manual for detailed parameter description.

Table 3. Bulk Cheque In parameters

SECTION in "CUSTOM.PPF" REGISTRY LOCATION
[CHEQUE_IN] [HKEY_LOCAL_MACHINE\SOFTWARE\
Wincor
Nixdorf\ProTopas\CurrentVersion\LYNXP
AR\CHEQUE_IN]
PARAMETER NAME REGISTRY PARAMETER
MESSAGE_MODE MESSAGE_MODE

August 2018 | Public Document version 31.20.3 13/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Enhanced Function Command message

Since ProCash/DDC version 3.1/20 Diebold’s Enhanced Function Command
message (ID 7) is partially supported. The enhanced Function Command message
provides more versatility and flexibility than the standard Function Command
message (ID 4).

This chapter describes following areas:

• Supported fields of the message

• Supported enhanced functions

Supported fields

The following fields are supported

• Message ID (Enhanced Function Command / ID 7)

• Logical Unit Number (LUNO)
• Message Sequence Number (used for MACing)
• Message Coordination Number
• Transaction Serial Number
• Good Operation Next State
• Update Screens (ID ‘6’)
• Update Buffers – Alphanumeric Format (ID ‘9’)
• partially Perform Function (ID ‘:’), see Supported enhanced functions
• Update Buffers – ASCII Hex Format (ID ‘<’)
• Update Buffers – 3 Digit Decimal Format (ID ‘=’)
• MAC Data

August 2018 | Public Document version 31.20.3 14/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Supported enhanced functions

Enhanced functions can also be used in Function Command message (ID 4).
Especially EMV (SCb) and bulk Cash In (CIb) is already supported before 3.1/20.

The following enhanced functions are supported

• Currency Acceptor function (CIb)

• Card Reader function (CRb), operations
- 102 – Write track 3
- 103 – Return and wait (as 107)
- 104 – Retain and wait
- 105 – reserved
- 106 – Return, do not wait
- 107 – Return, wait, capture
- 108 – reserved
- 111 – Write track 1
- 112 – Write track 2
• Multiple Functions function (MFb)
• Printer function (PRb) for receipt, journal and electronic journal
• Do Nothing function (.Ab)
• Smart Card function (SCb)

August 2018 | Public Document version 31.20.3 15/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Deposit Emulation
The DDC Deposit Emulation feature is supported since ProCash/DDC 3.1/20. It
allows Envelope Deposit transaction processing on terminals equipped with a Cash
deposit (recycler) or/and a Check deposit module. The Deposit Emulation feature is
useful for terminals connected to host systems which do not support the native Cash
and Check Deposit messages.

Following major features are supported:

• Operation Key Buffer Replacement

Sets the Operation Key Buffer to emulate an Envelope Deposit Consumer
Request message.
• FID and Screen Replacement
Exchange of original Function ID or Enhanced Function ID and screen
• Local Printer Forms
It can be configured specific templates for printing where also variables can be
filled with data from original host print data, screens or/and buffers. Regular
expressions are used to define rules which parts of the data should be inserted in
the variables of the form template.

Supported Transaction Types

The following transaction types are supported.

• Cash Only
• Single Check
• Bundle Check
• Mixed Media (Cash and Check)

August 2018 | Public Document version 31.20.3 16/26

ProCash/DDC V3.1/20 Message Protocol Extensions

States and Screens flow preconditions

To be able to perform Cash & Check Deposit processing, ProCash/DDC requires a

set of states and screens, which are either downloaded from the network or locally
configured.

ProCash/DDC supports all necessary states and screens from the DDC native
protocol which are required for Cash & Check Deposit processing. Alternately it can
also be used states and screens from the Wincor Nixdorf Message Extension.

For details about states and screen configuration and how to setup a state table for
Cash & Check Deposit processing, please refer to chapter Bibliography where the
relevant manuals are listed.

Typical Deposit Emulation transaction flow

1. A Consumer initiates a deposit transaction.

2. The terminal collects media and the Consumer confirms the deposit amounts.
3. The terminal sends the network an equivalent request for an envelope deposit
transaction.
4. The network authorizes or denies the envelope deposit.
5. The terminal completes the deposit transaction as follows.
- Translates the network’s function command(s) to equivalent check and/or cash
deposit processing
- Prints a configured receipt
- If a configured deposit fault occurred, reports an equivalent envelope deposit
fault to the network

Suppress Unsolicited Status und Hardware Configuration

At the discretion of the network, the feature can be configured to suppress

unsolicited fault statuses generated by the cash deposit (or recycle) module. Also, if
necessary, the terminal can be configured to suppress the cash deposit portion of
the Hardware Configuration status data.

August 2018 | Public Document version 31.20.3 17/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Operation Key Buffer Replacement

The Operation Key Buffer Replacement means replacing the original state driven
Operation Key Buffer against the configured Deposit Emulation Operation Key Buffer
which is used instead in the Consumer Request message. The trigger when the
Operation Key Buffer is replaced depends on configuration parameters for each
Transaction Type.

FID and Screen Replacement

The Deposit Emulation feature allows a remapping of Function ID’s or Enhanced

Function ID’s and screens to the FID’s assigned to one of the Cash & Check
Operation Type. The replacement trigger is based on parameter configuration when
the configured FID, Next State, FID Screen is matching with the content of Function
command sent from the network.

Local Printer Forms

Within the Deposit Emulation feature it can be defined multiple print templates for
Receipt, Journal, Statement, or Envelope print data. The print templates can be
configured via registry parameters where it is specified based on which FID, next
sate and screen combination the local receipt data should be printed.

Regular expressions

The local print templates can be configured with variables as placeholders. Each
variable can be assigned a Regular Expression (regex) as rule what data are
extracted from the source buffer, which can be the original print data from Function
Command, downloaded screen, or specific Buffer data.

Configuration Parameters

All configuration parameters for the Deposit Emulation feature are described in the
ProCash/NDC - ProCash/DDC Installation & Configuration manual.

August 2018 | Public Document version 31.20.3 18/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Non supported Functions and Parameters

Compared with the Deposit Emulation description from Agilis® 3 91x™ Terminal
Programming Manual, some parameters in ProCash/DDC are not supported, not
necessary or defined as different name.

The following table lists Agilis parameters and functions, which are not or partly
supported in ProCash/DDC.

Table 4. Deposit Emulation parameters

Agilis Parameters ProCash/DDC Clarification
or Functions Parameters
Maximum number of N/A The maximum can be defined directly in
receipt images the print data configuration.
User Amount Buffer - Not configurable, it will be used the
ID amount buffer.
Include MICR Line - Not configurable, will be automatically
included if single Check mode is enabled.
Receipt and journal FORM_X All kinds of printer forms are assigned to
printer forms the mapped function in dependency to
the host FID and next state of the host
function command. There is one template
only for an accepted and denied
transaction.
REGEX + Regular ?<= look behind expression is not
Expressions supported
(regex library of C++ VS 11).

August 2018 | Public Document version 31.20.3 19/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Enhanced States
Following a list of supported enhanced states, which are not explicitly documented in
the ProCash/DDC User Guide manual.

The following parameter can be used to activate specific D91x compatible handling
of states.

Table 5. D91x compatible options parameter (D91X_OPTIONS)

Configurable bits Description
(can be added to
support multiple
features)
0x0001 (weight 1) Activate D91x compatible state handling for Enhanced
Card Reader State (CRb) and Multi-tasking State (@Xb).
0x0002 (weight 2) Activate screen blanking feature with reserved screen 943
in Card Read State (A), Enhanced Card Reader State
(CRb) and Multi-tasking State (@Xb).

Camera State (CMb)

Ignored, just exit to Good Operation Next State.

August 2018 | Public Document version 31.20.3 20/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Enhanced Card Reader State (CRb)

The following are the supported operations

• 002 - Write Track 3

• 003 - Return and wait
Ignoring the time-out value but use default timer.
• 004 - Retain and wait
• 007 - Return, wait, capture
Ignoring the time-out value but use default timer.
• 011 - Write track 1
• 012 - Write track 2

Based on D91x compatible options parameter (D91X_OPTIONS) the handling of card

read operations

• 001 - Read and wait

• 013 - Read, do not lock
• 014 - Read and lock

is slightly different.

Compatible D91x handling deactive

A normal Card Read State (A) is processed, the time-out is ignored (should be
999 - infinite) and automatic FIT match takes place.
Cardless overlay processing and contactless (NFC cards) handling is
supported.

Compatible D91x handling activated

Compatible processing of enhanced card reader state.
Cardless overlay and contactless (NFC cards) handling is not supported.

August 2018 | Public Document version 31.20.3 21/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Get Encrypted PIN State (EPb)

There are no limitations or restrictions.

Service Code Check State (SVb)

There are no limitations or restrictions.

Check PIN State (@Cb)

There are no limitations or restrictions.

Transaction Request State (@Ib)

There are no limitations or restrictions.

Track Buffer Compare State (@Mb)

There are no limitations or restrictions.

Buffer Shift State (@Nb)

There are no limitations or restrictions.

Copy Buffer Data State (@Pb)

There are no limitations or restrictions.

August 2018 | Public Document version 31.20.3 22/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Multi-tasking State (@Xb)

The Multi-tasking State is supported in two different ways, based on D91x compatible
options parameter (D91X_OPTIONS).

Compatible D91x handling deactive

A normal Card Read State (A) is processed, customer input (information entry
state @Db) is ignored and automatic FIT match takes place.
Cardless overlay processing and contactless (NFC cards) handling is
supported.

Compatible D91x handling activated

Compatible processing of information entry and enhanced card reader state for
operations

• 001 - Read and wait

• 013 - Read, do not lock
• 014 - Read and lock

Contactless (NFC cards) handling is not supported.

August 2018 | Public Document version 31.20.3 23/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Appendix

Abbreviations

Abbreviation Description
API Application Program Interface
ARC Application Return Code
ASCII American Standard Code for Information Interchange
ATM Automated Teller Machine
ADRS Automatic Device Repair System
CI Customization Image
CRS Cash Recycling System
CRT Cathode Ray Tube
CSC Customer Service Center
DDC Diebold Direct Connect
EBCDIC Extended Binary Coded Decimal Interchange Code
FDK Function Display Key
FIT Financial Institution Table
ID Identification
IDCU ID Card Unit
MDS Modular Delivery System
NCR National Cash Register
NFC Near Field communication
NDC NCR Direct Connect
PC Personal Computer
PPF Parac Parameter File
RCM Rich Client Manager

August 2018 | Public Document version 31.20.3 24/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Bibliography
Table 6. Bibliography
Title Version / location Comment
ProCash/DDC User V3.1/20 (PDF) on Provides detailed function description
Guide manual installation media about ProCash/DDC operation and DDC
Host to terminal and Terminal to Host
messages (Download Commands,
Consumer Request and Function
command messages, Terminal
Commands, Status messages, etc.).
ProCash/NDC V3.1/20 (PDF) on This manuals contains detailed
ProCash/DDC installation media descriptions of configuration parameters
Installation & of ProCash/DDC, which are stored in the
Configuration Windows registry. Further contents are
manual descriptions about several Utilities which
are additionally delivered.
ProCashIn/Online V3.1/20 (PDF) on This manual details configuration
Installation & installation media parameters of ProCashIn/Online, which
Configuration are stored in the Windows registry.
Manual
ProChequeIn V3.1/20 (PDF) on This manual details configuration
Installation & installation media parameters of ProChequeIn, which are
Configuration stored in the Windows registry.
Manual
Wincor Nixdorf 1.55 (PDF), needs Specifies protocol extensions (State
NDC/Diebold D91x registration tables, messages) for cash in functions
Message Format defined by Wincor Nixdorf.
Extension for Cash
In
Wincor Nixdorf 1.48 (PDF), needs Specifies protocol extensions (State
NDC/Diebold D91x registration tables, messages) for Cheque In
Message Format functions defined by Wincor Nixdorf.
Extension for
Cheque In
Agilis® 3 91x™ Diebold Nixdorf Specifies D91x message protocol in
Terminal documentation detail.
Programming
Manual

August 2018 | Public Document version 31.20.3 25/26

ProCash/DDC V3.1/20 Message Protocol Extensions

Table Index

Table 1: Change History

Table 2: Bulk Cash In parameters
Table 3: Bulk Cheque In parameters
Table 4: Deposit Emulation parameters
Table 5: D91x compatible options parameter (D91X_OPTIONS)
Table 6: Bibliography

August 2018 | Public Document version 31.20.3 26/26