Universal SDK MagTek Devices Programmer’s Manual (Android)
Universal SDK MagTek Devices Programmer’s Manual (Android)
Manual Part Number: D998200387-608
REGISTERED TO ISO 9001:2015
Information in this publication is subject to change without notice and may contain technical inaccuracies or graphical discrepancies. Changes or improvements made to this product will be updated in the next publication release. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of MagTek, Inc.
MagTek® is a registered trademark of MagTek, Inc. MagnePrint® is a registered trademark of MagTek, Inc. MagneSafe® is a registered trademark of MagTek, Inc. Magensa™ is a trademark of MagTek, Inc.
aDynamo™, iDynamo™, and uDynamo™ are trademarks of MagTek, Inc. eDynamo™, Dynamag™, and DynaMAX™ are trademarks of MagTek, Inc. mDynamo™, DynaWave™, and tDynamo™ are trademarks of MagTek, Inc. DynaPro Go™, DynaPro™, and DynaPro Mini™ are trademarks of MagTek, Inc.
DynaFlex™, DynaFlex Pro™, DynaProx™, DynaFlex II SCRA™, DynaFlex II PED™, and DynaFlex II Go™ are trademarks of MagTek, Inc.
The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc. and any use of such marks by MagTek is under license.
The "Android" name, the Android logo, the "Google Play" brand, and other Google trademarks, are property of Google LLC and not part of the assets available through the Android Open Source Project.
Microsoft® and Windows® are registered trademarks of Microsoft Corporation.
iPhone®, iPod touch®, Mac®, and Xcode® are registered trademarks of Apple Inc., registered in the U.S. and other countries.
App StoreSM is a service mark of Apple Inc., registered in the U.S. and other countries.
iOS™ is a trademark or registered trademark of Cisco in the U.S. and other countries and is used by Apple Inc. under license. iPad™ is a trademark of Apple Inc. MAC™ and macOS™ are trademarks of Apple Inc., registered in the U.S. and other countries.
EMV® is a registered trademark in the U.S. and other countries and an unregistered trademark elsewhere. The EMV trademark is owned by EMVCo, LLC. The Contactless Indicator mark, consisting of four graduating arcs, is a trademark owned by and used with permission of EMVCo, LLC.
All other system names and product names are the property of their respective owners.
Table - Revisions
10
November 11, 2020
Initial release
20
February 26, 2021
Added GetFile method for MMSDevice. Replaced setDisplay method with displayMessage method in IDeviceControl interface. Added TechnicalFallback to TransactionStatus enumeration. Added PreventMSRSignatureForCardWithICC property to ITransaction interface. Added OperationStatus to EventType enumerations. Added TamperStatus, OperationStatus, and OfflineDetail to InfoType enumerations. Added new enumeration type OperationStatus. Updated MMSDevice to support Host-Driven Fallback for transactions.
30
June 25, 2021
Corrected the description of PreventMSRSignatureForCardWithICC in the ITransaction interface. Added sample of getConfiguration and setConfiguration in section B6 IDeviceConfiguration Walk Through. Added DataEntryType, DeviceEvent, and UserEvent enumerations. Added Manual Card Entry, SuppressThankYouMessage, and OverrideFinalTransactionMessage properties to ITransaction interface.
40
November 18, 2021
Extended showImage(). Extended EventType enum. Added enum DeviceFeature and FeatureStatus. Added support for Barcode display, Barcode reader, and DynaProx.
50
March 11, 2022
Added requestPIN(), requestPAN() to IDevice. Updated EMV transaction flow in the appendix.
60
March 14, 2023
Added support for WebSocket WSS at section 3. Added Wireless as firmware type to updateFirmware() at section 9. Added BMP image format at section 6. Added CertificateInfo class, AppleVASMode and AppleVASProtocol to ITransaction at section 10. Added VASMode and VASProtocol enumerations, Apple VAS and BarCode to PaymentMethods, BarcodeRead and VASError to TransactionStatus, and WEBSOCKET and WEBSOCKET_TRUST to ConnectionType at section 13.
600
September 26, 2023
Added Display Amount for Quick Chip to ITransaction class at section 10.4. Added NFC Tag support to ITransaction at section 10.4 and NFC enumerations as section 13.13. Added WebSocket certificate requirement to section 1.4.
601
November 13, 2023
Added Tip/Tax properties to ITransaction interface at section 10.4. Added TransactionStartedFromDevice, TransactionStartedFromDeviceQuickChip, and TransactionCancelledFromDevice to TransactionStatus enumeration at section 13.16. Added EnhancedInputRequest to EventType enumeration at section 13.9. Added classes DirectoryEntry, EnhancedInputRequest, InputRequest, NFCData, NFCEventBuilder to section 10. Added MifareClassic1K, MifareClassic4K, IOFailed, and AuthenticationFailed to NFCEvent enumeration at section 13.13.
602
January 10, 2024
Added DynaFlex II Go (Bluetooth LE) at section 13.4. Added NFCAPDUResponse to EventType at section 13.9. Added MifareDESFire to NFCEvent at section 13.13 Added ConnectionStateBuilder class at section 10.3. Added NFCRAPDUData class at section 10.10. Added sendDESFireNFCCommand at section 4.14.
603
February 22, 2024
Added GoogleVAS to PaymentMethod enum at section 13.15. Added Apple VAS details as Appendix D. Added Google VAS details as Appendix E.
604
July 1, 2024
Added UI page support to IDeviceControl as sections 6.16 to 6.20. Added FunctionalButtonRightOption to ITransaction at section 10.8. Added UI TouchScreen events to EventType at section. 13.9.
605
May 18, 2025
Added support for MQTT API. Added MQTT methods to CoreAPI at section 3. Added StatusCallback as sections 13 and 14. Added ErrorType enum at section 15. Added MQTT to ConnectionType at section 15.4.
606
June 23, 2025
Updated DeviceEvent enumeration with battery and temperature status at section 15.6. Implemented mTLS for setMQTTClientCertificateInfo at section 3.10.
607
February 5, 2026
Added support for PersonalInfoEntry at sections 6.22, 6.24, 10.12, 15.3, and 15.11. Added deleteFile at section 9.1. Added support for Mifare DesFire Mini, Mifare Plus EV, and mDL at sections 4.16, 10.11, 15.15, 15.16, 15.17, 15.19, 15.21. Added support for NFC card emulation and buzzer at sections 6.22, 6.26, 15.8. Updated InfoType at section 15.14. Added support for ECP2 at sections 15.20, 10.8.
608
April 7, 2026
Added support for NFC Pass-Through mode at sections 6, 15.11, 15.16.
SOFTWARE LICENSE AGREEMENT
IMPORTANT: YOU SHOULD CAREFULLY READ ALL THE TERMS, CONDITIONS AND RESTRICTIONS OF THIS LICENSE AGREEMENT BEFORE INSTALLING THE SOFTWARE PACKAGE. YOUR INSTALLATION OF THE SOFTWARE PACKAGE PRESUMES YOUR ACCEPTANCE OF THE TERMS, CONDITIONS, AND RESTRICTIONS CONTAINED IN THIS AGREEMENT. IF YOU DO NOT AGREE WITH THESE TERMS, CONDITIONS, AND RESTRICTIONS, PROMPTLY RETURN THE SOFTWARE PACKAGE AND ASSOCIATED DOCUMENTATION TO THE ADDRESS ON THE FRONT PAGE OF THIS DOCUMENT, ATTENTION: CUSTOMER SUPPORT.
TERMS, CONDITIONS, AND RESTRICTIONS
MagTek, Incorporated (the "Licensor") owns and has the right to distribute the described software and documentation, collectively referred to as the "Software."
LICENSE: Licensor grants you (the "Licensee") the right to use the Software in conjunction with MagTek products. LICENSEE MAY NOT COPY, MODIFY, OR TRANSFER THE SOFTWARE IN WHOLE OR IN PART EXCEPT AS EXPRESSLY PROVIDED IN THIS AGREEMENT. Licensee may not decompile, disassemble, or in any other manner attempt to reverse engineer the Software. Licensee shall not tamper with, bypass, or alter any security features of the software or attempt to do so.
TRANSFER: Licensee may not transfer the Software or license to the Software to another party without the prior written authorization of the Licensor. If Licensee transfers the Software without authorization, all rights granted under this Agreement are automatically terminated.
COPYRIGHT: The Software is copyrighted. Licensee may not copy the Software except for archival purposes or to load for execution purposes. All other copies of the Software are in violation of this Agreement.
TERM: This Agreement is in effect as long as Licensee continues the use of the Software. The Licensor also reserves the right to terminate this Agreement if Licensee fails to comply with any of the terms, conditions, or restrictions contained herein. Should Licensor terminate this Agreement due to Licensee's failure to comply, Licensee agrees to return the Software to Licensor. Receipt of returned Software by the Licensor shall mark the termination.
LIMITED WARRANTY: Licensor warrants to the Licensee that the disk(s) or other media on which the Software is recorded are free from defects in material or workmanship under normal use.
THE SOFTWARE IS PROVIDED AS IS. LICENSOR MAKES NO OTHER WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Because of the diversity of conditions and PC hardware under which the Software may be used, Licensor does not warrant that the Software will meet Licensee specifications or that the operation of the Software will be uninterrupted or free of errors.
IN NO EVENT WILL LICENSOR BE LIABLE FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS, OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE, OR INABILITY TO USE, THE SOFTWARE. Licensee's sole remedy in the event of a defect in material or workmanship is expressly limited to replacement of the Software disk(s) if applicable.
GOVERNING LAW: If any provision of this Agreement is found to be unlawful, void, or unenforceable, that provision shall be removed from consideration under this Agreement and will not affect the enforceability of any of the remaining provisions. This Agreement shall be governed by the laws of the State of California and shall inure to the benefit of MagTek, Incorporated, its successors or assigns.
ACKNOWLEDGMENT: LICENSEE ACKNOWLEDGES THAT HE HAS READ THIS AGREEMENT, UNDERSTANDS ALL OF ITS TERMS, CONDITIONS, AND RESTRICTIONS, AND AGREES TO BE BOUND BY THEM. LICENSEE ALSO AGREES THAT THIS AGREEMENT SUPERSEDES ANY AND ALL VERBAL AND WRITTEN COMMUNICATIONS BETWEEN LICENSOR AND LICENSEE OR THEIR ASSIGNS RELATING TO THE SUBJECT MATTER OF THIS AGREEMENT.
QUESTIONS REGARDING THIS AGREEMENT SHOULD BE ADDRESSED IN WRITING TO MAGTEK, INCORPORATED, ATTENTION: CUSTOMER SUPPORT, AT THE ADDRESS LISTED IN THIS DOCUMENT, OR E-MAILED TO support@magtek.com.
DEMO SOFTWARE / SAMPLE CODE: Unless otherwise stated, all demo software and sample code are to be used by Licensee for demonstration purposes only and MAY NOT BE incorporated into any production or live environment. The PIN Pad sample implementation is for software PIN Pad test purposes only and is not PCI compliant. To meet PCI compliance in production or live environments, a third-party PCI compliant component (hardware or software-based) must be used.