Professional Documents
Culture Documents
NDC V3100 ExtensionGuide en
NDC V3100 ExtensionGuide en
V3.1/00
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
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
November 2015 1
Contents
– Solicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
– Unsolicited Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
– Transaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Exceptions and Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
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.
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
Messages
The following sections describe the NDC host to terminal and terminal to host
messages which are involved if 7 denominations processing is enabled.
This chapter describes the host to terminal messages and relevant extensions
for the 7 denominations processing.
2 November 2015
7 Denominations Extension Messages
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.
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
Unsolicited Status
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.
November 2015 5
Terminal Configuration 7 Denominations Extension
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.
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
November 2015 1
Supported Hardware BNA Messages Extension
Other Vendors
NCR
DIEBOLD
2 November 2015
BNA Messages Extension States
States
Cash Deposit transactions will be performed through the Cash Accept State (>).
November 2015 3
States BNA Messages Extension
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.
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.
This chapter describes the host to terminal messages and relevant extensions
for the BNA message processing.
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
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.
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
November 2015 7
Messages BNA Messages Extension
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
Unsolicited Status
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
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.
Supported Hardware
CPM messages are supported on the following Cheque deposit devices which
are released by ProCash/NDC.
Wincor Nixdorf
November 2015 1
Supported Hardware CPM Messages Extension
Other Vendors
NCR
DIEBOLD
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.
This chapter describes the host to terminal messages and relevant extensions
for the CPM message processing.
November 2015 3
Messages CPM Messages Extension
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.
4 November 2015
CPM Messages Extension 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
Unsolicited Status
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
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
November 2015 1
Tables
2 November 2015
Abbreviations
API Application Program Interface
CI Customization Image
ID IDentification
PC Personal Computer
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
November 2015 5
Related publications
6 November 2015