Magtek Universal SDK Operating and maintenance manual

MagTek I 1710 Apollo Court I Seal Beach, CA 90740 I Phone: [phone] I Technical Support: [phone]
www.magtek.com
MagTek Universal SDK
For MMS Devices
Programmer’s Manual ( Java )
September 2021
Manual Part Number:
D998200385-10
REGISTERED TO ISO 9001:2015

MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 2
Copyright © 2006 - 2021 MagTek, Inc.
Printed in the United States of America
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.
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.
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.
MAX 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 0.1 - Revisions
Rev Number
Date
Notes
10
September 15, 2020
Initial release

MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 3
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.

MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 4
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 [e-mail].

0 - Table of Contents
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 5
Table of Contents
Table of Contents .............................................................................................................................................. 5
1Introduction ............................................................................................................................................... 8
1.1 About the MagTek Sample Code ................................................................................................... 8
1.2Nomenclature ................................................................................................................................... 8
1.3 SDK Contents.................................................................................................................................... 8
1.4 System Requirements ..................................................................................................................... 8
2How to Set Up the MagTek Universal Project....................................................................................... 9
2.1 How to Download and Set Up the MagTek Universal Java Project........................................... 9
2.2 How to Set Up the Java Library With the JRE/JVM...................................................................... 9
2.3 How to Modify Manifest................................................................................................................... 9
2.4 How to Sign JAR.............................................................................................................................. 10
2.5 How to Set Up the SDK in Eclipse................................................................................................11
3CoreAPI..................................................................................................................................................... 12
3.1 getAPIVersion..................................................................................................................................12
3.2 getDevice.........................................................................................................................................12
3.3 getDeviceList................................................................................................................................... 12
3.4 getConnectionTypes.......................................................................................................................13
3.5 GetConnectionTypeString .............................................................................................................13
3.6 GetConnectionTypeFromString ....................................................................................................13
4IDevice......................................................................................................................................................14
4.1 cancelTransaction ..........................................................................................................................14
4.2 getCapabilities................................................................................................................................14
4.3 getConnectionInfo..........................................................................................................................14
4.4 getConnectionState ....................................................................................................................... 14
4.5 getDeviceControl ............................................................................................................................ 14
4.6 getDeviceConfiguration.................................................................................................................14
4.7 getDeviceInfo ..................................................................................................................................15
4.8 Name................................................................................................................................................15
4.9 requestPIN....................................................................................................................................... 15
4.10 requestSignature........................................................................................................................ 16
4.11 sendAuthorization ......................................................................................................................16
4.12 sendSelection .............................................................................................................................16
4.13 startTransaction ......................................................................................................................... 16
4.14 subscribeAll.................................................................................................................................20
4.15 unsubscribeAll ............................................................................................................................20
5IDeviceCapabilities .................................................................................................................................21
5.1 BatteryBackedClock.......................................................................................................................21
5.2 Display..............................................................................................................................................21
5.3 MSRPowerSaver.............................................................................................................................21

0 - Table of Contents
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 6
5.4 PaymentMethods ........................................................................................................................... 21
5.5 PINPad .............................................................................................................................................21
5.6 Signature .........................................................................................................................................21
5.7 SRED.................................................................................................................................................22
6IDeviceControl .........................................................................................................................................23
6.1 close .................................................................................................................................................23
6.2 deviceReset..................................................................................................................................... 23
6.3 displayMessage .............................................................................................................................. 23
6.4 endSession ......................................................................................................................................25
6.5 getInput............................................................................................................................................25
6.6 open.................................................................................................................................................. 25
6.7 playSound........................................................................................................................................ 25
6.8 send.................................................................................................................................................. 26
6.9 sendExtendedCommand............................................................................................................... 26
6.10 sendSync .....................................................................................................................................26
6.11 setDateTime................................................................................................................................ 27
6.12 setLatch .......................................................................................................................................27
6.13 showImage.................................................................................................................................. 28
7ConnectionInfo........................................................................................................................................ 29
7.1 getAddress.......................................................................................................................................29
7.2 getConnectionType.........................................................................................................................29
7.3 getDeviceType.................................................................................................................................29
8DeviceInfo ................................................................................................................................................30
8.1 getModel..........................................................................................................................................30
8.2 getName ..........................................................................................................................................30
8.3 getSerial........................................................................................................................................... 30
9IDeviceConfiguration.............................................................................................................................. 31
9.1 getChallengeToken ........................................................................................................................31
9.2 getConfigInfo................................................................................................................................... 31
9.3 getDeviceInfo ..................................................................................................................................31
9.4 getFile...............................................................................................................................................32
9.5 getKeyInfo .......................................................................................................................................32
9.6 sendFile............................................................................................................................................32
9.7 sendImage....................................................................................................................................... 33
9.8 sendSecureFile ............................................................................................................................... 33
9.9 setConfigInfo................................................................................................................................... 33
9.10 setDisplayImage......................................................................................................................... 34
9.11 updateFirmware ......................................................................................................................... 34
9.12 updateKeyInfo ............................................................................................................................35
10 IEventSubscriber Delegates.............................................................................................................. 36
10.1 OnEvent........................................................................................................................................ 36

