DIN CWA 14050-5-2001 Extensions for financial services (XFS) interface specification - Release 3 0 - Part 5 Cash dispenser device class interface (English Version CWA 14050-5 2000).pdf

1、April 2001Extensions for Financial Services (XFS)interface specification Release 3.0 Part 5: Cash Dispenser Device Class InterfaceCWA 14050-5Englische Fassung CWA 14050-5:2000ICS 35.200; 35.240.40Erweiterungen fr die Schnittstellenspezifikation fr Finanzdienst-leistungen (XFS) Version 3.0 Teil 5: Sc

2、hnittstelle fr die Gerteklasse “Geldausgabemodule“Nationales VorwortDieses CEN Workshop Agreement CWA 14050-5, das vom CEN/ISSS XFS Workshop erarbeitet wurde,wird ausschlielich in englischer Sprache zur Verfgung gestellt.CEN Workshop Agreements werden im Rahmen eines Konsortiums entwickelt. Sie unte

3、rscheiden sich vonEuropischen Normen dadurch, dass sie grundstzlich kein ffentliches Einspruchsverfahren durchlaufenund dass auch keine nationale Meinungsbildung stattfindet. Im Gegensatz zu Europischen Normen, dieden Konsens aller interessierten Kreise darstellen, haben CEN Workshop Agreements ledi

4、glich dieZustimmung der unmittelbar beteiligten Mitglieder des Konsortiums gefunden.Fr den Inhalt sind ausschlielich die Mitglieder des Konsortiums verantwortlich (siehe ergnzendeHinweise im CWA-Vorwort). Weder das CEN-Zentralsekretariat, noch die CEN-Mitglieder haben den Inhaltauf eventuelle Fehler

5、 oder Widersprche zu Normen und Rechtsvorschriften geprft.Fortsetzung 62 Seiten CWA Beuth Verlag GmbH, 2001 .Jede Art der Vervielfltigung, auch auszugsweise, Ref. Nr. DIN CWA 14050-5:2001-04nur mit Genehmigung des Beuth Verlages gestattet. RW DIN CWA Preisgr. 08Alleinverkauf der Normen durch Beuth V

6、erlag GmbH, 10772 Berlin Leerseite Rue de Stassart, 36 B-1050 BruxellesTel : +32 2 550 08 11 Fax : +32 2 550 08 19EUROPEAN COMMITTEE FOR STANDARDIZATION COMIT EUROPEN DE NORMALISATION EUROPISCHES KOMITEE FR NORMUNG WORKSHOPCWA 14050-5AGREEMENTNovember 2000ICS 35.200; 35.240.40Extensions for Financia

7、l Services (XFS) interface specification -Release 3.0 - Part 5: Cash Dispenser Device Class Interface 2000 CEN All rights of exploitation in any form and by any means reserved world-wide forCEN National MembersRef. No CWA 14050-5:2000 EThis CEN Workshop Agreement can in no way be held as being an of

8、ficial standardas developed by CEN National Members.Page 2CWA 14050-5:2000Table of ContentsForeword . 41. Introduction . 61.1 Background to Release 3.0. 61.2 XFS Service-Specific Programming 62. Cash Dispensers . 83. References. 94. Info Commands. 104.1 WFS_INF_CDM_STATUS 104.2 WFS_INF_CDM_CAPABILIT

9、IES. 134.3 WFS_INF_CDM_CASH_UNIT_INFO 154.4 WFS_INF_CDM_TELLER_INFO . 204.5 WFS_INF_CDM_CURRENCY_EXP 224.6 WFS_INF_CDM_MIX_TYPES 234.7 WFS_INF_CDM_MIX_TABLE . 244.8 WFS_INF_CDM_PRESENT_STATUS . 255. Execute Commands 265.1 WFS_CMD_CDM_DENOMINATE 265.2 WFS_CMD_CDM_DISPENSE. 285.3 WFS_CMD_CDM_COUNT 315

10、.4 WFS_CMD_CDM_PRESENT 335.5 WFS_CMD_CDM_REJECT. 345.6 WFS_CMD_CDM_RETRACT. 345.7 WFS_CMD_CDM_OPEN_SHUTTER 355.8 WFS_CMD_CDM_CLOSE_SHUTTER 365.9 WFS_CMD_CDM_SET_TELLER_INFO. 365.10 WFS_CMD_CDM_SET_CASH_UNIT_INFO 375.11 WFS_CMD_CDM_START_EXCHANGE 385.12 WFS_CMD_CDM_END_EXCHANGE . 405.13 WFS_CMD_CDM_O

11、PEN_SAFE_DOOR . 415.14 WFS_CMD_CDM_CALIBRATE_CASH_UNIT 415.15 WFS_CMD_CDM_SET_MIX_TABLE . 425.16 WFS_CMD_CDM_RESET . 435.17 WFS_CMD_CDM_TEST_CASH_UNITS . 446. Events 466.1 WFS_SRVE_CDM_SAFEDOOROPEN 466.2 WFS_SRVE_CDM_SAFEDOORCLOSED. 46Page 3CWA 14050-5:20006.3 WFS_USRE_CDM_CASHUNITTHRESHOLD . 466.4

