You are on page 1of 36

ProCash/NDC

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.
7 Denominations Extension

BNA Messages Extension


4 November 2015
Contents

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

7 Denominations Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Function Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Wincor Nixdorf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Other Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– Enhanced Configuration Parameters Load . . . . . . . . . . . . . . . . . . . . . 2
– Send Extended Supply Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Transaction Reply Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Transaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Exceptions and Reject Reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

BNA Messages Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1


Function Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Wincor Nixdorf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Other Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– NCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– DIEBOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Cash Accept State (>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Screens of the Cash Accept state (>) . . . . . . . . . . . . . . . . . . . . . . . . . 4
– Note Type configuration for the Cash Accept state (>) . . . . . . . . . . . . 4
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Enhanced Configuration Parameters Load . . . . . . . . . . . . . . . . . . . . . 5
– Send Extended Supply Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
– Report Cash Deposit Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
– Transaction Reply Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

November 2015 1
Contents

– Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
– Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
– Transaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Exceptions and Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

CPM Messages Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1


Function Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Wincor Nixdorf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Other Vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– NCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
– DIEBOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Host To Terminal messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
– Enhanced Configuration Parameters Load . . . . . . . . . . . . . . . . . . . . . 3
– Send Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
– Send Extended Supply Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
– Transaction Reply Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
– Cheque Image printing in host reply . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Terminal To Host messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
– Transaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Exceptions and Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

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

Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 November 2015
7 Denominations Extension

Function Overview
Since release 2.1/20 ProCash/NDC supports NCR’s extended NDC message
protocol, which allows up to 7 dispense denominations. The following sub
sections give detailed instructions about the NDC message format extensions
and parameters which are necessary for the host programmer to integrate
7 denomination support in the NDC network. It will also be described how to
setup ProCash/NDC on the client side for 7 denominations processing.

This document describes following areas:


• Supported hardware systems
• Messages and field extensions
• Parameters and options related to 7 denominations
• Restrictions

Supported Hardware
ProCash/NDC supports 7 denominations on following hardware systems:

Wincor Nixdorf

The major reason for the 7 denomination support in ProCash/NDC was the new
CINEO 4060 (4+4) system. It can be installed with up to 7 denominations where
each denomination can by individually configured as recycle or dispense only
denomination. In general 7 denominations is supported on all single tower
recycle or dispense only systems which can be configured with up to 7 dispense
only or recycle units.
Please refer to the CINEO Operating/Installation manuals for detailed descrip-
tions about cassettes configuration and how notes are moved through the
transport areas and cassettes.

November 2015 1
Messages 7 Denominations Extension

Other Vendors

7 denominations support on NCR, Diebold or other vendors are limited to


systems which have installed a single dispense or recycle tower with up to
7 denominations. Dual towers are currently not supported.

Messages
The following sections describe the NDC host to terminal and terminal to host
messages which are involved if 7 denominations processing is enabled.

Host To Terminal messages

This chapter describes the host to terminal messages and relevant extensions
for the 7 denominations processing.

Enhanced Configuration Parameters Load

The Enhanced Configuration Parameters Load message contains the


parameter options and timers for the terminal. For format and field details
please refer to document ProCash/NDC 3.1/00 User Guide and Aptra Advanced
NDC Reference manual.
7 denomination processing will be enabled via parameter option 76.
The following table describes Option 76 in detail:

Table 1: Option codes

Option Option Description


number code
76 000 4 denomination support (default)
001 7 denomination support enabled for dispenser DIG ’E’. Dispenser DIG ’d’ and ’e’
used by dual towers are not supported in ProCash/NDC

2 November 2015
7 Denominations Extension Messages

Send Extended Supply Counters

The host sends terminal command 1|||4 or 1|||41 "Send Supply Counters" to
retrieve the current supply counters from the terminal. To get the supply
counters of all 7 denominations, the host has to send terminal command 1|||42
"Send Extended Supply Counters".
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

Transaction Reply Command

If parameter Option 76 is enabled (001), Transaction Reply Commands for


dispense operations contain dispense data for 7 denominations. For format and
field details please refer to document ProCash/NDC 3.1/00 User Guide and Aptra
Advanced NDC Reference manual.

Terminal To Host messages

This chapter describes the terminal to host messages and relevant extensions
for the 7 denominations processing.

Solicited Status

Supplies Data
In response to the Terminal Command message 1|||72 "Send Configuration
Information" "Send Supplies Data only" the terminal sends the supplies
information of DIG ’E’ for 7 denominations in the solicited Supplies Data
Response message. For format and field description please refer to document
ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced NDC Reference
manual.
Fitness Data
In response to the Terminal Command message 1|||73 "Send Configuration
Information" "Send Fitness Data only" the terminal sends the fitness
information of DIG ’E’ for 7 denominations in the solicited Fitness Data

November 2015 3
Messages 7 Denominations Extension

Response message. For format and field description please refer to document
ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced NDC Reference
manual.
Extended Supply Counters
In response to the Terminal Command message 1|||42 "Send Supply Counters"
"Send Extended Supply Counters" the terminal sends the supply
counters of field "Cash Handler 0 data group ID ‘C’" for 7 denominations in the
solicited Extended Supply Counters Response message. For format and field
description please refer to document ProCash/NDC 3.1/00 User Guide and NCR’s
Aptra Advanced NDC Reference manual.

4 November 2015
7 Denominations Extension Exceptions and Reject Reasons

Solicited Device Fault Fault status (Cash Dispenser)


If parameter Option 76 is enabled (001) Solicited Device Fault status messages
of the Cash Dispenser (DIG ’E’) contain the number of notes dispensed counts,
status (severity) and supply status for 7 denominations. For format and field
description please refer to document ProCash/NDC 3.1/00 User Guide and NCR’s
Aptra Advanced NDC Reference manual.

Unsolicited Status

Unsolicited Device Fault Fault status (Cash Dispenser)


If parameter Option 76 is enabled (001), Unsolicited Device Fault status
messages of the Cash Dispenser (DIG ’E’) contain the number of notes
dispensed counts, status and supply status for 7 denominations. For format and
field description please refer to document ProCash/NDC 3.1/00 User Guide and
NCR’s Aptra Advanced NDC Reference manual.

Transaction Request Message

If parameter Option 76 is enabled (001), the Last Transaction Status (LTS) will
be included in 7 denomination format for the Transaction Request Message. For
format and field description please refer to document ProCash/NDC 3.1/00 User
Guide and NCR’s Aptra Advanced NDC Reference manual.

Exceptions and Reject Reasons


This section desribes the Reject Reasons and Exceptions related to the 7
denomination support.
• If Option 76 is configured as 000 (4 denomination types) and the host
sends dispense data for more than 4 denomination types in the
transaction reply, a command reject will be sent with reject reason A06
(Illegal dispense or dispense on multiple dispensers).
• Terminal status supply counters (terminal command 1|||4 or 1|||41 with
response 22|||F|2) will report only 4 denomination types, regardless of
parameter 76 setting.

November 2015 5
Terminal Configuration 7 Denominations Extension

• Terminal status enhanced configuration will report only 4 denomination


types, regardless of parameter 76 setting. To retrieve all 7 type counters
the new Extended Supply Counters must be requested via terminal
command 1|||42.
• Extended tamper and sensor status (1|||74 reporting 22|||F|K) will only
report 4 physical cassettes.

Terminal Configuration
The following table lists the local terminal parameters which are involved to
enable 7 denomination processing. Please refer to the ProCash/NDC 3.1/00
Installation & Configuration manual for detailed parameter description.
Table 2: Registry cross link [CASH_DISPENSER]
USER AREA in"CUSTOM.PPF" REGISTRY LOCATION
[CASH_DISPENSER] [HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\
ProTopas\CurrentVersion\LYNXPAR\CASH_DISPENSER]
USER NAME REGISTRY PARAMETER
NUM_LOG_CASS NUM_LOG_CASS
CURRENCY_1 CURRENCY_1
CURRENCY_2 CURRENCY_2
CURRENCY_3 CURRENCY_3
CURRENCY_4 CURRENCY_4
CURRENCY_5 CURRENCY_5
CURRENCY_6 CURRENCY_6
CURRENCY_7 CURRENCY_7
VALUE_1 VALUE_1
VALUE_2 VALUE_2
VALUE_3 VALUE_3
VALUE_4 VALUE_4
VALUE_5 VALUE_5
VALUE_6 VALUE_6
VALUE_7 VALUE_7
NUM_PHYS_NAMES NUM_PHYS_NAMES
PHYS_NAME_X PHYS_NAME_X

6 November 2015
BNA Messages Extension

Function Overview
Since release 3.0/10 ProCash/NDC supports NCR’s extended BNA message
protocol. The BNA message protocol format is used for pure cash deposit
devices and also for cash recycling systems. The following sub sections give
detailed instructions about the NDC message format extensions and
parameters which are necessary for the host programmer to integrate
BNA message support in the NDC network. It will also be described how to
enable BNA message support for ProCash/NDC on the client side.

This document describes following areas:


• Supported hardware systems
• States and Screens (without ProFlex)
• Messages and field extensions
• Parameters and options related to BNA messages
• Restrictions

Supported Hardware
BNA messages are supported on the following pure cash deposit devices and
cash recycling systems which are released by ProCash/NDC.

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)

