CWA 16926-15:2022
(Main)Extensions for Financial Services (XFS) interface specification Release 3.50 - Part 15: Cash-In Module Device Class Interface - Programmer's Reference
Extensions for Financial Services (XFS) interface specification Release 3.50 - Part 15: Cash-In Module Device Class Interface - Programmer's Reference
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.
Specifikacija vmesnika razširitev za finančne storitve (XFS), izdaja 3.50 - 15. del: Razred vmesnika naprave modula za unovčevanje - Referenca za programerje
Ta specifikacija opisuje funkcionalnost ponudnika storitve modula za unovčevanje (CIM), združljivega z razširitvami za finančne storitve (XFS). Določa ukaze, značilne za določeno storitev, ki jih je mogoče izdati ponudniku storitve s funkcijami WFSGetInfo, WFSAsyncGetInfo, WFSExecute in WFSAsyncExecute.
Stalne vrednosti se vzdržujejo z izpadi električne energije, odprtimi in zaprtimi sejami ter ponastavitvami sistema
Ta specifikacija zajema sprejem elementov. »Element« je opredeljen kot katero koli sredstvo, ki ga je mogoče sprejeti, ter vključuje kupone, dokumente, bankovce in kovance. V primeru sprejema tako kovancev kot bankovcev je treba implementirati ločene ponudnike storitev.
Vsi parametri valute v tej specifikaciji so izraženi kot količina najmanjših izdajnih enot, kot je opredeljeno v opisu ukaza WFS_INF_CIM_CURRENCY_EXP.
Obstajata dve vrsti modulov za unovčevanje: samopostrežni in blagajniški modul. Samopostrežni modul za unovčenje deluje v avtomatiziranem okolju, pri blagajniškem modulu pa je prisoten upravljavec. Funkcionalnost, ki jo zagotavljata spodnja ukaza, se uporablja samo za blagajniški modul:
WFS_CMD_CIM_SET_TELLER_INFO
WFS_INF_CIM_SET_TELLER_INFO
Modul za unovčevanje je lahko del sestavljene naprave skupaj z modulom za izdajanje gotovine (CDM). Kombinacija teh dveh modulov se v tej specifikaciji imenuje »modul za recikliranje gotovine«. Za podrobne informacije o vmesniku modula za izdajanje gotovine glej [Ref. 3].
Če je naprava modul za recikliranje gotovine in je potrebna izmenjava gotovinske enote v obeh vmesnikih, tega ni mogoče izvesti sočasno. Izmenjava v enem vmesniku mora biti dokončana (ukaz WFS_CMD_CIM_END_EXCHANGE se mora zaključiti), preden se lahko začne izmenjava v drugem vmesniku. Če pravilno zaporedje ni upoštevano, se prikaže koda napake WFS_ERR_CIM_EXCHANGEACTIVE.
Vmesnik modula za unovčevanje je mogoče uporabiti za vse operacije izmenjave v napravah za recikliranje gotovine in naj bi se uporabljal za gotovinske enote z več valutami in/ali oznakami (vključno z več napravami za prepoznavanje bankovcev, ki so povezane z isto oznako).
Če operacija, ki se izvaja v vmesniku modula za izdajanje gotovine, vpliva na štetje enote za recikliranje gotovine prek vmesnika modula za unovčevanje, bo objavljen dogodek WFS_SRVE_CIM_COUNTS_CHANGED.
General Information
Standards Content (Sample)
SLOVENSKI STANDARD
SIST CWA 16926-15:2023
01-marec-2023
Specifikacija vmesnika razširitev za finančne storitve (XFS), izdaja 3.50 - 15. del:
Razred vmesnika naprave modula za unovčevanje - Referenca za programerje
Extensions for Financial Services (XFS) interface specification Release 3.50 - Part 15:
Cash-In Module Device Class Interface - Programmer's Reference
Ta slovenski standard je istoveten z: CWA 16926-15:2022
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-15:2023 en,fr,de
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
SIST CWA 16926-15:2023
SIST CWA 16926-15:2023
CEN
CWA 16926-15
WORKSHOP
December 2022
AGREEMENT
ICS 35.200; 35.240.15; 35.240.40
English version
Extensions for Financial Services (XFS) interface
specification Release 3.50 - Part 15: Cash-In Module
Device Class Interface - Programmer's Reference
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
© 2022 CEN All rights of exploitation in any form and by any means reserved worldwide for CEN national Members.
Ref. No.:CWA 16926-15:2022 E
SIST CWA 16926-15: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-15: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-15: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) .
...
SLOVENSKI STANDARD
01-marec-2023
Specifikacija vmesnika razširitev za finančne storitve (XFS), izdaja 3.50 - 15. del:
Razred vmesnika naprave modula za unovčevanje - Referenca za programerje
Extensions for Financial Services (XFS) interface specification Release 3.50 - Part 15:
Cash-In Module Device Class Interface - Programmer's Reference
Ta slovenski standard je istoveten z: CWA 16926-15:2022
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
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
CEN
CWA 16926-15
WORKSHOP
December 2022
AGREEMENT
ICS 35.200; 35.240.15; 35.240.40
English version
Extensions for Financial Services (XFS) interface
specification Release 3.50 - Part 15: Cash-In Module
Device Class Interface - Programmer's Reference
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
© 2022 CEN All rights of exploitation in any form and by any means reserved worldwide for CEN national Members.
Ref. No.:CWA 16926-15:2022 E
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
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
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) .
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.