12、WFS_SRVE_CDM_CASHUNITINFOCHANGED 466.5 WFS_SRVE_CDM_TELLERINFOCHANGED . 476.6 WFS_EXEE_CDM_DELAYEDDISPENSE 476.7 WFS_EXEE_CDM_STARTDISPENSE. 476.8 WFS_EXEE_CDM_CASHUNITERROR 476.9 WFS_SRVE_CDM_ITEMSTAKEN 486.10 WFS_SRVE_CDM_COUNTS_CHANGED. 486.11 WFS_EXEE_CDM_PARTIALDISPENSE 486.12 WFS_EXEE_CDM_SUBD

13、ISPENSEOK 496.13 WFS_EXEE_CDM_INCOMPLETEDISPENSE. 496.14 WFS_EXEE_CDM_NOTEERROR 496.15 WFS_SRVE_CDM_ITEMSPRESENTED. 496.16 WFS_SRVE_CDM_MEDIADETECTED 497. Sub-Dispensing Command Flow. 518. Rules for Cash Unit Exchange. 549. C - Header file 55Page 4CWA 14050-5:2000ForewordThis CWA is revision 3.0 of

14、the XFS interface specification.The move from an XFS 2.0 specification (CWA 13449) to a 3.0 specification has been prompted by a series offactors.Initially, there has been a technical imperative to extend the scope of the existing specification of the XFS Managerto include new devices, such as the C

15、ard Embossing Unit.Similarly, there has also been pressure, through implementation experience and the advance of the Microsofttechnology, to extend the functionality and capabilities of the existing devices covered by the specification.Finally, it is also clear that our customers and the market are

16、asking for an update to a specification, which is nowover 2 years old. Increasing market acceptance and the need to meet this demand is driving the Workshop towardsthis release.The clear direction of the CEN/ISSS XFS Workshop, therefore, is the delivery of a new Release 3.0 specificationbased on a C

17、 API. It will be delivered with the promise of the protection of technical investment for existingapplications and the design to safeguard future developments.The CEN/ISSS XFS Workshop gathers suppliers as well as banks and other financial service companies. A list ofcompanies participating in this

18、Workshop and in support of this CWA is available from the CEN/ISSS Secretariat.This CWA was formally approved by the XFS Workshop meeting on 2000-10-18. The specification is continuouslyreviewed and commented in the CEN/ISSS Workshop on XFS. It is therefore expected that an update of thespecificatio

19、n will be published in due time as a CWA, superseding this revision 3.0.The CWA is published as a multi-part document, consisting of:Part 1: Application Programming Interface (API) - Service Provider Interface (SPI); Programmers ReferencePart 2: Service Classes Definition; Programmers ReferencePart

20、3: Printer Device Class Interface - Programmers ReferencePart 4: Identification Card Device Class Interface - Programmers ReferencePart 5: Cash Dispenser Device Class Interface - Programmers ReferencePart 6: PIN Keypad Device Class Interface - Programmers ReferencePart 7: Check Reader/Scanner Device

21、 Class Interface - Programmers ReferencePart 8: Depository Device Class Interface - Programmers ReferencePart 9: Text Terminal Unit Device Class Interface - Programmers ReferencePart 10: Sensors and Indicators Unit Device Class Interface - Programmers ReferencePart 11: Vendor Dependent Mode Device C

22、lass Interface - Programmers ReferencePart 12: Camera Device Class Interface - Programmers ReferencePart 13: Alarm Device Class Interface - Programmers ReferencePart 14: Card Embossing Unit Class Interface - Programmers ReferencePart 15: Cash In Module Device Class Interface- Programmers ReferencePa

23、rt 16: Application Programming Interface (API) - Service Provider Interface (SPI) - Migration from Version 2.0(see CWA 13449) to Version 3.0 (this CWA) - Programmers ReferencePart 17: Printer Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0 (this CWA) -Programmers R

24、eferencePart 18: Identification Card Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0(this CWA) - Programmers ReferencePage 5CWA 14050-5:2000Part 19: Cash Dispenser Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0 (thisCWA) - Progra

25、mmers ReferencePart 20: PIN Keypad Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0 (thisCWA) - Programmers ReferencePart 21: Depository Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0 (thisCWA) - Programmers ReferencePart 22: Text

26、 Terminal Unit Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0(this CWA) - Programmers ReferencePart 23: Sensors and Indicators Unit Device Class Interface - Migration from Version 2.0 (see CWA 13449) toVersion 3.0 (this CWA) - Programmers ReferencePart 24: Camera

27、Device Class Interface - Migration from Version 2.0 (see CWA 13449) to Version 3.0 (this CWA)- Programmers ReferencePart 25: Identification Card Device Class Interface - PC/SC Integration GuidelinesIn addition to these Programmers Reference specifications, the reader of this CWA is also referred to