November 2015 1
Supported Hardware BNA Messages Extension

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)

2 November 2015
BNA Messages Extension States

States
Cash Deposit transactions will be performed through the Cash Accept State (>).

Cash Accept State (>)

The Cash Accept State (>) consists of 10 single step operations:


1. Activates and de-activates acceptable note types according to
the state parameters
2. Accepts a single note or a bunch of notes depending on the device type
3. Identifies the notes.
4. Checks the note type and denomination are active.
5. Returns invalid or inactive notes to the consumer.
6. Processes any notes identified as category 3 (suspect) or category 2
(counterfeit).
7. If refundable deposit is configured, refunds notes if there are more notes
than the escrow capacity or the consumer chooses a refund of any good
notes in the escrow (Rollback on consumer cancel).
8. If the cash acceptor has retract capabilities and retract is enabled,
retracts returned notes that have not been taken within the time specified
by the retract timer.
9. When extended journaling is enabled with journal level 3 set, journals
each consumer interaction, including time-outs.
10. On a single note acceptor, for each processed note, journals the
cumulative counts and sends an unsolicited status message with the
same details. On bunch note acceptors, does the same for each
processed bunch of notes
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

November 2015 3
States BNA Messages Extension

Screens of the Cash Accept state (>)

During the Cash Accept State (>) processing it will be displayed different kinds
of screens. The type of screen depends on the kind of operation and device
state.
• "Please Enter Notes Screen"
• "Please Remove Notes Screen"
• "Confirmation Screen"
• "Hardware Error or Jam Screen"
• "Escrow Full Screen" (not supported)
• "Processing Notes Screen"
• "Please Wait Screen"

