SIST-TP CWA 16926-74:2023

SLOVENSKI STANDARD
SIST CWA 16926-74:2023
01-april-2023
Specifikacija vmesnika razširitev za finančne storitve (XFS), izdaja 3.50 - 74. del:
Razred vmesnika naprave modula za unovčevanje - Referenca za programerje -
Prehod z različice 3.40 (CWA 16926:2020) na različico 3.50 (ta CWA)
Extensions for Financial Services (XFS) interface specification Release 3.50 - Part 74:
Cash-In Module Device Class Interface - Programmer's Reference - Migration from
Version 3.40 (CWA 16926:2020) to Version 3.50 (this CWA)
Ta slovenski standard je istoveten z: CWA 16926-74:2023
ICS:
35.200 Vmesniška in povezovalna Interface and interconnection
oprema equipment
35.240.15 Identifikacijske kartice. Čipne Identification cards. Chip
kartice. Biometrija cards. Biometrics
35.240.40 Uporabniške rešitve IT v IT applications in banking
bančništvu
SIST CWA 16926-74:2023 en,fr,de
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

SIST CWA 16926-74:2023
SIST CWA 16926-74:2023
CEN
CWA 16926-74
WORKSHOP
January 2023
AGREEMENT
ICS 35.200; 35.240.40; 35.240.15
English version
Extensions for Financial Services (XFS) interface
specification Release 3.50 - Part 74: Cash-In Module
Device Class Interface - Programmer's Reference -
Migration from Version 3.40 (CWA 16926:2020) to
Version 3.50 (this CWA)
This CEN Workshop Agreement has been drafted and approved by a Workshop of representatives of interested parties, the
constitution of which is indicated in the foreword of this Workshop Agreement.

The formal process followed by the Workshop in the development of this Workshop Agreement has been endorsed by the
National Members of CEN but neither the National Members of CEN nor the CEN-CENELEC Management Centre can be held
accountable for the technical content of this CEN Workshop Agreement or possible conflicts with standards or legislation.

This CEN Workshop Agreement can in no way be held as being an official standard developed by CEN and its Members.

This CEN Workshop Agreement is publicly available as a reference document from the CEN Members National Standard Bodies.

CEN members are the national standards bodies of Austria, Belgium, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Finland, France,
Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Republic of North
Macedonia, Romania, Serbia, Slovakia, Slovenia, Spain, Sweden, Switzerland, Türkiye and United Kingdom.

EUROPEAN COMMITTEE FOR STANDARDIZATION
COMITÉ EUROPÉEN DE NORMALISATION

EUROPÄISCHES KOMITEE FÜR NORMUNG

CEN-CENELEC Management Centre: Rue de la Science 23, B-1040 Brussels
© 2023 CEN All rights of exploitation in any form and by any means reserved worldwide for CEN national Members.

