Cash-In Module CIM

Cash-in: accepts, counts and stores banknotes and coins paid in.

This specification describes the functionality of an XFS compliant Cash-In Module (CIM) Service Provider.

The opening of the first descriptive chapter of the 3.50 document, CWA 16926-15.

3.00First editionin 6 of 7 editions

20QueriesWFS_INF_CIM_… in 3.50

31CommandsWFS_CMD_CIM_… in 3.50

23Eventsreported by the device in 3.50

Across the editions

Each edition of XFS 3.x has one part per device class. The table lists the editions that have a part for Cash-In Module and, for each, how many queries, commands and events the part defines. A dash means the edition has no part for this class.

Source: the message tables of each edition's document. Queries are the WFS_INF_ messages, commands the WFS_CMD_ messages, events the service, execute, user and system events.
Edition	CWA	Date	Queries	Commands	Events
2.00	CWA 13449	December 1998	—	—	—
3.00	CWA 14050	November 2000	9	16	15
3.10	CWA 15748	July 2008	11	20	19
3.20	CWA 16374	December 2011	14	26	20
3.30	CWA 16926	August 2015	17	29	22
3.40	CWA 16926	February 2020	20	31	23
3.50	CWA 16926	December 2022	20	31	23

The class-by-edition matrix shows every class side by side.

The 3.50 document

The part is published as CWA 16926-15. Like every XFS 3.x part it opens with chapters that describe the device and how an application uses it, then lists each query, command and event with its data, and closes with background chapters and the C header.

Before the messages

European Foreword p. 6
1 Introduction p. 10
2 Cash-In Module p. 12
3 References p. 13
4 Note Classification p. 14

The messages

20 queries, 31 commands and 23 events, 74 messages in all, each with its input and output data and its error codes.

After the messages

8 ATM Cash-In Transaction Flow - Application Guidelines p. 148
9 ATM Mixed Media Transaction Flow – Application Guidelines p. 178
10 Rules for Cash Unit Exchange p. 186
11 Events Associated with Cash Unit Status Changes p. 189

Chapter numbers and page numbers are those of the document. CEN publishes the documents free of charge; see Sources.

How to read the numbers

In XFS 3.x an application asks a device about itself with a query (WFS_INF_… – status, capabilities, the forms a printer knows), makes it do something with a command (WFS_CMD_… – print, dispense, read a card), and learns about things that happen on their own from an event (a card taken, a door opened, a threshold reached). The counts above are taken from each document's message tables, so they show how the class grew from edition to edition. A count that does not change does not mean the messages did not: fields are added and meanings refined within a message, and that is not counted here.

Next: The device classes