Note:
To display amount, currency and notes on the Confirmation Screen, local
configured screens can be nested via insert screen control sequences for
amount, currency and note value display.

Refer to ProCash/NDC 3.1/00 Installation & Configuration document for local


screen configuration.

Note Type configuration for the Cash Accept state (>)

The Cash Accept State (>) uses parameter NOTE_ID_LIST with index 999 for
the note type definition.
Example:
NOTE_ID_LIST_999 = "01:USD:10,02:USD:20"
Refer to ProCashIn/Online 3.1/00 Installation & Configuration document for
detailed description of parameter NOTE_ID_LIST_XXX.

4 November 2015
BNA Messages Extension Messages

Messages
The following sections describe the NDC host to terminal and terminal to host
messages which are involved if BNA message processing is enabled.

Host To Terminal messages

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

Enhanced Configuration Parameters Load

The Enhanced Configuration Parameters Load message contains the


parameter options and timers for the terminal. For format and field details
please refer to document ProCash/NDC 3.1/00 User Guide and Aptra Advanced
NDC Reference manual.
BNA message options are configurable via parameter Option 44 and 45.
The following table describes the supported options in detail:

Table 1: Option 44: BNA Journal Notes Count

Option Option Description


number code
44 000-003 not supported

Table 2: Option 45: BNA Settings

Option Bit Description


number number
45 0 (001) Include BNA last transaction status counts in the Transaction Request message
0 - Do not include transaction status counts
1 - Include transaction status counts
1 (002) Number of notes to accept. This must be set if bit 3 or bit 6 is set or if direct
deposit is configured
0 - Accept up to 90 notes
1 - Accept more than 90 notes
Note: For Recycle systems, you must set the number of notes that can be
accepted to more than 90 (Enhanced Configuration option 45).
2 (004) Retract option configuration
0 - Do not retract notes
1 - Retract note

November 2015 5
Messages BNA Messages Extension

