For the complete documentation index, see llms.txt. This page is also available as Markdown.
Page cover

Introduction

About This Document

This document describes the master set of messages a host can send and receive via byte-by-byte direct communication with secure card reader authenticator devices that implement MagTek Common Message Format (MCMF), such as oDynamo (referred to in this document as “the device”).

About Terminology

The general terms “device” and “host” are used in different, often incompatible ways in a multitude of specifications and contexts. For example, “host” may have different a meaning in the context of USB communication than in the context of networked financial transaction processing. In this document, “device” and “host” are used strictly as follows:

  • Device refers to the MagTek product that receives and responds to the command set specified in this document. Devices include oDynamo.

  • Host refers to the piece of general-purpose electronic equipment the device is connected or paired to, which can send data to and receive data from the device. Host types include PC and Mac computers/laptops, tablets, smartphones, teletype terminals, and even test harnesses. In many cases the host may have custom software installed on it that communicates with the device. When “host” must be used differently, it is qualified as something specific, such as “acquirer host” or “USB host.”

Similarly, the word “user” is used in different ways in different contexts. This document separates users

into more descriptive categories:

  • The cardholder

  • The operator (such as a cashier, bank teller, customer service representative, or server), and The developer or the administrator (such as an integrator configuring the device for the first time).

Because some connection types, payment brands, and other vocabulary name spaces (notably Bluetooth, EMV, smart phones, and more recent versions of Windows) use very specific meanings for the term “Application,” this document favors the term software to refer to software on the host that provides a user interface for the operator.

The word terminal uses the EMV definition, which may mean a stationary interface for a cashier or teller at a point of sale or bank, an ATM or other unattended device, a handheld service interface on an air or water craft, and so on. In some situations the terminal interacts with the operator, though in self-service situations the terminal might interact with a cardholder directly.

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.

About Connection Types

This device and related products use a common communication protocol across a variety of physical connection layers, which can include universal serial bus (USB), Ethernet, RS-232, and Bluetooth Low Energy (“Bluetooth LE”). The set of available connection layers depends on the device. Details for communicating with devices via each physical connection type are provided in section 3 Connection Types.

About Device Features

The information in this document applies to multiple devices. When developing solutions that use a specific device or set of devices, integrators must be aware of each device’s communication interfaces, features, and configuration options, which affect the availability and behavior of some messages. Table 1-1 provides a list of device features that may impact message availability and behavior.

Table - Device Features

Feature

oDynamo

Reserved

Reserved

Reserved

Reserved

Reserved

General Features

Signature Capture (“SC”)

No

Custom messages

No

Bitmaps

No

Clear text user data

No

Capacitive Keypad (“Cap Keypad”)

No

Power management

No

PCI 4.x Key Block

Yes

IntelliHead

No

Max financial card PAN length

19

MagneSafe 2.0 (MS 2.0)

No

Communication Interfaces

USB Connection to peripherals

No

USB Connection to host

Yes

TCP/IP over 802.11 wireless connection

No

Ethernet connection

Yes

Apple 30-pin connection

No

RS-232 connection

Yes

Bluetooth LE connection

No

EMV Features

Chip card contact

Yes

Chip card L1 mode

No

Chip card L2 mode

Yes

RID CAPK Key Slots

Yes

Multiple payment brand defaults

Yes

Feature

oDynamo

Reserved

Reserved

Reserved

Reserved

Reserved

Chip card contactless

No

PayPass support

No

payWave support

No

Expresspay support

No

D-PAS support

No

Configurable EMV Support

No

About SDKs

MagTek provides convenient Software Development Kits (SDKs) that include libraries for some connection types and development frameworks. These SDKs wrap the details of the connection in an interface that conceptually parallels the device’s internal operation, freeing developers from dealing with the details of the connection, and allowing them to focus on software business logic. In cases where SDK libraries are available, developers also have the option to revert to direct communication with the device using libraries available in the chosen development framework. This document provides information and support for the latter method. Information about using MagTek SDKs is available in separate documentation.

Last updated