0 - Table of Contents
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 7
11 IConfigurationCallback Delegates ...................................................................................................37
11.1 OnCalculateMAC.........................................................................................................................37
11.2 OnProgress.................................................................................................................................. 37
11.3 OnResult ......................................................................................................................................37
12 MTUSDK Enumerations .....................................................................................................................38
12.1 DeviceType ..................................................................................................................................38
12.2 ConnectionType ..........................................................................................................................39
12.3 ConnectionState.........................................................................................................................40
12.4 InfoType .......................................................................................................................................40
12.5 PaymentMethod.........................................................................................................................40
12.6 StatusCode..................................................................................................................................41
12.7 TransactionStatus ......................................................................................................................41
12.8 EventType ....................................................................................................................................42
12.9 UserEvent..................................................................................................................................... 42
Appendix A Status Codes...........................................................................................................................44
A.1 Library Status Codes...................................................................................................................... 44
Appendix B API Walk Through ..................................................................................................................45
B.1 CoreAPI Walk Trough.....................................................................................................................45
B.2 IDevice Walk Through....................................................................................................................46
B.2.1 Handling Events...................................................................................................................... 47
B.3 IDeviceControl Walk Through.......................................................................................................50
B.4ConnectionInfo Walk Through......................................................................................................51
B.5 IDeviceCapabilities Walk Through............................................................................................... 52
B.6 IDeviceConfiguration Walk Through............................................................................................ 53
B.6.1 Handling Events...................................................................................................................... 54
Appendix C EMV Transaction Flow ........................................................................................................... 55
C.1 Flow Chart........................................................................................................................................ 55
C.2 Sample Flow Code ......................................................................................................................... 56
C.3 MSR Fallback Flow.........................................................................................................................62

1 - Introduction
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 8
1Introduction
This document provides instructions for software developers who want to create Java software solutions
that include MagTek devices connected to a Windows based host. This document is part of a larger
library of documents designed to assist MagTek device implementers, which includes the following
documents available from MagTek:
D998200383 DynaFlex Family Programmer’s Manual (COMMANDS)
D998200382 DynaFlex and DynaFlex Pro Installation and Operation Manual
1.1 About the MagTek Sample Code
The sample code provides Java demonstration source code and a reusable MTUSDK library that provides
developers of custom software solutions with an easy-to-use interface for MagTek devices. Developers
can distribute the MTUSDK library to customers or distribute internally as part of an enterprise solution.
1.2 Nomenclature
Device refers to the MagTek devices that receives and responds to command set.
Host refers to the piece of general-purpose electronic equipment the device is connected or paired to,
which sends data to and receives data from the device. Host types include but not limited to PC and
Mac computers, tablets, and smartphones. When “host” must be used differently, it is qualified as
something specific, such as “USB host.”
User in this document generally refers to the cardholder.
1.3 SDK Contents
File name
Description
MTUDK.jar
Java built SDK.
MTMMS.dll
MTUSDK.dll
These are dependency components of MTUSDK for
communicating with devices.
1.4 System Requirements
Tested operating systems:
Windows 8.1
Windows 10
Java 8 and above