3 (008) 3 Extended message format option. Bit 1 must be set if this is set.
This must be set if bit 6 is set. Bit 4 is ignored if this is set
0 - Do not use extended message format
1 - Use extended message format
For details of the affected messages, see details in chapters:
• Supplies Data
• Fitness Data
• Extended Send Supply Counters
• Note Acceptor (Solicited/Unsolicited)
4 (016) Supplies reporting when bit 3 is not set. Bit 3 must not be set if this is set.
0 - Report when first cassette is full or almost full
1 - Report when all cash-in cassettes are full
Whichever value is used, a retract bin is reported when full
or almost full.
5 (032) Enhanced Cash Deposit Mode
Not supported by ProCash/NDC
6 (064) 6 Recycling option configuration. Bit 3 must be set if this is set.
Value 0:
• Do not use recycling cassettes during deposit transactions
• Do not report NDC cassettes types that have accepted notes during the last
deposit
Value 1:
• Use recycling cassettes during deposit transactions
• Report NDC cassette types that have accepted notes during the last
deposit

Send Extended Supply Counters

The host sends terminal command 1|||4 or 1|||41 "Send Supply Counters" to
retrieve the current basic BNA supply counters of refunded, rejected, encashed
and escrowed notes from the terminal. To get extended BNA supply counters
like note type based counters and fraud notes or suspected notes (if ECB6
enabled), the host has to send terminal command 1|||42 "Send Extended
Supply Counters".
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

Report Cash Deposit Definition

The host sends terminal command 1|||78 "Report Cash Deposit Definition" to
retrieve the Note Types configuration for the assigned currencies from the
terminal.
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

6 November 2015
BNA Messages Extension Messages

Transaction Reply Command

The BNA message protocol provides 3 FID’s in Transaction Reply Commands:


• ’*’ Refund and print
• ’-’ Deposit and print
• ’’’ Deposit and wait
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

November 2015 7
Messages BNA Messages Extension

Terminal To Host messages

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

Solicited Status

Supplies Data
In response to the Terminal Command message 1|||72 "Send Configuration
Information" "Send Supplies Data only" the terminal sends the Cash Acceptor
Supplies information as DIG ’w’ in the solicited Supplies Data Response
message. For format and field description please refer to document
ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced NDC Reference
manual.
Fitness Data
In response to the Terminal Command message 1|||73 "Send Configuration
Information" "Send Fitness Data only" the terminal sends the Cash Acceptor
fitness information as DIG ’w’ in the solicited Fitness Data Response message.
For format and field description please refer to document ProCash/NDC 3.1/00
User Guide and NCR’s Aptra Advanced NDC Reference manual.
Extended Supply Counters
In response to the Terminal Command message 1|||42 "Send Extended Supply
Counters" the terminal sends the Cash Acceptor supply counters in multiple
group ID’s (ID ’I’, ID ’K’, ID ’N’, ID ’O’) in the solicited Extended Supply Counters
Response message. For format and field description please refer to document
ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced NDC Reference
manual.

8 November 2015
BNA Messages Extension Messages

Solicited Device Fault Fault status (Note Acceptor)


Solicited Device Fault status messages of the Note Acceptor (DIG ’w’) are sent
in error conditions in response to the following Transaction Reply command
messages:
• Refund Cash Deposit
• Deposit Cash
• Deposit Cash and Wait
For format and field description please refer to document ProCash/NDC 3.1/00
User Guide and NCR’s Aptra Advanced NDC Reference manual.

Unsolicited Status

Unsolicited Device Fault Fault status (Note Acceptor)


Unsolicited Device Fault status messages of the Note Acceptor (DIG ’w’) are
sent if a device error occurs during the cash deposit transaction or as status
update to inform the central about note types which has been identified. For
format and field description please refer to document ProCash/NDC 3.1/00 User
Guide and NCR’s Aptra Advanced NDC Reference manual.

Transaction Request Message

If BNA message processing is enabled, the Last Transaction Status (LTS) with
BNA or GBRU status fields about the last cash deposit transaction will be
appended in the Transaction Request Message. For format and field description
please refer to document ProCash/NDC 3.1/00 User Guide and NCR’s Aptra
Advanced NDC Reference manual.

November 2015 9
Exceptions and Restrictions BNA Messages Extension

Exceptions and Restrictions


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

Terminal Configuration
The following table lists the local terminal parameters which are involved to
enable BNA message processing. Please refer to the ProCash/NDC 3.1/00
Installation & Configuration manual for detailed parameter description.
Table 3: 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

10 November 2015
CPM Messages Extension

