EUROPEAN COMMITTEE FOR STANDARDIZATION
COMITÉ EUROPÉEN DE NORMALISATION
EUROPÄISCHES KOMITEE FÜR NORMUNG
CEN-CENELEC Management Centre: Avenue Marnix 17, B-1000 Brussels
© 2015 CEN
A
ll rights of exploitation in any form and by any means reserved worldwide for CEN national Members.
Ref. No.:CWA 16926-1:2015 E
CEN
WORKSHOP
AGREEMENT
CWA 16926-1
August 2015
ICS 35.240.15; 35.200; 35.240.40
English version
Extensions for Financial Services (XFS) interface specification
Release 3.30 - Part 1: Application Programming Interface (API) -
Service Provider Interface (SPI) - 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, Former Yugoslav Republic of Macedonia, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Lithuania,
Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden, Switzerland, Turkey and United
Kingdom.
CWA 16926-1:2015 (E)
2
Table of Contents
European foreword ................................................................................................................... 6
1. Background to Release 3.30 ........................................................................................ 9
2. References ...................................................................................................................... 10
3. XFS (eXtensions for Financial Services) Overview.............................................. 11
3.1 Archi tecture ...................................................................................................................... 12
3.2 API and SPI Summary ....................................................................................................... 15
3.3 Device Classe s ................................................................................................................. 16
3.4 Unicode Encoding Summary ............................................................................................ 17
4. Architectural and Implementation Issues............................................................... 18
4.1 The XFS Manager.............................................................................................................. 19
4.2 Service Providers ............................................................................................................. 20
4.2.1 Service Provider Functionality......................................................................................................................... 20
4.2.2 Service Provider “Packaging” .......................................................................................................................... 20
4.3 Asynchronous, Synchronous and Immediate Functions .................................................. 21
4.3.1 Asynchronous Functions ................................................................................................................................... 21
4.3.2 Synchronous Functions ..................................................................................................................................... 21
4.3.3 Immediate Functions.......................................................................................................................................... 22
4.4 Processing API Functions ................................................................................................ 23
4.5 Opening a Session............................................................................................................ 24
4.6 Closing a Session ............................................................................................................. 25
4.7 Configuration Information ................................................................................................ 26
4.8 Exclusive Service and Device Access .............................................................................. 30
4.8.1 Lock Policy for Independent Devices ............................................................................................................. 30
4.8.2 Compound Devices ............................................................................................................................................ 31
4.9 Timeout............................................................................................................................. 33
4.10 Function Status Return ..................................................................................................... 34
4.11 Notification Mechanisms - Registering for Events ............................................................ 35
4.12 Application Proce sse s, Threads and Blocking Functions ................................................ 37
4.13 Vendor Dependent Mode .................................................................................................. 39
4.14 Memory Management........................................................................................................ 40
4.15 Command Synchronization .............................................................................................. 42
4.16 Binary Interface ................................................................................................................ 43
5. Application Programming Interface (API) Functions .......................................... 44
5.1 WFSCancelAsyncReque st ................................................................................................ 46
5.2 WFSCancelBlockingCall ................................................................................................... 47
5.3 WFSCleanUp..................................................................................................................... 48
5.4 W FSCl o se ......................................................................................................................... 49
5.5 W FSA syn cCl o se ............................................................................................................... 50
5.6 WFSCreateAppHandle ...................................................................................................... 51
CWA 16926-1:2015 (E)
3
5.7 WFSDeregister.................................................................................................................. 52
5.8 WFSAsyncDeregister........................................................................................................ 53
5.9 WFSDestroyAppHandle .................................................................................................... 55
5.10 WFSExecute ..................................................................................................................... 56
5.11 WFSAsyncExecute ........................................................................................................... 58
5.12 WFSFreeResult ................................................................................................................. 60
5.13 WFSGetInfo....................................................................................................................... 61
5.14 WFSAsyncGetInfo ............................................................................................................. 63
5.15 WFSIsBlocking ................................................................................................................. 65
5.16 WFSLock .......................................................................................................................... 66
5.17 WFSAsyncLock ................................................................................................................ 68
5.18 WFSOpen.......................................................................................................................... 70
5.19 WFSAsyncOpen ................................................................................................................ 73
5.20 WFSRegister ..................................................................................................................... 76
5.21 WFSAsyncRegi ste r ........................................................................................................... 77
5.22 WFSSetBlockingHook....................................................................................................... 79
5.23 WFSStartUp ...................................................................................................................... 80
5.24 WFSUnhookBlockingHook ............................................................................................... 82
5.25 WFSUnlock ....................................................................................................................... 83
5.26 WFSAsyncUnlock ............................................................................................................. 84
6. Service Provider Interface (SPI) Functions ............................................................ 85
6.1 WFPCancelAsyncReque st ................................................................................................ 86
6.2 W F P Cl o se ......................................................................................................................... 87
6.3 WFPDeregister.................................................................................................................. 88
6.4 WFPExecute ..................................................................................................................... 90
6.5 WFPGetInfo....................................................................................................................... 92
6.6 WFPLock .......................................................................................................................... 94
6.7 WFPOpen.......................................................................................................................... 95
6.8 WFPRegister ..................................................................................................................... 98
6.9 WFPSetTraceLevel............................................................................................................ 99
6.10 WFPUnloadService ......................................................................................................... 100
6.11 WFPUnlock ..................................................................................................................... 101
7. Support Functions ...................................................................................................... 102
7.1 WFMAllocateBuffer ......................................................................................................... 102
7.2 WFMAllocateMore........................................................................................................... 103
7.3 WFMFreeBuffer ............................................................................................................... 104
7.4 WFMGetTraceLevel......................................................................................................... 105
7.5 WFMKillTimer ................................................................................................................. 106
7.6 WFMOutputTraceData..................................................................................................... 107
7.7 WFMReleaseDLL............................................................................................................. 108
CWA 16926-1:2015 (E)
4
7.8
WFMSetTimer ................................................................................................................. 109
7.9 WFMSetTraceLevel ......................................................................................................... 110
8. Configuration Functions ........................................................................................... 112
8.1 WFMCloseKey ................................................................................................................ 112
8.2 WFMCreateKey ............................................................................................................... 113
8.3 WFMDeleteKey................................................................................................................ 114
8.4 WFMDeleteValue ............................................................................................................. 115
8.5 WFMEnumKey ................................................................................................................ 116
8.6 WFMEnumValue.............................................................................................................. 117
8.7 WFMOpenKey ................................................................................................................. 118
8.8 WFMQueryValue ............................................................................................................. 119
8.9 WFMSetValue.................................................................................................................. 120
9. Data Structures ............................................................................................................ 121
9.1 WFSRES ULT ................................................................................................................... 121
9.2 WFSVERSION ................................................................................................................. 122
10. Messages....................................................................................................................... 123
10.1 Command Completions and Events ............................................................................... 123
10.1.1 Command Completion Messages .................................................................................................................. 123
10.1.2 Event Messages................................................................................................................................................. 123
10.2 WFS_TIMER_ EV ENT ....................................................................................................... 124
10.3 WFS_SYS E_ D EVIC E_ST AT US ........................................................................................ 125
10.4 WFS_SYS E_ UNDELIV ERABLE_MSG .............................................................................. 126
10.5 WFS_SYSE_APP_DISCONNECT ..................................................................................... 127
10.6 WFS_SYSE_HARDWARE_ERROR, WFS_SYSE_SOFTWARE_ERROR,
WFS_SYSE_USER_ERROR and WFS_SYSE_FRAUD_ATTEMPT ............................................
128
10.7 WFS_SYS E_L OCK_ REQ U EST ED.................................................................................... 130
10.8 WFS_SYSE_VERSION_ERROR....................................................................................... 131
11. Error Codes................................................................................................................... 132
12. Appendix A - Planned Enhancements and Extensions .................................... 135
12.1 Event and System Management...................................................................................... 136
13. Appendix B - XFS Workshop Contacts ................................................................. 137
14. Appendix C - ATM Devices Synchronization Flow............................................. 138
14.1 Synchronized Media Ejection ......................................................................................... 138
15. Appendix D – Win64 Migration Considerations .................................................. 139
16. Appendix D - C-Header files ..................................................................................... 140
16.1 XFSAPI.H ........................................................................................................................ 140
16.2 XFSADMI N.H ................................................................................................................... 146
16.3 XFSCONF.H .................................................................................................................... 147
CWA 16926-1:2015 (E)
5
16.4 XFSSPI.H ........................................................................................................................ 149
评论0