2 - How to Set Up the MagTek Universal Project
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 9
2How to Set Up the MagTek Universal Project
2.1 How to Download and Set Up the MagTek Universal Java Project
To set up the MT Universal Libraries, follow these steps:
1) Download the 1000008300-Web.zip, available from MagTek.com
2.2 How to Set Up the Java Library With the JRE/JVM
To set up and run the Java Demo software using the 32-bit version of Java on either a 32-bit or 64-bit
version of Windows, follow these steps:
1) Uninstall any existing instances of the Java Runtime Environment (JRE) or Java Development Kit
(JDK). Leaving them installed can cause runtime failures, as the library may fail to load.
2) Download and install the latest version of the Java Runtime Environment (JRE) and Java
Development Kit (JDK).
3) Follow the steps in section 2.1 How to Download and Set Up the MagTek Universal Java Project
to download and install the latest MagTek Universal Windows SDK. You may download and install
it directly on the target workstation where it will be used, or you may opt to install it on a master
development workstation and copy the dependencies to the target workstation manually.
4) If you opted to manually copy the MagTek Universal SDK for Java dependencies from a master
development workstation to the target workstation where it will be used, follow these steps:
a) On the master workstation, navigate to the root of the MagTek Universal SDK for Java. By
default, it will be …\x86 for 32-bit operating systems, or …\x64 for 64-bit operating systems.
b) Copy all the files to the target workstation’s C:\Windows\System32 folder for x64 systems, or
to the target workstation’s C:\Windows\SysWOW64 folder for x86 systems.
5) Connect a MagTek device to the workstation. Windows will install the device drivers automatically.
Wait for Windows to report the driver installation is complete.
6) Launch a Windows command prompt as an Administrator.
7) cd to the root of the folders where the MTUSDK Java Demo is installed.
8) Type test.bat and press Enter to launch the Java Demo software.
2.3 How to Modify Manifest
The Caller-Allowable-Codebase attribute is used to identify the domains from which JavaScript
code can make calls to your RIA without security prompts. Set this attribute to the domain that hosts the
JavaScript code. If a call is made from JavaScript code that is not located in a domain specified by the
Caller-Allowable-Codebase attribute, the call is blocked. To specify more than one domain,
separate the domains by a space, for example:
Caller-Allowable-Codebase: *.yahoo.com *.google.com *.magtek.com *
The Application-Library-Allowable-Codebase attribute identifies the locations where your signed
RIA is expected to be found. This attribute is used to determine what is listed in the Location field for the
security prompt that is shown to users when the JAR file for your RIA is in a different location than the

2 - How to Set Up the MagTek Universal Project
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 10
JNLP file or HTML page that starts your RIA. If the files are not in the locations identified, the RIA is
blocked. Set this attribute to the domains where the JAR file, JNLP file, and HTML page are located. To
specify more than one domain, separate the domains by a space, for example:
Application-Library-Allowable-Codebase: *.yahoo.com *.google.com
*.magtek.com *
For more information regarding the JAR File Manifest Attributes for Security, please visit this website
http://docs.oracle.com/javase/7/docs/technotes/guides/jweb/security/manifest.html
In order to modify the Manifest file, please follow these steps.
1) Find installation folder by default, the installation folder is:
...\Library
2) Launch the command prompt and extract the META-INF/MANIFEST.MF from the jar file.
jar xf mtusdk.jar META-INF/MANIFEST.MF
3) Open MANIFEST.MF and look for the Caller-Allowable-Codebase and Application-Library-
Allowable-Codebase and add your website URL to the list like the example above.
4) Update the manifest to the jar file.
jar umf META-INF/MANIFEST.MF mtusdk.jar
2.4 How to Sign JAR
These instructions provide an overview of obtaining and using Sun Java signing and a digital certificate.
1) Make sure your machine has the latest Java JDK installed.
2) Generate a public/private key pair by entering the following command, specifying an alias for your
keystore:
keytool -genkey -keyalg rsa -alias MyCert
3) Generate a certificate signing request (CSR) by entering the following command:
keytool -certreq -alias MyCert
After prompting you to enter the password for your keystore, keytool will generate a CSR.
4) Save the certificate received from the Certificate provider as Certname.p7b.
5) Import your Digital Certificate by entering the following command:
keytool -import -alias MyCert -file Certname.p7b
In this string, keytool is requested to import the Digital ID “Certname.cer” into the keystore MyCert.
6) Bundle your applet into a Java Application Resource (JAR) file by entering the following command:
jar cvf C:\mtusdk.jar
7) Sign your applet by using jarsigner to sign the JAR file, using the private key you saved in your
keystore:
jarsigner C:\mtusdk.jar MyCert
8) Verify the output of your signed JAR file by entering the following command:
jarsigner -verify -verbose -certs C:\mtusdk.jar

