Reference for the enumerated types used throughout the MagTek Universal SDK — the named constants for values such as device and transaction states, card types, and command options that appear in SDK calls and results. The enumerations are listed alphabetically across two pages.
Reference Section
Information Available
Reference for the SDK's enumerated types (device and transaction states, card types, option flags).
Reference for the SDK's enumerated types (device and transaction states, card types, option flags).
This enum refers to the type of barcodes to display.
BLOB
Data is binary format
COMMAND
Data is a command in binary format
This enum refers to the type of barcodes to display.
This enum refers to the type of customer information to capture.
This enum refers to the readiness of the SDK to communicate with the device. This is not the physical attachment to a host system.
This enum refers to the communication interface type of MagTek reader which the SDK will control.
This enum is reserved for future use.
This enum refers to a change in the device status.
This enum refers to a featured supported by the device.
This enum refers to the type of MagTek reader which the SDK will control.
This enum refers to the type of connection error.
This enum refers to the type of event triggered by the device.
BLOB_BASE64
Data is Base64 encoded format
COMMAND_BASE64
Data is a command in Base64 format
QRCODE
QR code
Unavailable
Capture unavailable
PhoneNumber
Capture the phone number
SocialSecurityNumber
Unknown
Device is in an unknown connection state.
Disconnected
Device is disconnected.
Connecting
USB
Universal Serial Bus supported devices: · eDynamo · DynaPro · mDynamo · DynaPro Go · Dynamag · DynaPro Mini · DynaMax · DynaFlex · tDynamo · DynaFlex Pro · kDynamo · DynaFlex II PED · cDynamo · DynaProx · iDynamo 6 · DynaFlex II Go
BLUETOOTH_LE
Bluetooth Low Energy devices: · DynaMax · DynaFlex II Go
BLUETOOTH_LE_EMV
PIN
Request Personal Identification Number
Signature
Request Signature
SSN
None
No event to report.
DeviceResetOccured
A device reset had occurred.
DeviceResetWillOccur
None
No feature.
SignatureCapture
Supports signature capture
PINEntry
SCRA
Secure Reader Authenticator devices. List includes but not limited to: * eDynamo * mDynamo * Dynamag * DynaMax * tDynamo * kDynamo * cDynamo * iDynamo 6
PPSCRA
PIN Pad Secure Reader Authenticator devices. List includes but not limited to: * DynaPro * DynaPro Go * DynaPro Mini
CMF
Unknown
Device is in an unknown connection state.
TimedOut
Device has timed out.
BluetoothOff
ConnectionState
There was a change in the connection state of the device.
DeviceResponse
Device has responded to a command.
Capture the social security number
ZipCode
Capture the zip code
EmployeeID
Capture Employee ID number
BirthDate
Capture birth date in USA format
Device is in the process of connecting. The next state is to be Connected.
Error
There was an error either connecting or disconnecting the device.
Connected
Device is connected and ready for transacting.
Disconnecting
Device is in the process of disconnecting. The next state will is to be Disconnected.
Bluetooth Low Energy with EMV supported devices: · eDynamo
BLUETOOTH_LE_EMVT
Bluetooth Low Energy with EMV supported devices: · tDynamo
TCP
Transmission Control Protocol supported devices: · DynaPro
TCP_TLS
Transmission Control Protocol with Transport Layer Security supported devices: · DynaPro Go
TCP_TLS_TRUST
Transmission Control Protocol with Transport Layer Security supported devices: · DynaPro Go
WEBSOCKET
WebSocket supported devices: · DynaFlex Pro · DynaFlex II PED
WEBSOCKET_TRUST
WebSocket supported devices. This will establish a TLS connection to device without requirement for name match. · DynaFlex Pro · DynaFlex II PED
SERIAL
UART supported devices
AIDL
AIDL devices: · DynaGlass
VIRTUAL
Virtual devices
MQTT
MQTT · DynaFlex II PED
Request Social security number
ZIPCODE
Request Zip code
BirthDate
Request Birth date
ActivationCode
Request Activation code
A device reset will occur soon. Host application may uses this as a warning to take appropriate actions.
DeviceBondingFailure
Host fails to pair with device.
DeviceTemperatureLow
The device’s temperature falls below the temperature set in Low Temperature Notification Level.
DeviceTemperatureHigh
The device’s temperature rises below the temperature set in High Temperature Notification Level.
DeviceBatteryLow
The battery charge reaches 15 percent. If a device is powered on with a charge that is already 15 percent or below, this notification is sent shortly after power up.
DeviceBatteryLowPowerDown
This notification is sent one minute before it automatically powers down the device. This occurs when the battery charge has reached 0 percent. Shutdown can be prevented by connecting the device to a USB power source.
Supports PIN entry
PANEntry
Supports PAN entry
ShowBarCode
Supports display of a barcode
ScanBarCode
Supports scanning a barcode
DisplayMessage
Supports display of messages
Buzzer
Has a buzzer
CardEmulation
Supports NFC card emulation
PersonalInfoEntry
Supports personal info entry
Common Message Structure devices. List includes but not limited to: * oDynamo
MMS
Apollo class devices. List includes but not limited to: * DynaFlex * DynaFlex Pro * DynaProx
Bluetooth is off.
BluetoothUnauthorized
Bluetooth not paired.
NetworkOff
Network is off.
NetworkUnreachable
Network is unreachable.
SecurityRejected
Security rejected.
SecurityFailed
Security failed.
ConnectionFailed
Connection failed.
DeviceExtendedResponse
Device has responded to an extended command.
DeviceNotification
Device has sent a notification.
CardData
Device has sent magnetic stripe data from a card swipe.
TransactionStatus
There was a change in transaction status.
DisplayMessage
Device has a message to display for the user.
ClearDisplay
Device has notified to clear the display of user messages on host app.
InputRequest
Device is requesting input from the user.
EnhancedInputRequest
Device is requesting input for enhanced application selection in response to entering the card’s payment system environment.
AuthorizationRequest
Device has sent the Authorization Request Cryptogram and associated block of EMV tags for a transaction. This block is meant to be sent to the transaction processor.
TransactionResult
Device has sent the result of the transaction.
PINBlock
Device has sent the PINBlock after the user has entered a PIN on the device.
Signature
Device has sent data which represents a signature from a user.
DeviceDataFile
Device has sent a data file.
OperationStatus
Device has sent an operation status of a command.
DeviceEvent
Device has sent change of device state.
UserEvent
Device has sent a notification related to user interaction with the device.
FeatureStatus
Device has sent status of a feature.
PINData
Device has sent data related to a PIN.
PANData
Device has sent data related to a PAN.
BarCodeData
Device has sent barcode data.
NFCEvent
Device has sent NFC event.
NFCData
Device has sent NFC data.
NFCResponse
Device has sent response to and NFC command.
NFCAPDUResponse
Device has sent response to an NFC APDU command for Mifare DESFire Tag.
NFCCardData
Device has sent NFC card data.
NFCDeviceEngagementData
Device has sent data after NFC engagement.
NFCPassThroughData
Device has sent NFC Pass-Through data.
NFCPassThroughResponse
Device has sent a response to NFC Pass- Through exchange.
GPOResponse
Device has GPO response.
TouchscreenSignatureCapture
Device has sent response to signature capture.
TouchscreenFunctionalButtonSelected
Device has sent a notification of a functional button selected.
TouchscreenTextStringButtonSelected
Device has sent a notification of a test string button selected.
TouchscreenAmountButtonSelected
Device has sent a notification of an amount button selected.
TouchscreenPresentCardFunctionalBut tonSelected
Device has sent a notification of a present card functional button selected.
TouchscreenPersonalInfoEntry
Device has sent a personal info entry.
This enum refers to the status of a specific feature reported from DeviceFeature.
NoStatus
No change in status
This enum refers to the type of image.
This enum refers to the type of specific information to retrieve from the device.
This enum refers to the operation status of the device.
This enum refers to which card type the device will perform a transaction.
This enum refers to the status of the transaction.
This enum refers to the type of user event reported by the device. These events relate to user interaction.
This enum refers to the Apple VAS and Google Wallet VAS mode. This controls how the VAS data is returned in the transaction ARQC. For details on Apple VAS data structure returned in a transaction see D998200383 DynaFlex Family Programmer’s Manual (COMMANDS).
This enum refers to the Apple VAS protocol. For details on Apple VAS data structure returned in a transaction see D998200383 DynaFlex Family Programmer’s Manual (COMMANDS).
Success
Success
Failed
Failed
TimedOut
Timed out
Cancelled
Cancelled
Error
Error
HardwareNA
Featured hardware not applicable for a status
BITMAP
BMP file
DeviceSerialNumber
FirmwareVersion
Firmware version of the device.
DeviceCapabilities
ASCII
Ascii data mode
Binary
Binary data mode
None
No update for the operation.
NFCMifareUltralight
Mifare Ultralight
MifareClassic
Mifare Classic
MifareDESFire
Mifare DESFire
AppleWalletMobileDESFire
NoStatus
No update for the operation.
Started
Device has started an operation.
Warning
MSR
For magnetic stripe cards.
Contact
For EMV chip cards.
Contactless
NoStatus
Set before the start of a transaction and before a card is presented to the device.
NoTransaction
No transaction in progress.
None
No events yet to occur.
ContactlessCardPresented
Contactless card has been presented.
Single
The device reads only VAS data from a tapped smartphone, or reads EMV payment data from a tapped card. When the device sends ARQC to conclude the transaction, it only includes either EMV payment data in container FC for cards, or includes VAS data in container FE for smartphones.
Dual
The device reads both VAS data and EMV payment data from a tapped smartphone, or reads EMV payment data from a tapped card. When device sends ARQC to the host to conclude the transaction, it includes EMV payment data in container FC and includes VAS data, if available, in container FE.
VASOnly
URL
URL VAS protocol
Full
Full VAS protocol
Capabilities of the device delimited by a comma.
Boot1Version
Boot 1 firmware version of the device.
Boot0Version
Boot 0 firmware version of the device.
FirmwareHash
Firmware hash comprised of part numbers, versions, and timestamps.
TamperStatus
Tamper status of the device. 0x00 = Not Tampered 0x01 = Tampered
OperationStatus
Operation status of the device. 0x01 = Offline 0x02 = Online
OfflineDetail
Offline details of the device. Bit 0 = Tamper problem present Bit 1 = Master Key problem present Bit 2 = Keys and Certificates problem present Bit 3 = Real Time Clock problem present Bit 4 = Random Number Generator problem present Bit 5 = Cryptography Engine problem present Bit 6 = Magnetic Stripe Reader Hardware problem present Bit 7 = Reserved
FirmwareVersionWLAN
Firmware version for WLAN module of the device.
FirmwareVersionBLE
Firmware version for Bluetooth LE module of the device.
BatteryLevel
Battery level of the device.
MifareClassic1K
Mifare Classic 1K
MifareClassic4K
Mifare Classic 4K
MifareDESFireLight
Mifare DESFire Light
MifareMini
Mifare Mini
MifarePlusEV1
Mifare Plus EV1
MifarePlusEV2
Mifare Plus EV2
MifarePlusSE
Mifare Plus SE
MifarePlusX
Mifare Plus X
MifareDESFireEV1
Mifare DESFire EV1
MifareDESFireEV2
Mifare DESFire EV2
MifareDESFireEV3
Mifare DESFire EV3
ISO14443TypeA
ISO 14443 Type A
ISO14443TypeB
ISO 14443 Type B
NFCCardTypeNotSupported
NFC Card Type Not Supported
mDL
Mobile Driver’s License
mDLDeviceEngagementSuccess
mDL Device Engagement Success
mDLDeviceEngagementFailed
mDL Device Engagement Failed
TagRemoved
Tag removed
Failed
Command failed
IOFailed
IO failed
AuthenticationFailed
Authentication failed
Apple Wallet mobile DESFire
Mifare2GoMobileDESFire
Mifare 2 Go Mobile DESFire
Device has sent a warning about the operation.
Failed
Device has failed an operation.
Done
Device has completed an operation.
For NFC contactless cards.
ManualEntry
For user to manually enter transaction data without any card access.
Barcode
For barcode.
BarcodeEncrypted
For encrypted barcode.
AppleVAS
For Apple VAS.
NFC
For NFC tag.
GoogleVAS
For Google Wallet Smart Tap VAS.
CardSwiped
A card was swiped into the device.
CardInserted
A card was inserted into the device.
CardRemoved
A card was removed from the device.
CardDetected
A card was detected by the device.
CardCollision
A card collision was detected by the device.
TimedOut
The transaction was not completed before a timeout period.
HostCancelled
The host software sent a cancel.
TransactionCancelled
The transaction was cancelled.
TransactionInProgress
The transaction is in progress.
TransactionError
There is an error during the transaction.
TransactionApproved
The transactions is approved.
TransactionDeclined
The transactions is declined.
TransactionCompleted
The transaction is completed.
TransactionFailed
The transaction failed.
TransactionNotAccepted
The transaction was not accepted by the device.
SignatureCaptureRequested
A signature capture is requested by the device.
TechnicalFallback
Due to technical reasons, the chip transaction cannot be completed by the reader.
QuickChipDeferred
Device has sent a “Z3” response code to the chip card.
DataEntered
Data has been entered on the device for a manual card entry transaction.
TryAnotherInterface
Due to removal of the chip card or error with contactless card, the transaction cannot be completed by the reader.
BarcodeRead
A barcode is read.
VASError
Apple VAS error occurred.
TransactionStartedFromDevice
The transaction has started by user interaction with the device.
TransactionStartedFromDeviceQuickChip
The Quick Chip transaction has started by user interaction with the device.
TransactionCancelledFromDevice
The transaction was cancelled from device.
ContactlessCardRemoved
Contactless card has been removed.
CardSeated
Card is seated into the chip station.
CardUnseated
Card was removed from the chip station.
CardSwiped
Magnetic stripe card was swiped.
TouchPresented
Touch screen sensor press detected.
TouchRemoved
Touch screen sensor release detected.
BarcodeRead
Barcode detected.
NFCMifareUltralightPresented
Mifare Ultralight presented.
MifareClassic1KPresented
Mifare Classic 1K presented.
MifareClassic4KPresented
Mifare Classic 4K presented.
MifareDESFireLightPresented
Mifare DESFire Light presented.
MifareMiniPresented
Mifare Mini Presented.
MifarePlusEV1Presented
Mifare Plus EV1 presented.
MifarePlusEV2Presented
Mifare Plus EV2 presented.
MifarePlusSEPresented
Mifare Plus SE presented.
MifarePlusXPresented
Mifare Plus X presented.
MifareDESFireEV1Presented
Mifare DESFire EV1 presented.
MifareDESFireEV2Presented
Mifare DESFire EV2 presented.
MifareDESFireEV3Presented
Mifare DESFire EV3 presented.
mDLPresented
Mobile Driver’s License presented.
NFCMifareUltralightRemoved
Mifare Ultralight removed.
MifareClassic1KRemoved
Mifare Classic 1K removed.
MifareClassic4KRemoved
Mifare Classic 4K removed.
MifareDESFireLightRemoved
Mifare DESFire Light removed.
MifareMiniRemoved
Mifare Mini removed.
MifarePlusEV1Removed
Mifare Plus EV1 removed.
MifarePlusEV2Removed
Mifare Plus EV2 removed.
MifarePlusSERemoved
Mifare Plus SE removed.
MifarePlusXRemoved
Mifare Plus X removed.
MifareDESFireEV1Removed
Mifare DESFire EV1 removed.
MifareDESFireEV2Removed
Mifare DESFire EV2 removed.
MifareDESFireEV3Removed
Mifare DESFire EV3 removed.
mDLRemoved
Mobile Driver’s License removed.
The device reads only VAS data from a tapped smartphone, and does not read data from a tapped card. If the tapped smartphone does not support VAS, the device does not detect or read from the smartphone. When the device send ARQC to conclude the transaction, it includes VAS data in container FE and does not include EMV payment data in container FC.
PaymentOnly
The device operates the same as EMV mode. It reads only EMV payment data from a tapped smartphone or a tapped card. When the device sends ARQC to conclude the transaction, it includes EMV payment data in container FC and does not include VAS data in container FE.
ECP2
The host can configure the ECP2 frame. See Apple ECP2.0 specification.