Ref. No.:CWA 16926-74:2023 E
SIST CWA 16926-74:2023
Table of Contents
European Foreword . 6
1. Introduction . 10
1.1 Background to Release 3.50 . 10
1.2 XFS Service-Specific Programming . 10
2. Cash-In Module . 12
3. References . 13
4. Note Classification . 14
5. Info Commands . 15
5.1 WFS_INF_CIM_STATUS . 15
5.2 WFS_INF_CIM_CAPABILITIES . 21
5.3 WFS_INF_CIM_CASH_UNIT_INFO . 28
5.4 WFS_INF_CIM_TELLER_INFO . 38
5.5 WFS_INF_CIM_CURRENCY_EXP . 40
5.6 WFS_INF_CIM_BANKNOTE_TYPES . 41
5.7 WFS_INF_CIM_CASH_IN_STATUS . 42
5.8 WFS_INF_CIM_GET_P6_INFO . 44
5.9 WFS_INF_CIM_GET_P6_SIGNATURE. 45
5.10 WFS_INF_CIM_GET_ITEM_INFO . 47
5.11 WFS_INF_CIM_POSITION_CAPABILITIES . 49
5.12 WFS_INF_CIM_REPLENISH_TARGET . 51
5.13 WFS_INF_CIM_DEVICELOCK_STATUS. 52
5.14 WFS_INF_CIM_CASH_UNIT_CAPABILITIES . 53
5.15 WFS_INF_CIM_DEPLETE_SOURCE. 55
5.16 WFS_INF_CIM_GET_ALL_ITEMS_INFO. 56
5.17 WFS_INF_CIM_GET_BLACKLIST . 60
5.18 WFS_INF_CIM_GET_CLASSIFICATION_LIST . 61
5.19 WFS_INF_CIM_CASH_UNIT_COUNT_STATUS . 63
5.20 WFS_INF_CIM_PRESENT_STATUS . 65
6. Execute Commands . 67
6.1 WFS_CMD_CIM_CASH_IN_START . 67
6.2 WFS_CMD_CIM_CASH_IN . 69
6.3 WFS_CMD_CIM_CASH_IN_END . 72
6.4 WFS_CMD_CIM_CASH_IN_ROLLBACK . 74
6.5 WFS_CMD_CIM_RETRACT . 76
6.6 WFS_CMD_CIM_OPEN_SHUTTER . 79
6.7 WFS_CMD_CIM_CLOSE_SHUTTER . 81
SIST CWA 16926-74:2023
6.8 WFS_CMD_CIM_SET_TELLER_INFO. 82
6.9 WFS_CMD_CIM_SET_CASH_UNIT_INFO . 83
6.10 WFS_CMD_CIM_START_EXCHANGE . 85
6.11 WFS_CMD_CIM_END_EXCHANGE . 88
6.12 WFS_CMD_CIM_OPEN_SAFE_DOOR. 89
6.13 WFS_CMD_CIM_RESET . 90
6.14 WFS_CMD_CIM_CONFIGURE_CASH_IN_UNITS . 92
6.15 WFS_CMD_CIM_CONFIGURE_NOTETYPES . 94
6.16 WFS_CMD_CIM_CREATE_P6_SIGNATURE . 95
6.17 WFS_CMD_CIM_SET_GUIDANCE_LIGHT . 98
6.18 WFS_CMD_CIM_CONFIGURE_NOTE_READER . 100
6.19 WFS_CMD_CIM_COMPARE_P6_SIGNATURE . 101
6.20 WFS_CMD_CIM_POWER_SAVE_CONTROL . 103
6.21 WFS_CMD_CIM_REPLENISH . 104
6.22 WFS_CMD_CIM_SET_CASH_IN_LIMIT . 107
6.23 WFS_CMD_CIM_CASH_UNIT_COUNT . 110
6.24 WFS_CMD_CIM_DEVICE_LOCK_CONTROL . 112
6.25 WFS_CMD_CIM_SET_MODE . 115
6.26 WFS_CMD_CIM_PRESENT_MEDIA . 116
6.27 WFS_CMD_CIM_DEPLETE . 118
6.28 WFS_CMD_CIM_SET_BLACKLIST . 121
6.29 WFS_CMD_CIM_SYNCHRONIZE_COMMAND . 122
6.30 WFS_CMD_CIM_SET_CLASSIFICATION_LIST . 123
6.31 WFS_CMD_CIM_PREPARE_PRESENT . 124
7. Events . 125
7.1 WFS_SRVE_CIM_SAFEDOOROPEN . 125
7.2 WFS_SRVE_CIM_SAFEDOORCLOSED . 126
7.3 WFS_USRE_CIM_CASHUNITTHRESHOLD . 127
7.4 WFS_SRVE_CIM_CASHUNITINFOCHANGED . 128
7.5 WFS_SRVE_CIM_TELLERINFOCHANGED . 129
7.6 WFS_EXEE_CIM_CASHUNITERROR . 130
7.7 WFS_SRVE_CIM_ITEMSTAKEN . 131
7.8 WFS_SRVE_CIM_COUNTS_CHANGED . 132
7.9 WFS_EXEE_CIM_INPUTREFUSE . 133
7.10 WFS_SRVE_CIM_ITEMSPRESENTED. 134
7.11 WFS_SRVE_CIM_ITEMSINSERTED . 135
7.12 WFS_EXEE_CIM_NOTEERROR . 136
7.13 WFS_EXEE_CIM_SUBCASHIN . 137
7.14 WFS_SRVE_CIM_MEDIADETECTED . 138
7.15 WFS_EXEE_CIM_INPUT_P6 . 139
7.16 WFS_EXEE_CIM_INFO_AVAILABLE. 140
SIST CWA 16926-74:2023
7.17 WFS_EXEE_CIM_INSERTITEMS . 141
7.18 WFS_SRVE_CIM_DEVICEPOSITION . 142
7.19 WFS_SRVE_CIM_POWER_SAVE_CHANGE . 143
7.20 WFS_EXEE_CIM_INCOMPLETEREPLENISH . 144
7.21 WFS_EXEE_CIM_INCOMPLETEDEPLETE . 145
7.22 WFS_SRVE_CIM_SHUTTERSTATUSCHANGED . 146
7.23 WFS_SRVE_CIM_COUNTACCURACYCHANGED . 147
8. ATM Cash-In Transaction Flow - Application Guidelines . 148
8.1 OK Transaction (Explicit Shutter Control) . 149
8.2 Cancellation by Customer (Explicit Shutter Control) . 150
8.3 Stacker Becomes Full (Explicit Shutter Control) . 151
8.4 Bill Recognition Error (Explicit Shutter Control) . 153
8.5 OK Transaction (Explicit Shutter Control) - Level 2 and 3 Note classification Supported
8.6 Multiple Bunches Returned During WFS_CMD_CIM_CASH_IN Refused Notes (Explicit
Shutter Control) . 155
8.7 Multiple Bunches Returned During WFS_CMD_CIM_CASH_IN_ROLLBACK (Explicit
Shutter Control) . 157
8.8 OK Transaction (Implicit Shutter Control) . 159
8.9 Customer Initiates Returning Of Previously Recognized Items (Implicit Shutter Control)
8.10 OK Transaction - (Implicit Shutter Control and WFS_EXEE_CIM_SUBCASHIN event
supported) . 161
8.11 Multiple Bunches Returned During WFS_CMD_CIM_CASH_IN (Implicit Shutter Control
and Implicit Present Control) . 162
8.12 Multiple Bunches Returned During WFS_CMD_CIM_CASH_IN_ROLLBACK (Implicit
Shutter Control and Implicit Present Control). 164
8.13 Retracting Items When Multiple Bunches Are Returned During WFS_CMD_CIM_CASH_IN
(Implicit Shutter Control and Implicit Present Control) . 166
8.14 Bill Recognition Error (WFS_CMD_CIM_PRESENT_MEDIA Command Supported) . 167
8.15 Cancellation by Customer (Implicit Shutter Control and
WFS_CMD_CIM_PRESENT_MEDIA Command Supported) . 168
8.16 Multiple Bunch Timeout Handling . 169
8.16.1 No Items Inserted . 169
8.16.2 First Bunch Not Taken . 169
8.16.3 Last Bunch Taken . 170
8.17 Exchange using DEPOSITINTO (Implicit Shutter Control) . 172
8.18 Multiple Bunches Returned During WFS_CMD_CIM_CASH_IN Refused Notes (using
WFS_CMD_CIM_PREPARE_PRESENT) . 174
8.19 Multiple Bunches Returned During WFS_CMD_CIM_CASH_IN_ROLLBACK (using
WFS_CMD_CIM_PREPARE_PRESENT) . 176
9. ATM Mixed Media Transaction Flow – Application Guidelines. 178
9.1 Mixed Media OK Transaction . 180
9.2 Mixed Media Cancellation by Customer . 182
9.3 Mixed Media Cancellation by Customer on Cash Part Only . 183
SIST CWA 16926-74:2023
9.4 Mixed Media Multiple Refused Items . 184
10. Rules for Cash Unit Exchange . 186
11. Events Associated with Cash Unit Status Changes . 189
11.1 One Physical Cash Unit Goes HIGH. 189
11.2 Last Physical Cash Unit Goes HIGH . 190
11.3 One Physical Cash Unit Goes INOP . 191
11.4 Last Physical Cash Unit Goes FULL . 192
12. C - Header file . 193
SIST CWA 16926-74:2023
European Foreword
This CEN Workshop Agreement has been developed in accordance with the CEN-CENELEC Guide 29
“CEN/CENELEC Workshop Agreements – The way to rapid consensus” and with the relevant provisions of
CEN/CENELEC Internal Regulations - Part 2. It was approved by a Workshop of representatives of interested
parties on 2022-11-08, the constitution of which was supported by CEN following several public calls for
participation, the first of which was made on 1998-06-24. However, this CEN Workshop Agreement does not
necessarily include all relevant stakeholders.
The final text of this CEN Workshop Agreement was provided to CEN for publication on 2022-11-18.
The following organizations and individuals developed and approved this CEN Workshop Agreement:

• AURIGA SPA
• CIMA SPA
• DIEBOLD NIXDORF SYSTEMS GMBH
• FIS BANKING SOLUTIONS UK LTD (OTS)
• FUJITSU TECHNOLOGY SOLUTIONS
• GLORY LTD
• GRG BANKING EQUIPMENT HK CO LTD
• HITACHI CHANNEL SOLUTIONS CORP
• HYOSUNG TNS INC
• JIANGSU GUOGUANG ELECTRONIC INFORMATION TECHNOLOGY
• KAL
• KEBA HANDOVER AUTOMATION GMBH
• NCR FSG
• NEXUS SOFTWARE
• OBERTHUR CASH PROTECTION
• OKI ELECTRIC INDUSTRY SHENZHEN
• SALZBURGER BANKEN SOFTWARE
• SECURE INNOVATION
• SIGMA SPA
It is possible that some elements of this CEN/CWA may be subject to patent rights. The CEN-CENELEC policy on
patent rights is set out in CEN-CENELEC Guide 8 “Guidelines for Implementation of the Common IPR Policy on
Patents (and other statutory intellectual property rights based on inventions)”. CEN shall not be held responsible for
identifying any or all such patent rights.
The Workshop participants have made every effort to ensure the reliability and accuracy of the technical and non-
technical content of CWA 16926-15, but this does not guarantee, either explicitly or implicitly, its correctness.
Users of CWA 16926-15 should be aware that neither the Workshop participants, nor CEN can be held liable for
damages or losses of any kind whatsoever which may arise from its application. Users of CWA 16926-15 do so on
their own responsibility and at their own risk.
The CWA is published as a multi-part document, consisting of:
SIST CWA 16926-74:2023
Part 1: Application Programming Interface (API) - Service Provider Interface (SPI) - Programmer's Reference
Part 2: Service Classes Definition - Programmer's Reference
Part 3: Printer and Scanning Device Class Interface - Programmer's Reference
Part 4: Identification Card Device Class Interface - Programmer's Reference
Part 5: Cash Dispenser Device Class Interface - Programmer's Reference
Part 6: PIN Keypad Device Class Interface - Programmer's Reference
Part 7: Check Reader/Scanner Device Class Interface - Programmer's Reference
Part 8: Depository Device Class Interface - Programmer's Reference
Part 9: Text Terminal Unit Device Class Interface - Programmer's Reference
Part 10: Sensors and Indicators Unit Device Class Interface - Programmer's Reference
Part 11: Vendor Dependent Mode Device Class Interface - Programmer's Reference
Part 12: Camera Device Class Interface - Programmer's Reference
Part 13: Alarm Device Class Interface - Programmer's Reference
Part 14: Card Embossing Unit Device Class Interface - Programmer's Reference
Part 15: Cash-In Module Device Class Interface - Programmer's Reference
Part 16: Card Dispenser Device Class Interface - Programmer's Reference
Part 17: Barcode Reader Device Class Interface - Programmer's Reference
Part 18: Item Processing Module Device Class Interface - Programmer's Reference
Part 19: Biometrics Device Class Interface - Programmer's Reference
Parts 20 - 28: Reserved for future use.
Parts 29 through 47 constitute an optional addendum to this CWA. They define the integration between the SNMP
standard and the set of status and statistical information exported by the Service Providers.
Part 29: XFS MIB Architecture and SNMP Extensions - Programmer’s Reference
Part 30: XFS MIB Device Specific Definitions - Printer Device Class
Part 31: XFS MIB Device Specific Definitions - Identification Card Device Class
Part 32: XFS MIB Device Specific Definitions - Cash Dispenser Device Class
Part 33: XFS MIB Device Specific Definitions - PIN Keypad Device Class
Part 34: XFS MIB Device Specific Definitions - Check Reader/Scanner Device Class
Part 35: XFS MIB Device Specific Definitions - Depository Device Class
Part 36: XFS MIB Device Specific Definitions - Text Terminal Unit Device Class
Part 37: XFS MIB Device Specific Definitions - Sensors and Indicators Unit Device Class
Part 38: XFS MIB Device Specific Definitions - Camera Device Class
Part 39: XFS MIB Device Specific Definitions - Alarm Device Class
Part 40: XFS MIB Device Specific Definitions - Card Embossing Unit Class
Part 41: XFS MIB Device Specific Definitions - Cash-In Module Device Class
Part 42: Reserved for future use.
Part 43: XFS MIB Device Specific Definitions - Vendor Dependent Mode Device Class
Part 44: XFS MIB Application Management
Part 45: XFS MIB Device Specific Definitions - Card Dispenser Device Class
Part 46: XFS MIB Device Specific Definitions - Barcode Reader Device Class
Part 47: XFS MIB Device Specific Definitions - Item Processing Module Device Class
SIST CWA 16926-74:2023
Part 48: XFS MIB Device Specific Definitions - Biometrics Device Class
Parts 49 - 60 are reserved for future use.
Part 61: Application Programming Interface (API) - Migration from Version 3.40 (CWA 16296:2020) to Version
3.50 (this CWA) - Service Provider Interface (SPI) - Programmer's Reference
Part 62: Printer and Scanning Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version
3.50 (this CWA) - Programmer's Reference
Part 63: Identification Card Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version
3.50 (this CWA) - Programmer's Reference
Part 64: Cash Dispenser Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50
(this CWA) - Programmer's Reference
Part 65: PIN Keypad Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50 (this
CWA) - Programmer's Reference
Part 66: Check Reader/Scanner Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version
3.50 (this CWA) - Programmer's Reference
Part 67: Depository Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50 (this
CWA) - Programmer's Reference
Part 68: Text Terminal Unit Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version
3.50 (this CWA) - Programmer's Reference
Part 69: Sensors and Indicators Unit Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to
Version 3.50 (this CWA) - Programmer's Reference
Part 70: Vendor Dependent Mode Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to
Version 3.50 (this CWA) - Programmer's Reference
Part 71: Camera Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50 (this
CWA) - Programmer's Reference
Part 72: Alarm Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50 (this CWA)
- Programmer's Reference
Part 73: Card Embossing Unit Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version
3.50 (this CWA) - Programmer's Reference
Part 74: Cash-In Module Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50
(this CWA) - Programmer's Reference
Part 75: Card Dispenser Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50
(this CWA) - Programmer's Reference
Part 76: Barcode Reader Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50
(this CWA) - Programmer's Reference
Part 77: Item Processing Module Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to
Version 3.50 (this CWA) - Programmer's Reference
Part 78: Biometric Device Class Interface - Migration from Version 3.40 (CWA 16296:2020) to Version 3.50 (this
CWA) - Programmer's Reference
In addition to these Programmer's Reference specifications, the reader of this CWA is also referred to a
complementary document, called Release Notes. The Release Notes contain clarifications and explanations on the
CWA specifications, which are not requiring functional changes. The current version of the Release Notes is available
online from: https://www.cencenelec.eu/areas-of-work/cen-sectors/digital-society-cen/cwa-download-area/.
The information in this document represents the Workshop's current views on the issues discussed as of the date of
publication. It is provided for informational purposes only and is subject to change without notice. CEN makes no
warranty, express or implied, with respect to this document.

