ProCash/DDC

V3.1/00

Message Protocol Extensions

User Guide

Important Note:
This document may only be used by the individual or entity to which it is addressed. This document
may contain information that is privileged, confidential and may not be made public by law or
agreement . If the recipient of this document is not the intended individual or entity, you are hereby
notified that any further dissemination, distribution or copying of this information is strictly prohibited.

All hardware and software names mentioned in this document are trade names and/or trademarks of their respective
manufacturers

® All rights reserved by Wincor Nixdorf International GmbH 2000 - 2015

Edition November 2015

Copyright and Trademarks

Copyright © Wincor Nixdorf GmbH 2015.

All rights, including rights of translation by printing, copying or similar methods, even of parts, are reserved.
All rights, including rights created by patent grants or registration of a utility model or design, are reserved. Delivery
subject to availability; right of technical modifications reserved.
All names of hardware and software products mentioned in this manual are trade names and/or trademarks of
their respective manufacturers.
All hardware and software names used are trademarks of their respective manufacturers.
Reliant® is a registered trademark of Pyramid Technology Corporation.
SINIX is the UNIX® System derivative of Wincor Nixdorf GmbH
UNIX is a registered trademark in the United States and other countries, licensed exclusively through
X/Open Company Limited.
Base: OSF/Motif™, Copyright © Open Software Foundation, Inc.
X Window System™, Copyright © Massachusetts Institute of Technology.
OSF/Motif is a trademark of Open Software Foundation, Inc.
X Window System is a registered trademark of Massachusetts Institute of Technology.
MS-DOS® and Windows® are registered trademarks of Microsoft Corporation in the United States and other
countries.
BLK Cash Messages Extension

BLK Cheque Messages Extension

4 November 2015
Contents

Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

BLK Cash Messages Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Function Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Wincor Nixdorf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Other Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– NCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– DIEBOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Write Command 3 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Write Command 20 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Basic Operational Command Message . . . . . . . . . . . . . . . . . . . . . . . . 3
– Enhanced Function Command Message (ID 7) . . . . . . . . . . . . . . . . . 4
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
– Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
– Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Transaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Exceptions and Reject Reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