2 - How to Set Up the MagTek Universal Project
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 11
Please visit this website https://docs.oracle.com/javase/tutorial/deployment/jar/signing.html for more
information regarding signing JAR files.
2.5 How to Set Up the SDK in Eclipse
To set up the MT Universal Java Libraries, download and install package from MagTek.com.
1) On the master workstation, navigate to the root of the MagTek Universal SDK for Java. By default, it
will be …\Library.
2) In Eclipse, click File New Java Project
3) Type the project name
4) In the library tab, click Add external jar, then point to the Lib folder of the root folder of MagTek
Universal SDK for Java to add the MTUSDK.jar.

3 - CoreAPI
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 12
3CoreAPI
Use the CoreAPI to create an IDevice. IDevice is the bases for the MagTek Universal SDK.
If accessing a device specific API outside of MagTek Universal SDK, use the various functions in this
section to create an instance of that device’s API. Once a device specific API is referenced, the
associated library will need to be added into the application’s development project.
3.1 getAPIVersion
This function returns the version of the MagTek Universal SDK.
int CoreAPI.getAPIVersion();
Return Value:
Returns integer.
3.2 getDevice
This function returns an instance of a device.
IDevice CoreAPI.getDevice(
DeviceType deviceType,
ConnectionType connectionType,
String deviceAddress);
Parameter
Description
deviceType
Enumerated device type.
connectionType
Enumerated connection type.
deviceAddress
Address for the device.
For USB devices, address may be an empty string when only one device is
attached. Otherwise address should be in the form:
USB://DEVICESERIALNUMBER
for example, USB://99261829170E0810
Return Value:
Returns an IDevice.
3.3 getDeviceList
This function returns a list of IDevice.
List<IDevice> CoreAPI.getDeviceList(DeviceType deviceType);
List<IDevice> CoreAPI.getDeviceList(DeviceType deviceType,
ConnectionType connectionType);
Parameter
Description
deviceType
Enumerated device type.
connectionType
Enumerated connection type.

