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

Enumerations - B - E

BarCodeFormat

This enum refers to the type of barcodes to display.

Enum
Description

BLOB

Data is binary format

COMMAND

Data is a command in binary format

BLOB_BASE64

Data is Base64 encoded format

COMMAND_BASE64

Data is a command in Base64 format

BarCodeType

This enum refers to the type of barcodes to display.

Enum
Description

QRCODE

QR code

CaptureType

This enum refers to the type of customer information to capture.

Enum
Description

Unavailable

Capture unavailable

PhoneNumber

Capture the phone number

SocialSecurityNumber

Capture the social security number

ZipCode

Capture the zip code

EmployeeID

Capture Employee ID number

BirthDate

Capture birth date in USA format

ConnectionState

This enum refers to the readiness of the SDK to communicate with the device. This is not the physical attachment to a host system.

Enum
Description

Unknown

Device is in an unknown connection state.

Disconnected

Device is disconnected.

Connecting

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.

ConnectionType

This enum refers to the communication interface type of MagTek reader which the SDK will control.

Enum
Description

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

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

DataEntryType

This enum is reserved for future use.

Enum
Description

PIN

Request Personal Identification Number

Signature

Request Signature

SSN

Request Social security number

ZIPCODE

Request Zip code

BirthDate

Request Birth date

ActivationCode

Request Activation code

DeviceEvent

This enum refers to a change in the device status.

Enum
Description

None

No event to report.

DeviceResetOccured

A device reset had occurred.

DeviceResetWillOccur

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.

DeviceFeature

This enum refers to a featured supported by the device.

Enum
Description

None

No feature.

SignatureCapture

Supports signature capture

PINEntry

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

DeviceType

This enum refers to the type of MagTek reader which the SDK will control.

Enum
Description

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

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

ErrorType

This enum refers to the type of connection error.

Enum
Description

Unknown

Device is in an unknown connection state.

TimedOut

Device has timed out.

BluetoothOff

Bluetooth is off.

BluetoothUnauthorized

Bluetooth not paired.

NetworkOff

Network is off.

NetworkUnreachable

Network is unreachable.

SecurityRejected

Security rejected.

SecurityFailed

Security failed.

ConnectionFailed

Connection failed.

EventType

This enum refers to the type of event triggered by the device.

Enum
Description

ConnectionState

There was a change in the connection state of the device.

DeviceResponse

Device has responded to a command.

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.