Function Overview
Since release 3.0/10 ProCash/NDC supports NCR’s extended CPM message
protocol for Cheque processing. The CPM message protocol format is used for
single Cheque devices and also for bundle Cheque devices. The following sub
sections give detailed instructions about the NDC message format extensions
and parameters which are necessary for the host programmer to integrate
CPM message support in the NDC network. It will also be described how to
enable CPM message support for ProCash/NDC on the client side.

This document describes following areas:


• Supported hardware systems
• Messages and field extensions
• Parameters and options related to CPM messages
• Restrictions

Supported Hardware
CPM messages are supported on the following Cheque deposit devices which
are released by ProCash/NDC.

Wincor Nixdorf

• CCDM V1/V2 for single and bundle Cheque processing


• SEAC scanner for single Cheque processing
• REINER scanner for single Cheque processing

November 2015 1
Supported Hardware CPM Messages Extension

Other Vendors

NCR

• CPM (Cheque Processing Module) for single Cheque processing


• SCPM (Scalable Cheque Module) for single and bundle Cheque
processing
• SDM (Scalable Deposit Module) for single and bundle Cheque and
Mixed Media processing

DIEBOLD

• IDM 4 (Intelligent Depository Module 4) for single Cheque processing


• IDM 5 (Intelligent Depository Module 5) for single Cheque processing
• IDMBD (Intelligent Depositor Module - Bulk Document) for bundle
Cheque processing

2 November 2015
CPM Messages Extension Messages

Messages
The following sections describe the NDC host to terminal and terminal to host
messages which are involved if CPM message processing is enabled.

Host To Terminal messages

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

Enhanced Configuration Parameters Load

The Enhanced Configuration Parameters Load message contains the


parameter options and timers for the terminal. For format and field details
please refer to document ProCash/NDC 3.1/00 User Guide and Aptra Advanced
NDC Reference manual.
CPM message options are configurable via parameter Option 83.
The following table describes the supported options in detail:

Table 1: Option 83: CPM Settings

Option Bit Description


number number
83 0 (001) Cheque processor supports the reporting of three bins using NDC+ compatible
message formats (default)
1 (002) Cheque processor supports the reporting of all bins that are present, using the
extended message format. At least three bins are reported for a cheque
processor. The number of bins reported depends on the hardware
configuration.
2 (004) On bunch cheque acceptors only, in addition to the information reported by Bit
number 1, the device status message also includes the location of the deposited
cheques
3 (008) Scans cheques after endorsement when supported by the hardware.
The back of the cheque is scanned If a rear image was requested when the
cheque was accepted, the image from the scan after endorsement replaces this
image. If the cheque is not endorsed, the image is not scanned.
(not supported by ProCash/NDC)

November 2015 3
Messages CPM Messages Extension

Send Configuration Information

The host sends terminal command 1|||7 or 1|||71 "Send Configuration


Information" to retrieve the hardware configuration of the Cheque deposit
module.

Send Extended Supply Counters

The host sends terminal command 1|||4 or 1|||41 "Send Supply Counters" to
retrieve the current basic CPM supply counters from the terminal. To get
extended CPM supply counters, the host has to send terminal command 1|||42
"Send Extended Supply Counters".
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

Transaction Reply Command

The CPM message protocol provides 2 FID’s in Transaction Reply Commands:


• ’:’ Process a Cheque
• ’c’ Process multiple Cheques
For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.

Cheque Image printing in host reply

Cheque Images can be printed via printer control sequence ESC p.


For format and field details please refer to document ProCash/NDC 3.1/00 User
Guide and Aptra Advanced NDC Reference manual.
For required local parameter configuration of ESC_x please refer to
ProCash/NDC 3.1/00 Installation & Configuration manual.

4 November 2015
CPM Messages Extension Messages

Terminal To Host messages

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

Solicited Status