3 - CoreAPI
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 13
Return Value:
Returns List<IDevice>.
3.4 getConnectionTypes
This function returns a list of ConnectionType supported for a particular device type.
List<ConnectionType> CoreAPI.getConnectionTypes(DeviceType
deviceType);
Parameter
Description
deviceType
Enumerated device type.
Return Value:
Returns a list of List<ConnectionType>.
3.5 GetConnectionTypeString
This function returns a string for a connection type.
String CoreAPI.GetConnectionTypeString(ConnectionType connectionType);
Parameter
Description
connectionType
Enumerated connections type.
Return Value:
Returns a string for a connection type.
3.6 GetConnectionTypeFromString
This function returns an enumerated connection type from a string.
ConnectionType CoreAPI.GetConnectionTypeFromString(String
connectionType);
Parameter
Description
connectionType
Enumerated connections type.
Return Value:
Returns a ConnectionType.

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 14
4IDevice
Create an instance of the IDevice from CoreAPI.getDeviceList(). Then use the functions described in this
chapter.
4.1 cancelTransaction
This function cancels a transaction. A transaction can only be canceled before a card is presented.
boolean IDevice.cancelTransaction();
Return Value:
Returns true if successful. Otherwise, returns false.
4.2 getCapabilities
This function retrieves the IDeviceCapabilities interface to the device.
IDeviceCapabilities IDevice.getCapabilities();
Return Value:
Returns IDeviceCapabilities
4.3 getConnectionInfo
This function retrieves the connection information of the device.
ConnectionInfo IDevice.getConnectionInfo();
Return Value:
Returns ConnectionInfo
4.4 getConnectionState
This function retrieves the connection state of the device.
ConnectionState IDevice.getConnectionState();
Return Value:
Returns ConnectionState
4.5 getDeviceControl
This function retrieves the device control interface to the device.
IDeviceControl IDevice.getDeviceControl();
Return Value:
Returns IDeviceControl
4.6 getDeviceConfiguration
This function retrieves a device configuration interface to the device.
IDeviceConfiguration IDevice.getDeviceConfiguration();

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 15
Return Value:
Returns IDeviceConfiguration
4.7 getDeviceInfo
This function returns an information class of the device.
DeviceInfo IDevice.getDeviceInfo();
Return Value:
Returns DeviceInfo
4.8 Name
This function retrieves the name of the device.
String IDevice.Name();
Return Value:
Returns a string containing the device name.
4.9 requestPIN
This function prompts the user to enter a PIN on the device. The response data will be returned in the
event OnEvent. requestPin() is reserved for future use.
boolean IDevice.requestPIN(PINRequest pinRequest);
Parameter
Type
Description
Timeout
byte
Wait time in seconds.
PINMode
byte
PIN mode.
Usage:
0x00 - Enter PIN
0x01 - Enter PIN Amount
0x02 - Reenter PIN Amount
0x03 - Reenter PIN
0x04 - Verify PIN
MinLength
byte
Minimum length of accepted PIN (>= 4).
MaxLength
byte
Maximum length of accepted PIN (=< 12).
Tone
byte
Tone to play when prompting for the PIN.
Usage:
0x00 - No sound
0x01 - One beep
0x02 - Two beeps
Format
byte
ISO format for the PIN block.
PAN
String
The left most 12 digits of the Primary Account Number. Leave blank if
not required by the ISO format for the PIN block.

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 16
Return Value:
Returns true if successful. Otherwise, returns false.
4.10 requestSignature
This function prompts the user to enter a signature on the device. The response data will be returned in
the event OnEvent.
boolean IDevice.requestSignature();
Return Value:
Returns true of successful. Otherwise, returns false.
4.11 sendAuthorization
This function sends the Authorization Response Code (ARPC) blob to the device. The response data will
be returned in the event OnEvent.
boolean IDevice.sendAuthorization(IData data);
Parameter
Description
data
Contains ARPC blob.
Return Value:
Returns true if successful. Otherwise, returns false.
4.12 sendSelection
This function send a user selection to the device.
boolean IDevice.sendSelection(IData data);
Parameter for
data
Description
Byte 0
Status of User Selection:
0x00 = User Selection Request completed
0x01 = User Selection Request aborted, cancelled by user
0x02 = User Selection Request aborted, timeout
Byte 1
The menu item selected by the user. This is a single byte zero based binary
value.
Return Value:
Returns true if successful. Otherwise, returns false.
4.13 startTransaction
This function starts a transaction. The transaction will be processed through multiple calls to the event
OnEvent.
boolean IDevice.startTransaction(ITransaction transaction);

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 17
ITransaction
Parameter
Type/
Format
Description
Timeout
byte
Transaction timeout in seconds. Default is 60 seconds.
Usage:
0 to 255 - Depending on the device, 0 means no timeout.
PaymentMethods
List of
PaymentM
ethod
List of the PaymentMethod enumeration.
Usage:
MSR - For magnetic stripe cards.
Contact - For EMV chip cards.
Contactless - For NFC contactless cards.
ManualEntry - For user to manually enter transaction data without any
card access.
QuickChip
bool
In QuickChip mode, the device does not prompt for an amount. Device
sends an ARQC request to the host. Device automatically populates the
ARPC response data with EMV Tag 8A set to “Z3”. Card holder is
prompted to remove the card. Transaction result is later determined by the
processor and not by the card.
Usage:
false - Do not enable QuickChip mode.
true - Enable QuickChip mode. Default.
EMVOnly
bool
Flag that determines whether or not to start an EMV transaction.
Usage:
false - Do not start transaction if the device does not support EMV.
true - Only start transaction if the device supports EMV. Default.
PreventMSRSignatureF
orCardWithICC
bool
Flag that determines whether or not to prompt for a signature for magnetic
stripe when the transaction is from a chip card.
Usage:
false –Do not prompt for signature.
true –Allow the prompt for a signature if requested.
SuppressThankYouMes
sage
bool
By default, devices with a display signal the end of a transaction by briefly
showing “THANK YOU,” then “WELCOME.”
Usage:
false –Do not suppress the thank you message.
true –Suppress the thank you message.

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 18
ITransaction
OverrideFinalTransacti
onMessage
byte
By default, devices with a display signal the end of a transaction by
returning to the idle page and showing “WELCOME.” This parameter
directs the device to show a message based on the Message ID from the
command displayMessage() . This option completely overrides the
device’s idle page behavior until the next transaction, power cycle, or
other similar state change.
Usage:
0x00 - reserved, do not use.
0x01 - “AMOUNT”
0x02 - “AMOUNT OK?”
0x03 - “APPROVED”
0x04 - “CALL YOUR BANK”
0x05 - “CANCEL OR ENTER”
0x06 - “CARD ERROR”
0x07 - “DECLINED”
0x08 - “ENTER AMOUNT”
0x09 - reserved, do not use.
0x0A - reserved, do not use.
0x0B - “INSERT CARD”
0x0C –“NOT ACCEPTED”
0x0D - reserved, do not use.
0x0E - “PLEASE WAIT”
0x0F - “PROCESSING ERROR”
0x10 - “REMOVE CARD”
0x11 - “USE CHIP READER”
0x12 - “USE MAGSTRIPE”
0x13 - “TRY AGAIN”
0x14 - “WELCOME”
0x15 - “PRESENT CARD”
0x16 - “PROCESSING”
0x17 - “CARD READ OK - REMOVE CARD”
0x18 - “INSERT OR SWIPE CARD”
0x19 - “PRESENT ONE CARD ONLY”
0x1A - “APPROVED PLEASE SIGN”
0x1B - “AUTHORIZING PLEASE WAIT”
0x1C - “INSERT, SWIPE OR TRY ANOTHER CARD”
0x1D - “PLEASE INSERT CARD”
0x1E - Null prompt (empty screen)
0x1F - reserved, do not use.
0x20 - “SEE PHONE”
0x21 - “PRESENT CARD AGAIN”
0x22 - “INSERT/SWIPE/TRY OTHER CARD”
0x23 - “TAP or SWIPE CARD”
0x24 - “TAP or INSERT CARD”
0x25 - “TAP, INSERT or SWIPE CARD”
0x26 - “TAP CARD”
0x27 - “TIMEOUT”
0x28 - “TRANSACTION TERMINATED”

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 19
ITransaction
EMVResponseFormat
byte
The format of the EMV response.
Usage:
0x00 –Legacy. Default.
0x01 –RFU
TransactionType
byte
1
EMV Tag 9C - The type of financial transaction, represented by the first
two digits of the ISO 8583:1987 Processing Code.
Examples:
0x00 –purchase. Default.
0x01 –cash advance
0x09 –purchase with cashback
0x20 –refund
Supported transaction types are specified in the commands manual
specific to the device.
Amount
String
12
EMV Tag 9F02 - Authorized amount of the transaction.
Example:
“000000000123” –$1.23
“000000009999” –$99.99
CashBack
String
12
EMV Tag 9F03 - Secondary amount associated with the transaction.
Example:
“000000000123” –$1.23
“000000009999” –$99.99
CurrenyCode
byte[]
2
EMV Tag 5F2A - Currency code of the transaction according to ISO
4217. The byte array is null by default.
Example:
0x0840 = US Dollar
0x0978 = Euro
0x0826 = UK Pound
CurrencyExponent
byte[]
1
EMV Tag 5F36 - The decimal point position from the right of the
transaction amount. The byte array is null by default.
Example:
0x02 –decimal point at 2 position from the right.
TransactionCategory
byte[]
1
EMV Tag 9F53 - The type of contactless transaction being performed.
The byte array is null by default.
MerchantCategory
byte[]
2
EMV Tag 9F15 - The type of business being done by the merchant,
represented according to ISO 18245. The byte array is null by default.
MerchantID
byte[]
15
EMV Tag 9F16 - Used to uniquely identify a given merchant. The byte
array is null by default.

4 - IDevice
MagTek Universal SDK| For MMS Devices | Programmer’s Manual ( Java )
Page 20
ITransaction
MerchantCustomData
byte[]
20
EMV Tag 9F7C –Proprietary merchant data that may be requested. The
byte array is null by default.
Return Value:
Returns true if successful. Otherwise, returns false.
4.14 subscribeAll
This function allows the host to be notified of all events sent by the device.
boolean IDevice.subscribeAll(IEventSubscriber eventCallback);
Parameter
Description
eventCallback
Name of a class that implements the IEventSubscriber Delegates event.
Return Value:
Returns true if successful. Otherwise, returns false.
4.15 unsubscribeAll
This function allows the host to no longer receive any events sent by the device.
boolean IDevice.unsubscribeAll(IEventSubscriber eventCallback);
Parameter
Description
eventCallback
Name of a class that implements the IEventSubscriber Delegates event.
Return Value:
Returns true if successful. Otherwise, returns false.