28、acomplementary document, called Release Notes. The Release Notes contain clarifications and explanations on theCWA specifications, which are not requiring functional changes. The current version of the Release Notes isavailable online from http:/www.cenorm.be/isss/Workshop/XFS.The information in thi

29、s document represents the Workshops current views on the issues discussed as of the date ofpublication. It is furnished for informational purposes only and is subject to change without notice. CEN/ISSSmakes no warranty, express or implied, with respect to this document.Revision History:3.00 October

30、18, 2000 Addition of the reset command.Cash Units Manipulated enhancement.Count Command Addition, Coin Dispense ClarificationAddition of rejected/retracted notes counterAddition of retract area structureClarify handling of coins and bills, introduction of the termitem instead of bill, clarification

31、for mix tables, clarificationfor TEST_CASH_UNITSOther CDM error codes .For a detailed description see CWA 14050-19CDM migration from version 2.00 to version 3.00, revision1.00, October 18th2000Page 6CWA 14050-5:20001. Introduction1.1 Background to Release 3.0The CEN XFS Workshop is a continuation of

32、 the Banking Solution Vendors Council workshop and maintains atechnical commitment to the Win 32 API. However, the XFS Workshop has extended the franchise of multi vendorsoftware by encouraging the participation of both banks and vendors to take part in the deliberations of the creationof an industr

33、y standard. This move towards opening the participation beyond the BSVCs original membership hasbeen very succesful with a current membership level of more than 20 companies.The fundamental aims of the XFS Workshop are to promote a clear and unambiguous specification for both serviceproviders and ap

34、plication developers. This has been achieved to date by sub groups working electronically andquarterly meetings.The move from an XFS 2.0 specification to a 3.0 specification has been prompted by a series of factors. Initially,there has been a technical imperative to extend the scope of the existing

35、specification of the XFS Manager to includenew devices, such as the Card Embossing Unit.Similarly, there has also been pressure, through implementation experience and the advance of the Microsofttechnology, to extend the functionality and capabilities of the existing devices covered by the specifica

36、tion.Finally, it is also clear that our customers and the market are asking for an update to a specification, which is nowover 2 years old. Increasing market acceptance and the need to meet this demand is driving the Workshop towardsthis release.The clear direction of the XFS Workshop, therefore, is

37、 the delivery of a new Release 3.0 specification based on a CAPI. It will be delivered with the promise of the protection of technical investment for existing applications and thedesign to safeguard future developments.1.2 XFS Service-Specific ProgrammingThe service classes are defined by their serv

38、ice-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 serviceproviders, but not all of them, and therefore are not included in the common API for basic or administrationfunctions.W

39、hen a service-specific command is common among two or more classes of service providers, the syntax of thecommand is as similar as possible across all services, since a major objective of the Extensions for FinancialServices is to standardize function codes and structures for the broadest variety of

40、 services. For example, using theWFSExecute function, the commands to read data from various services are as similar as possible to each other intheir syntax and data structures.In general, the specific command set for a service class is defined as a superset of the specific capabilities likely tobe

41、 provided by the developers of the services of that class; thus any particular device will normally support only asubset 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 fo

42、r the class of service providers by the XFS specification, the particularvendor implementation of that service does not support it, and the unsupported capability is not considered tobe fundamental to the service. In this case, the service provider returns a successful completion, but does nooperati

43、on. An example would be a request from an application to turn on a control indicator on a passbookprinter; the service provider recognizes the command, but since the passbook printer it is managing does notinclude that indicator, the service provider does no operation and returns a successful comple

44、tion to theapplication.The requested capability is defined for the class of service providers by the XFS specification, the particularvendor implementation of that service does not support it, and the unsupported capability is considered to befundamental to the service. In this case, a WFS_ERR_UNSUP

45、P_COMMAND error is returned to the callingapplication. An example would be a request from an application to a cash dispenser to dispense coins; thePage 7CWA 14050-5:2000service provider recognizes the command but, since the cash dispenser it is managing dispenses only notes,returns this error.The re

46、quested capability is not defined for the class of service providers by the XFS specification. In this case,a WFS_ERR_INVALID_COMMAND error is returned to the calling application.This design allows implementation of applications that can be used with a range of services that provide differingsubsets

47、 of the functionalities that are defined for their service class. Applications may use the WFSGetInfo andWFSAsyncGetInfo commands to inquire about the capabilities of the service they are about to use, and modifytheir behaviour accordingly, or they may use functions and then deal with WFS_ERR_UNSUPP

48、_COMMAND errorreturns to make decisions as to how to use the service.Page 8CWA 14050-5:20002. Cash DispensersThis specification describes the functionality of a XFS compliant Cash Dispenser Module (CDM) service provider.It defines the service-specific commands that can be issued to the service provi

49、der 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 dispensing of items. An “item” is defined as any media that can be dispensed andincludes coupons, documents, bills and coins. However, if coins and bills are both to be dispensed separate serviceproviders must be implemented for each.All currency parameters in this specification are expressed as a quantity of minimum di