Revision History:
SIST CWA 16926-74:2023
3.00 October 18, 2000 Initial Release.
3.10 November 29, 2007 For a description of changes from version 3.00 to version
3.10 see the CIM 3.10 Migration document.
3.20 March 2, 2011 For a description of changes from version 3.10 to version
3.20 see the CIM 3.20 Migration document.
3.30 March 19, 2015 For a description of changes from version 3.20 to version
3.30 see the CIM 3.30 Migration document.
3.40 December 06, 2019 For a description of changes from version 3.30 to version
3.40 see the CIM 3.40 Migration document.
3.50 November 18, 2022 For a description of changes from version 3.40 to version
3.50 see the CIM 3.50 Migration document.

SIST CWA 16926-74:2023
1. Introduction
1.1 Background to Release 3.50
The CEN/XFS Workshop aims to promote a clear and unambiguous specification defining a multi-vendor software
interface to financial peripheral devices. The XFS (eXtensions for Financial Services) specifications are developed
within the CEN (European Committee for Standardization/Information Society Standardization System) Workshop
environment. CEN Workshops aim to arrive at a European consensus on an issue that can be published as a CEN
Workshop Agreement (CWA).
The CEN/XFS Workshop encourages the participation of both banks and vendors in the deliberations required to
create an industry standard. The CEN/XFS Workshop achieves its goals by focused sub-groups working
electronically and meeting quarterly.
Release 3.50 of the XFS specification is based on a C API and is delivered with the continued promise for the
protection of technical investment for existing applications. This release of the specification extends the
functionality and capabilities of the existing devices covered by the specification:
• Addition of E2E security
• PIN Password Entry
1.2 XFS Service-Specific Programming
The service classes are defined by their service-specific commands and the associated data structures, error codes,
messages, etc. These commands are used to request functions that are specific to one or more classes of Service
Providers, but not all of them, and therefore are not included in the common API for basic or administration
functions.
When a service-specific command is common among two or more classes of Service Providers, the syntax of the
command is as similar as possible across all services, since a major objective of XFS is to standardize function
codes and structures for the broadest variety of services. For example, using the WFSExecute function, the
commands to read data from various services are as similar as possible to each other in their syntax and data
structures.
In general, the specific command set for a service class is defined as a superset of the specific capabilities likely to
be provided by the developers of the services of that class; thus any particular device will normally support only a
subset of the defined command set.
There are three cases in which a Service Provider may receive a service-specific command that it does not support:
The requested capability is defined for the class of Service Providers by the XFS specification, the particular vendor
implementation of that service does not support it, and the unsupported capability is not considered to be
fundamental to the service. In this case, the Service Provider returns a successful completion, but does no operation.
An example would be a request from an application to turn on a control indicator on a passbook printer; the Service
Provider recognizes the command, but since the passbook printer it is managing does not include that indicator, the
Service Provider does no operation and returns a successful completion to the application.
The requested capability is defined for the class of Service Providers by the XFS specification, the particular vendor
implementation of that service does not support it, and the unsupported capability is considered to be fundamental
to the service. In this case, a WFS_ERR_UNSUPP_COMMAND error for Execute commands or
WFS_ERR_UNSUPP_CATEGORY error for Info commands is returned to the calling application. An example
would be a request from an application to a cash dispenser to retract items where the dispenser hardware does not
have that capability; the Service Provider recognizes the command but, since the cash dispenser it is managing is
unable to fulfil the request, returns this error.
The requested capability is not defined for the class of Service Providers by the XFS specification. In this case, a
WFS_ERR_INVALID_COMMAND error for Execute commands or WFS_ERR_INVALID_CATEGORY error
for Info commands is returned to the calling application.
This design allows implementation of applications that can be used with a range of services that provide differing
subsets of the functionalities that are defined for their service class. Applications may use the WFSGetInfo and
WFSAsyncGetInfo commands to inquire about the capabilities of the service they are about to use, and modify
their behavior accordingly, or they may use functions and then deal with error returns to make decisions as to how
SIST CWA 16926-74:2023
to use the service.
SIST CWA 16926-74:2023
2. Cash-In Module
This specification describes the functionality of an XFS compliant Cash-In Module (CIM) Service Provider. It
defines the service-specific commands that can be issued to the Service Provider using the WFSGetInfo,
WFSAsyncGetInfo, WFSExecute and WFSAsyncExecute functions.
Persistent values are maintained through power failures, open sessions, close session and system resets.
This specification covers the acceptance of items. An “item” is defined as any media that can be accepted and
includes coupons, documents, bills and coins. However, if coins and bills are both to be accepted separate Service
Providers must be implemented for each.
All currency parameters in this specification are expressed as a quantity of minimum dispense units, as defined in
the description of the WFS_INF_CIM_CURRENCY_EXP command.
There are two types of CIM: Self-Service CIM and Teller CIM. A Self-Service CIM operates in an automated
environment, while a Teller CIM has an operator present. The functionality provided by the following commands is
only applicable to a Teller CIM:
WFS_CMD_CIM_SET_TELLER_INFO
WFS_INF_CIM_SET_TELLER_INFO
It is possible for the CIM to be part of a compound device with the Cash Dispenser Module (CDM). This
CIM\CDM combination is referred to throughout this specification as a “cash recycler”. For details of the CDM
interface see [Ref. 3].
If the device is a cash recycler then, if cash unit exchanges are required on both interfaces, the exchanges cannot be
performed concurrently. An exchange on one interface must be complete (the
WFS_CMD_CIM_END_EXCHANGE must have completed) before an exchange can start on the other interface.
The WFS_ERR_CIM_EXCHANGEACTIVE error code will be returned if the correct sequence is not adhered to.
The CIM interface can be used for all exchange operations on cash recycle devices, and this interface should be
used for cash units of multiple currencies and/or denominations (including multiple note identifiers associated with
the same denomination).
The event WFS_SRVE_CIM_COUNTS_CHANGED will be posted if an operation on the CDM interface affects
the recycle cash unit counts which are available through the CIM interface.
The following commands on the CDM interface may affect the CIM counts:
WFS_CMD_CDM_DISPENSE
WFS_CMD_CDM_PRESENT
WFS_CMD_CDM_RETRACT
WFS_CMD_CDM_COUNT
WFS_CMD_CDM_REJECT
WFS_CMD_CDM_SET_CASH_UNIT_INFO
WFS_CMD_CDM_END_EXCHANGE
WFS_CMD_CDM_CALIBRATE_CASH_UNIT
WFS_CMD_CDM_RESET
WFS_CMD_CDM_TEST_CASH_UNITS
SIST CWA 16926-74:2023
3. References
1. XFS Application Programming Interface (API)/Service Provider Interface (SPI), Programmer’s Reference
Revision 3.4050
2. ISO 4217 at http://www.iso.org
3. XFS Cash Dispenser Device Class Interface, Programmer’s Reference, Revision 3.4050
4. Paragraph 6 of the EU council regulation 1338/2001. Terms of reference for the adaptation of paragraph 6 on
cash-in and cash-recycling machines (18.04.2002) at:
http://www.ecb.int/pub/pdf/other/recyclingeurobanknotes2005en.pdf
5. Extensions for Financial Services (XFS) interface specification, Release 3.4050, Part 18: Item Processing
Module Device Class Interface Programmer's Reference.
SIST CWA 16926-74:2023
4. Note Classification
Notes are classified by the XFS CIM specification according to the following definitions:
1. Level 1 – Note not recognized.
2. Level 2 – Recognized counterfeit note.
3. Level 3 – Suspected counterfeit note.
4. Level 4 – Recognized note that is identified as genuine. This includes notes which are fit or unfit for
recycling.
This definition allows support for legislative note handling standards that may exist in various countries and
economic regions. Local requirements or device capability may dictate that notes are not classified as level 2 and
level 3; the P6 string reported by WFS_INF_CIM_CAPABILITIES lpszExtra reports whether notes are classified
into all 4 levels and whether level 2 or 3 notes can be returned to the customer.
The above classification levels can be used to support note handling functionality which includes:
1. The ability to remove counterfeit notes from circulation.
2. Reporting of recognized, counterfeit and suspected counterfeit notes.
3. Creating and reporting of note signatures in order to allow back-tracing of notes.
A note’s classification can be changed based on the note’s serial number, currency and value by specifying a
blacklist or classification list. A blacklist reclassifies a matching note as level 2, whereas a classification list can be
used to re-classify a matching note to a lower level, including classifying a genuine note as unfit for dispensing.
Once reclassified, the note will be automatically handled according to the local country specific note handling
standard or legislation for the note’s new note classification, including any level 2 or 3 note retention rules. Any
reclassification will result in the normal events and behavior, for example a
WFS_EXEE_CIM_INFO_AVAILABLE event will reflect the note’s reclassification. Reclassification can be used
to make dynamic changes to note handling procedures without a software upgrade, enabling functionality such as
taking older notes out of circulation or handling of counterfeit notes on a local basis. Note that if reclassification of
an item is performed after a command which generates a WFS_EXEE_CIM_INFO_AVAILABLE or
WFS_EXEE_CIM_INPUT_P6, it has no impact on the content of the note information; the note’s classification
remains what it was reported when the note was classified.
Reclassification cannot be used to change a note’s classification to a higher level, for example, a note recognized as
counterfeit by the device cannot be reclassified as genuine. In addition, it is not possible to re-classify a level 2 note
as level 1. No particular use case has been identified for reclassifying Level 3 and 4 notes as level 1, but there is no
reason to restrict this reclassification.
Blacklists can be specified using WFS_CMD_CIM_SET_BLACKLIST and retrieved using
WFS_INF_CIM_GET_BLACKLIST. Classification lists can be specified using
WFS_CMD_CIM_SET_CLASSIFICATION_LIST and retrieved using
WFS_INF_CIM_GET_CLASSIFICATION_LIST. A classification list is a superset of the blacklist; any items
specified as level 2 in the classification list are considered part of the blacklist. However, it is not recommended
that both sets of commands are used by a single application, as it may lead to overlap and confusion.
The blacklist or classification list functionality can use a mask to specify serial numbers. The mask is defined as
follows: A '?' character (0x003F) is the wildcard used to match a single Unicode character, and a '*' character
(0x002A) is the wildcard used to match one or more Unicode characters.
For example, “S8H9??16?4” would represent a match for the serial numbers “S8H9231654” and “S8H9761684”. A
mask of “HD90*2” would be used in order to match serial numbers that begin with “HD90” and end with “2”, for
example “HD9028882”, “HD9083276112”. Note that the mask can only use one asterisk, and if a real character is
required then it must be preceded by a backslash, for example: '\\' for a backslash, '\*' for an asterisk or '\?' for a
question mark. Note that this flexibility means that it is possible to overlap definitions, for example “HD90*” and
“HD902*” would both match on the serial number HD9028882”.
SIST CWA 16926-74:2023
5. Info Commands
5.1 WFS_INF_CIM_STATUS
Description This command is used to obtain the status of the CIM. It may also return vendor-specific status
information.
Input Param None.
Output Param LPWFSCIMSTATUS lpStatus;
typedef struct _wfs_cim_status
{
WORD   fwDevice;
WORD   fwSafeDoor;
WORD   fwAcceptor;
WORD   fwIntermediateStacker;
WORD   fwStackerItems;
WORD   fwBanknoteReader;
BOOL   bDropBox;
LPWFSCIMINPOS  *lppPositions;
LPSTR   lpszExtra;
DWORD   dwGuidLights[WFS_CIM_GUIDLIGHTS_SIZE];
WORD   wDevicePosition;
USHORT  usPowerSaveRecoveryTime;
WORD   wMixedMode;
WORD   wAntiFraudModule;
} WFSCIMSTATUS, *LPWFSCIMSTATUS;
fwDevice
Supplies the state of the CIM. However, an fwDevice status of WFS_CIM_DEVONLINE does
not necessarily imply that accepting can take place: the value of the fwAcceptor field must be
taken into account and - for some vendors - the state of the safe door (fwSafeDoor) may also be
relevant. The state of the CIM will have one of the following values:
Value Meaning
WFS_CIM_DEVONLINE The device is online. This is returned when
the acceptor is present and operational.
WFS_CIM_DEVOFFLINE The device is offline (e.g. the operator has
taken the device offline by turning a switch).
WFS_CIM_DEVPOWEROFF The device is powered off or physically not
connected.
WFS_CIM_DEVNODEVICE The device is not intended to be there, e.g.
this type of self service machine does not
contain such a device or it is internally not
configured.
WFS_CIM_DEVHWERROR The device is inoperable due to a hardware
error.
WFS_CIM_DEVUSERERROR The device is present but a person is
preventing proper device operation.
WFS_CIM_DEVBUSY The device is busy and unable to process an
execute command at this time.
WFS_CIM_DEVFRAUDATTEMPT The device is present but is inoperable
because it has detected a fraud attempt.
WFS_CIM_DEVPOTENTIALFRAUD The device has detected a potential fraud
attempt and is capable of remaining in
service. In this case the application should
make the decision as to whether to take the
device offline.
fwSafeDoor
Supplies the state of the safe door as one of the following values:
SIST CWA 16926-74:2023
Value Meaning
WFS_CIM_DOORNOTSUPPORTED Physical device has no safe door or safe door
state reporting is not supported.
WFS_CIM_DOOROPEN Safe door is open.
WFS_CIM_DOORCLOSED Safe door is closed.
WFS_CIM_DOORUNKNOWN Due to a hardware error or other condition,
the state of the safe door cannot be
determined.
fwAcceptor
Supplies the state of the acceptor cash units as one of the following values. Note that fwAcceptor
may change value during a cash-in transaction:
Value Meaning
WFS_CIM_ACCOK All cash units present are in a good state.
WFS_CIM_ACCCUSTATE One or more of the cash units is in a high,
full, inoperative or manipulated condition.
Items can still be accepted into at least one
of the cash units.
WFS_CIM_ACCCUSTOP Due to a cash unit failure accepting is
impossible. No items can be accepted
because all of the cash units are in a full,
inoperative or manipulated condition.
This state may also occur when a retract cash
unit is full or no retract cash unit is present,
or when an application lock is set on every
cash unit, or when Level 2/3 notes are to be
automatically retained within cash units, but
all of the designated cash units for storing
them are full or inoperative.
WFS_CIM_ACCCUUNKNOWN Due to a hardware error or other condition,
the
...