Hardware Configuration
In response to the Terminal Command message 1|||7 or 1|||7 "Send Configu-
ration Information" the terminal sends the Cheque module hardware information
as DIG ’q’ in the solicited Hardware Configuration Data Response message. For
format and field description please refer to document ProCash/NDC 3.1/00 User
Guide and NCR’s Aptra Advanced NDC Reference manual.
Supplies Data
In response to the Terminal Command message 1|||72 "Send Configuration
Information" "Send Supplies Data only" the terminal sends the Cash Acceptor
Supplies information as DIG ’q’ in the solicited Supplies Data Response
message. For format and field description please refer to document
ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced NDC Reference
manual.
Fitness Data
In response to the Terminal Command message 1|||73 "Send Configuration
Information" "Send Fitness Data only" the terminal sends the Cash Acceptor
fitness information as DIG ’q’ in the solicited Fitness Data Response message.
For format and field description please refer to document ProCash/NDC 3.1/00
User Guide and NCR’s Aptra Advanced NDC Reference manual.
Extended Supply Counters
In response to the Terminal Command message 1|||42 "Send Extended Supply
Counters" the terminal sends the supply counters of the Cheque deposit
module with Group ID ’J’ in the solicited Extended Supply Counters Response
message. For format and field description please refer to document
ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced NDC Reference
manual.

November 2015 5
Messages CPM Messages Extension

Solicited Device Fault Fault status (Cheque Processor)


Solicited Device Fault status messages of the Cheque Processor (DIG ’q’) are
sent in error conditions in response to the following Transaction Reply
command messages:
• Deposit Cheque
• Deposit Cheque Bundle
For format and field description please refer to document ProCash/NDC 3.1/00
User Guide and NCR’s Aptra Advanced NDC Reference manual.

Unsolicited Status

Unsolicited Device Fault Fault status (Cheque Processor)


Unsolicited Device Fault status messages of the Note Acceptor (DIG ’q’) are
sent if a device error occurs during the Cheque deposit transaction. For format
and field description please refer to document ProCash/NDC 3.1/00 User Guide
and NCR’s Aptra Advanced NDC Reference manual.

Transaction Request Message

If CPM message processing is enabled, the Last Transaction Status (LTS) with
CPM status fields about the last Cheque deposit transaction will be appended
in the Transaction Request Message. For format and field description please
refer to document ProCash/NDC 3.1/00 User Guide and NCR’s Aptra Advanced
NDC Reference manual.

6 November 2015
CPM Messages Extension Exceptions and Restrictions

Exceptions and Restrictions


This section desribes the Exceptions and Restrictions of CPM message
processing.
• CPM message processing is supported with ProFlex only
• Mixed Media processing of Cheques and notes is not supported

Terminal Configuration
The following table lists the local terminal parameters which are involved to
enable CPM message processing. Please refer to the ProCash/NDC 3.1/00
Installation & Configuration manual for detailed parameter description.
Table 2: Registry cross link [CCCASHINTRANSACTIONFW]
USER AREA in"CUSTOM.PPF" REGISTRY LOCATION
[CHEQUE_IN] [HKEY_LOCAL_MACHINE\SOFTWARE\
Wincor Nixdorf\ProTopas\CurrentVersion\LYNXPAR\
CHEQUE_IN]
USER NAME REGISTRY PARAMETER
MESSAGE_MODE MESSAGE_MODE

November 2015 7
Terminal Configuration CPM Messages Extension

8 November 2015
Tables

Tables
Table 1: Option codes . . . . . . . . . . . . . . . . . . . . . . . . . 2

Table 2: Registry cross link [CASH_DISPENSER] . . . . . . . . . . 6

Table 1: Option 44: BNA Journal Notes Count . . . . . . . . . . . . 5


Table 2: Option 45: BNA Settings . . . . . . . . . . . . . . . . . . . 5

Table 3: Registry cross link [CCCASHINTRANSACTIONFW] . . . . 10

Table 1: Option 83: CPM Settings . . . . . . . . . . . . . . . . . . . 3


Table 2: Registry cross link [CCCASHINTRANSACTIONFW] . . . . 7

November 2015 1
Tables

2 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

NDC NCR Direct Connect

PC Personal Computer

PPF Parac Parameter File

November 2015 3
Abbreviations

4 November 2015
Related publications

Available manuals

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

ProCash/NDC User Guide manual


Provides detailed function description about ProCash/NDC operation and NDC
Host to terminal and Terminal to Host messages (Download Commands, Trans-
action Request and Reply messages, Terminal Commands, Status messages,
etc.).
ProCash/NDC Installation & Configuration manual
This manuals contains detailed descriptions of configuration parameters of
ProCash/NDC, 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
Aptra Advanced NDC Reference manual NCR

Aptra Advanced NDC Reference manual


Specifies NCR’s NDC message protocol in detail.

November 2015 5
Related publications

6 November 2015

You might also like