BLK Cheque Messages Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Function Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Wincor Nixdorf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Other Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– NCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– DIEBOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Deposit State (C) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Enhanced States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Depositor State (DP ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Image Character Recognition State (IC ) . . . . . . . . . . . . . . . . . . . . . . . . . 3
Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Display Control Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

November 2015 1
 Contents

Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

– Write Command 3 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Function Command Message (ID 4) . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Enhanced Function Command Message (ID 7) . . . . . . . . . . . . . . . . . . 6
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
– Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
– Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
– Transaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Exceptions and Reject Reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 November 2015
BLK Cash Messages Extension

Function Overview
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 document describes following areas:

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

November 2015 1
Supported Hardware BLK Cash Messages Extension

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.

Wincor Nixdorf

• CINEO systems RM3 (Recycling Module 3)

• PC4000 systems RM2 (Recycling Module 2)
• CCDM V1/V2 (Cash Cheque Deposit Module V1/V2)
• CRS systems (old series)

Other Vendors

NCR

• BNA (Bank Note Acceptor)

• SDM (Scalable Deposit Module)
• GBRU (Global Bill Recycling Unit)

DIEBOLD

• ENA (Enhanced Note Acceptor)

• BNA (Bulk Note Acceptor)
• BCR (Bulk Cash Recycler)

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.

2 November 2015
BLK Cash Messages Extension Messages

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 Miscelleaneous Features 4 specifies if expanded MDS status
information of a Bulk Cash Recycler should be reported. This feature is not
supported by ProCash/DDC. For format and field details please refer to
documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

Write Command 20 Message

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

types. For format and field details please refer to documents ProCash/DDC
3.1/00 User Guide and Agilis 91x® XV Terminal Programming Manual.

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.
For format and field details please refer to documents ProCash/DDC 3.1/00 User
Guide and Agilis 91x® XV Terminal Programming Manual

November 2015 3
Messages BLK Cash Messages Extension

Enhanced Function Command Message (ID 7)

The host sends an Enhanced Function Command Message with function data
(CI ) for the Currency acceptor to the terminal. For format and field details
please refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV
Terminal Programming Manual.

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. For format and field description please
refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

Retrieve Enhanced Supply Counts

In response to the Basic Operational Command Message message 1|||;
"Retrieve Enhanced Supply Counts", the terminal sends the supply counters of
the terminal, which includes the cash deposit counters, to the central. For format
and field description please refer to documents ProCash/DDC 3.1/00 User Guide
and Agilis 91x® XV Terminal Programming Manual.

Retrieve Then Set or Clear Enhanced Supply Counts

In response to the Basic Operational Command Message 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. For format and field description please refer to
documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

4 November 2015
BLK Cash Messages Extension Exceptions and Reject Reasons

Enhanced Status (solicited) (Status Descriptor = J)

Currency Acceptor device status solicited messages are sent as Enhanced
Status via four digit Device ID ’CI01’. For format and field description please
refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

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’. For format and field description please
refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

Transaction Request Message

The terminal sends multiple Buffer ID’s with cash deposit data to the central.
For format and field description please refer to documents ProCash/DDC 3.1/00
User Guide and Agilis 91x® XV Terminal Programming Manual.

Exceptions and Reject Reasons

This section desribes the Exceptions and Restrictions of BLK message
processing.
• The BLK message processing does not support coin deposits
• Mixed Media processing of Cheques and notes is not supported

November 2015 5
Terminal Configuration BLK Cash Messages Extension

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/00
Installation & Configuration manual for detailed parameter description.
Table 1: Registry cross link [CCCASHINTRANSACTIONFW]
USER AREA in"CUSTOM.PPF" REGISTRY LOCATION
[CCCASHINTRANSACTIONFW] [HKEY_LOCAL_MACHINE\SOFTWARE\
Wincor Nixdorf\ProTopas\CurrentVersion\LYNXCAIN\
CCCASHINTRANSACTIONFW]
USER NAME REGISTRY PARAMETER
MESSAGE_MODE MESSAGE_MODE

6 November 2015
BLK Cheque Messages Extension

Function Overview
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 document 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

November 2015 1
Supported Hardware BLK Cheque Messages Extension

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

Wincor Nixdorf

• CCDM V1/V2 (Cash Cheque Deposit Module V1/V2) (bundle Cheque)

• SEAC Scanner (single Cheque)
• Reiner Scanner (single Cheque)

Other Vendors

NCR

• CPM (Single Cheque Accept Module)

• BCA (Bunch Cheque Acceptor)
• SDM (Scalable Deposit Module) (bundle Cheque)

DIEBOLD

• IDM4 (Intelligent Deposit Module fourth-generation)

• IDM5 (Intelligent Deposit Module fifth-generation)
• IDM(BD) Bulk Document IDM

2 November 2015
BLK Cheque Messages Extension States

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 there 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 or/and Bundle Cheque deposit processing.

Deposit State (C)

The Deposit State (C) tells the terminal how to process a deposit operation.
For format and field details please refer to document ProCash/DDC 3.1/00 User
Guide and Agilis 91x® XV Terminal Programming Manual.

Enhanced States

Depositor State (DP )

The Deposit State (DP ) can be used for Single and Bulk Cheque deposit
processing. The deposit state data directs the terminal to perform specific
deposit operations. For format and field details please refer to document
ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal Programming
Manual.

Image Character Recognition State (IC )

The Image Character Recognition State (IC ) 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. For format and field details please refer to document
ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal Programming
Manual.

November 2015 3
Screens BLK Cheque Messages Extension

Screens
This section describes just the part how to display Check images on consumer
screens. For more information about screen control sequences and how to
setup consumer screens refer to ProCash/DDC 3.1/00 User Guide and Agilis
91x® XV Terminal Programming Manual.

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 3.1/00 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/00 Installation & Configuration Manual for detailed parameter
descriptions.

4 November 2015
BLK Cheque Messages Extension Messages

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.

Write Command 3 Message

The Write Command 3 message configures terminal parameters and timers.

Bit 5 (value 32) of Miscelleaneous Features 4 specifies if expanded MDS status
information of a Bulk Cash Recycler should be reported. This feature is not
supported by ProCash/DDC. For format and field details please refer to
documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

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)

