Magtek iDynamo 5 Gen III Programmer's Manual

Magtek iDynamo 5 Gen III Programmer's Manual

Secure card reader, commands
Hide thumbs Also See for iDynamo 5 Gen III:
Table of Contents

Advertisement

Quick Links

iDynamo 5 Gen III
Secure Card Reader
Programmer's Manual (COMMANDS)
May 2024
Document Number:
D998200587-101
REGISTERED TO ISO 9001:2015
MagTek I 1710 Apollo Court I Seal Beach, CA 90740 I Phone: (562) 546-6400 I Technical Support: (562) 546-6800
www.magtek.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the iDynamo 5 Gen III and is the answer not in the manual?

Questions and answers

Summary of Contents for Magtek iDynamo 5 Gen III

  • Page 1 5 Gen III Secure Card Reader Programmer’s Manual (COMMANDS) May 2024 Document Number: D998200587-101 REGISTERED TO ISO 9001:2015 MagTek I 1710 Apollo Court I Seal Beach, CA 90740 I Phone: (562) 546-6400 I Technical Support: (562) 546-6800 www.magtek.com...
  • Page 2 Some device icons courtesy of https://icons8.com/, used under the Creative Commons Attribution- NoDerivs 3.0 license. All other system names and product names are the property of their respective owners. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 2 of 48 (D998200587-101)
  • Page 3 Table 0-1 - Revisions Rev Number Date Notes March 15, 2024 Initial release. May 05, 2024 Add Property 0x88 USB Packet Delay, iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 3 of 48 (D998200587-101)
  • Page 4: Table Of Contents

    DUKPT Key Info for Encrypted Data Output ............... 17 3.2.2 Data Messages ........................18 3.2.2.1 Normal Operation – Financial Card Read Message ..........18 iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 4 of 48 (D998200587-101)
  • Page 5 Property 0x87 – Key map status ..................... 42 6.29 Property 0x88 USB Packet Delay .................... 43 Appendix A Warranty, Standards and Certifications ................44 Limited Warranty ............................44 iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 5 of 48 (D998200587-101)
  • Page 6 FCC Information .............................. 45 CUR/UR................................45 CANADIAN DOC STATEMENT ......................... 45 CE STANDARDS ............................... 46 UL/CSA ................................46 RoHS STATEMENT ............................46 SOFTWARE LICENSE AGREEMENT ....................... 47 iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 6 of 48 (D998200587-101)
  • Page 7: Introduction

    1 - Introduction Introduction About This Document This document describes how to communicate with iDynamo 5 Gen III secure card reader (SCR) using the MP application specific integrated circuit (ASIC). About SDKs MagTek provides convenient SDKs and corresponding documentation for many programming languages and operating systems.
  • Page 8 The combination of device(s), host(s), software, firmware, configuration settings, physical mounting and environment, user experience, and documentation is referred to as the solution. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 8 of 48 (D998200587-101)
  • Page 9: Connection Types

    2 - Connection Types Connection Types iDynamo 5 Gen III connects to iOS products via a USB-C or Lighting to USB-C cable. How to Use Apple iAP2 Connections This section provides information about developing an iOS app that interfaces with the device via the Lightning or USB connector using iPod Accessory Protocol 2 (iAP2).
  • Page 10: Usb Communications

    1.11. The device is set up as a full-speed, high-powered USB device that draws power from the USB bus. iDynamo5 Gen III identifies itself to the USB host with MagTek’s vendor ID of 0x0801 and Product ID (PID) of 0x0020. All USB enumeration will include the device serial number.
  • Page 11: Usb Hid Protocol

    This is compatible with the V5 extended command protocol. The number ranges shown in packets assume the interface is USB with a maximum message size of 64 bytes. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 11 of 48 (D998200587-101)
  • Page 12 Error due to invalid or missing data or due to a timeout while the device is waiting for more packets. Table 2-7 - Error Invalid or Missing Data Packet Result Data Len 0x02 0x00 iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 12 of 48 (D998200587-101)
  • Page 13: Response Packets

    May contain part or all the notification data. The size of this field is contained in the Varies Data Partial Data Length field. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 13 of 48 (D998200587-101)
  • Page 14: Data

    Assemble message. • Add message type and length to the beginning of the message. • Replace any bytes with value 0xDB with bytes 0xDB 0xDD. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 14 of 48 (D998200587-101)
  • Page 15 0xC0 1 byte 2 bytes Length varies 0xC0 SLIP example Message 01 DB C0 05 SLIP C0 01 DB DD DB DC 05 C0 iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 15 of 48 (D998200587-101)
  • Page 16: Data Format

    The start sentinel can also indicate what format was used to encode the track. [SS] Track Data [ES] If a property value is set to 0, then no character will be sent. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 16 of 48 (D998200587-101)
  • Page 17: Masking

    0x01 = 3-key TDEA 0x02 = AES 128-bit Derived Key Algorithm Bytes 4,5 0x03 = AES 192 bit 0x04 = AES 256 bit 0x05 = HMAC iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 17 of 48 (D998200587-101)
  • Page 18: Data Messages

    Session ID Encrypt HEX 16/32 value. KSN (MSR) Clear 20/24 DUKPT Key Info (MSR) Clear KSN (MP) Clear 0/20/24 Empty when MSR key is used iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 18 of 48 (D998200587-101)
  • Page 19: Field Separation

    [FS] [MAC DUKPT Key Info] [FS] [MAC message length] [FS] [MAC] [EOM] [SOM] Q001 [FS] [Token DUKPT Key Serial Number] [FS] [Token DUKPT Key Info] [FS] [QWANTUM Status] [FS] [QWANTUM Token] iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 19 of 48 (D998200587-101)
  • Page 20 [FS] [Encrypted Session ID] [FS] [Encrypted QWANTUM Data Buffer] [FS] [Device Serial Number] [FS] [MAC DUKPT Key Info] [FS] [MAC message length] [FS] [MAC][EOM] iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 20 of 48 (D998200587-101)
  • Page 21: Commands

    Response Data Len Response Data 0=Property in effect 0x0000 0x0001 1=Needs reset Command 0002 - Reset Device This command is used to reset the device. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 21 of 48 (D998200587-101)
  • Page 22: Command 0X030D - Read Date And Time

    This command returns the information about the specified key to the host. Table 4-11 Get Key Info Command Command Parameter Data Len Parameter Data 0703 0002 Key ID iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 22 of 48 (D998200587-101)
  • Page 23 (16 + n + 4) or Timestamp Time and date in UTC time format that indicates when the (14 + n + 4) (24 bytes) key block was formed. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 23 of 48 (D998200587-101)
  • Page 24: Command 0X0711 - Download Firmware File

    This command initiates the device's switch to the bootloader for flash updating. It is expected to fail and return an error under two conditions: 1. If the device has not received an authenticated firmware file or, iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 24 of 48 (D998200587-101)
  • Page 25 4 - Commands 2. If the header in the received firmware file indicates that it is an older version than the firmware currently programmed. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 25 of 48 (D998200587-101)
  • Page 26: Response Result Codes

    Key block version not supported 0x008C Invalid key usage 0x008D Key usage not supported 0x008E Invalid algorithm 0x008F Algorithm not supported 0x0090 Invalid mode use iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 26 of 48 (D998200587-101)
  • Page 27 ERR_FileID Wrong firmware FileID 0x0012 ERR_ProductType Wrong firmware ProductType 0x0013 ERR_OperationType Wrong firmware OperationType 0x0014 ERR_SignatureLength Wrong firmware SignatureLength 0x0015 ERR_SignatureMethod Wrong firmware SignatureMethod iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 27 of 48 (D998200587-101)
  • Page 28 Device tamper triggered while downloading firmware 0x0018 ERR_FwCompareHash Firmware hash comparison failed 0x0019 Invalid_Iap2offsetadd iap2 mode update firmware without downloading firmware, error 0x0020 ERR_FlashWrite Failed to write flash iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 28 of 48 (D998200587-101)
  • Page 29: Properties

    About Properties Properties are used to provide information about the device and how to configure it. Secured properties are set at the factory or by an administrator using software tools supplied by MagTek. Property values take effect immediately unless specified otherwise.
  • Page 30: Property 0X03 - Device Serial Number

    Set Property: No Default Value: This value is also found on the product label. The property contains the 7-character MagTek device serial number. This value is used for USB device enumeration, data messages, and message security. Property 0x04 - MagneSafe Version Number...
  • Page 31: Property 0X07 - Iso Track Pan Mask

    This byte specifies whether the device applies Mod 10 Correction to the PAN. “Y” means Yes, “N” means No. This option is only effective if the Masking Character specified by this command is “0”. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 31 of 48 (D998200587-101)
  • Page 32: Property 0X08 - Aamva Track Mask

    This byte specifies whether the device applies Mod 10 Correction to the DL/ID#. “Y” means Yes, “N” means No. This option is only effective if the masking character specified in this command is “0”. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 32 of 48 (D998200587-101)
  • Page 33: Property 0X10 - Interface Type

    5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 33 of 48 (D998200587-101)
  • Page 34: Property 0X22 - End Of Message

    6.13 Property 0x24 - Start Sentinel Track 1 (ISO) Property Description Property ID: 0x24 Property Byte Type: Length: 1 byte Get Property: Yes Set Property: Yes Default 0x25 (‘%’) Value: iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 34 of 48 (D998200587-101)
  • Page 35: Property 0X25 - Start Sentinel Track 2 (Iso Aba)

    6.16 Property 0x27 - Start Sentinel Track 3 (AAMVA) Property Description Property ID: 0x27 Property Byte Type: Length: 1 byte Get Property: Yes Set Property: Yes iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 35 of 48 (D998200587-101)
  • Page 36: Property 0X28 - Start Sentinel Track 2 (7-Bit)

    The device uses this character for the Track 3 start sentinel when it recognizes the track is encoded in the 7-bit ISO format, normally used for Track 1. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 36 of 48 (D998200587-101)
  • Page 37: Property 0X2B - Track End Sentinel

    QWANTUM card, and Track 1 does not begin with the character ‘B’, the device always sends the Track 1 Masked Data value unmasked, regardless of the value of this property. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 37 of 48 (D998200587-101)
  • Page 38: Property 0X34 - Mask Aamva Card Data

    This read-only property returns the boot firmware part number, a dash, the major and minor revision number, followed by a dash and the firmware type. {boot fw pn}-{rev}-PCI Example: 1000004854-AA0-PCI iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 38 of 48 (D998200587-101)
  • Page 39: Property 0X53 - Inter-Key Delay (Kb Emulation)

    Property ASCII Type: Length: varies Get Property: Yes Set Property: No Default Value: Table 6-5 - 0x80 – Device Hardware ID Example Example 10PCI50U0BA iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 39 of 48 (D998200587-101)
  • Page 40: Property 0X82 - Time Of Day Reset

    Table 6-6 PCI Time of Day Reset Value Length Field Name Value Hour Value from 0x00...0x17 (0-23) Minute Value from 0x00...0x3B (0-59) iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 40 of 48 (D998200587-101)
  • Page 41: Property 0X84 - Device Model Name

    Inactive missing Self-Test Data Registers Crypto failure Integrity Integrity Model Serial # PCI Info HW ID Missing Name Missing Missing Unmapped Data Types iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 41 of 48 (D998200587-101)
  • Page 42: Property 0X87 - Key Map Status

    6 – DK2 7 – DK3 8 – DK4 A fully loaded reader would return a keymap of: 7E 00 07 00 8C 00 00 00. iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 42 of 48 (D998200587-101)
  • Page 43: Property 0X88 Usb Packet Delay

    MagTek recommends the following values for various platforms: • Windows = 0x00 (0 ms) • Android = 0x19 (25 ms) • Linux = 0x32 (50 ms) iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 43 of 48 (D998200587-101)
  • Page 44: Appendix A Warranty, Standards And Certifications

    MagTek’s published specifications. This warranty shall be provided only for a period of one year from the date of the shipment of the product from MagTek (the “Warranty Period”). This warranty shall apply only to the “Buyer” (the original purchaser, unless that entity resells the product as authorized by MagTek, in which event this warranty shall apply only to the first repurchaser).
  • Page 45: Fcc Information

    Appendix A - Warranty, Standards and Certifications LIMITATION ON LIABILITY EXCEPT AS PROVIDED IN THE SECTIONS RELATING TO MAGTEK’S LIMITED WARRANTY, MAGTEK’S LIABILITY UNDER THIS AGREEMENT IS LIMITED TO THE CONTRACT PRICE OF THIS PRODUCT. MAGTEK MAKES NO OTHER WARRANTIES WITH RESPECT TO THE PRODUCT, EXPRESSED...
  • Page 46: Ce Standards

    Reduction of Hazardous Substances (RoHS) European Directive 2002/95/EC. The marking is clearly recognizable, either as written words like “Pb-free,” “lead-free,” or as another clear symbol ( iDynamo 5 Gen III| Secure Card Reader | Programmer’s Manual (COMMANDS) Page 46 of 48 (D998200587-101)
  • Page 47: Software License Agreement

    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.
  • Page 48 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.

Table of Contents