For format and field details please refer to documents ProCash/DDC 3.1/00 User
Guide and Agilis 91x® XV Terminal Programming Manual.

November 2015 5
Messages BLK Cheque Messages Extension

Enhanced Function Command Message (ID 7)

The host sends an Enhanced Function Command Message with function data
(DP ) for Cheque Deposit processing to the terminal. For format and field details
please refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV
Terminal Programming Manual.

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. For format and field description please
refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

6 November 2015
BLK Cheque Messages Extension Exceptions and Reject Reasons

Enhanced Status (solicited) (Status Descriptor = J)

Cheque Deposit device status solicited messages are sent as Enhanced Status
via four digit Device ID ’DP01’. For format and field description please refer to
documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

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’. For format and field description please
refer to documents ProCash/DDC 3.1/00 User Guide and Agilis 91x® XV Terminal
Programming Manual.

Transaction Request Message

The terminal sends multiple Buffer ID’s with Cheque deposit data to the central.
For format and field description please refer to documents ProCash/DDC 3.1/00
User Guide and Agilis 91x® XV Terminal Programming Manual.

Exceptions and Reject Reasons

This section desribes the Exceptions and Restrictions of BLK Cheque message
processing.
• Mixed Media processing of Cheques and notes is not supported

November 2015 7
Terminal Configuration BLK Cheque Messages Extension

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/00
Installation & Configuration manual for detailed parameter description.
Table 1: Registry cross link [CCCASHINTRANSACTIONFW]
USER AREA in"CUSTOM.PPF" REGISTRY LOCATION
[CCCASHINTRANSACTIONFW] [HKEY_LOCAL_MACHINE\SOFTWARE\
Wincor Nixdorf\ProTopas\CurrentVersion\LYNXCAIN\
CCCASHINTRANSACTIONFW]
USER NAME REGISTRY PARAMETER
MESSAGE_MODE MESSAGE_MODE

8 November 2015
Abbreviations
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

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

DDC Diebold Direct Connect

PC Personal Computer

PPF Parac Parameter File

November 2015 9
Abbreviations

10 November 2015
Tables

Tables
Table 1: Registry cross link [CCCASHINTRANSACTIONFW] . . . . 6

Table 1: Registry cross link [CCCASHINTRANSACTIONFW] . . . . 8

November 2015 1
 Tables

2 November 2015
Related publications

Available manuals

ProCash/DDC manuals
DESIGNATION VERSION ORDER NUMBER
ProCash/DDC User Guide manual 3.1/00 (PDF file)
ProCash/DDC Installation & Configuration 3.1/00 (PDF file)
Wincor Nixdorf NDC/Diebold D91x 1.53 (PDF file)
Message Format Extension for Cash In

ProCash/DDC User Guide manual

Provides detailed function description about ProCash/DDC operation and DDC
Host to terminal and Terminal to Host messages (Download Commands, Trans-
action Request and Reply messages, Terminal Commands, Status messages,
etc.).
ProCash/DDC Installation & Configuration manual
This manuals contains detailed descriptions of configuration parameters of
ProCash/DDC, which are stored in the Windows registry. Further contents are
descriptions about several Utilities which are additionally delivered.
Wincor Nixdorf NDC/Diebold D91x
Message Format Extension for Cash In
Specifies protocol extensions (State tables, messages) for cash in functions
defined by Wincor Nixdorf.

Documents from other Vendors

DESIGNATION VENDOR
Agilis 91x® XV Terminal Programming Manual Diebold

Agilis 91x® XV Terminal Programming Manual

Specifies Diebolds’s DDC message protocol in detail.

November 2015 3
Related publications

4 November 2015