The device’s firmware can be compiled to use one of two available ECDSA P-521 key sets when signing and verifying the signature in Command 0xEEEE - Send Secured Command to Device.
This property indicates which of the two keys the firmware is configured to expect the host and device to use:
NFC Hardware’s Firmware Version - Property 2.1.2.9.1.1
Property Description
Property OID
2.1.2.9.1.1 / 0x020102090101
Name
NFC Hardware’s Firmware Version
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
0 - 255
Default
None
Description
The device uses this two-byte property, in most significant byte order, to report its NFC Hardware’s Firmware version. MS byte is major version. LS byte is minor version.
The device uses this two-byte property, in most significant byte order, to report its NFC Hardware’s EEPROM version. MS byte is major version. LS byte is minor version.
NFC Hardware’s Firmware Version- Get Request Example
NFC Hardware’s Firmware Version - Get Response Example
NFC Hardware’s EEPROM Version - Property 2.1.2.9.1.2
NFC Hardware’s EEPROM Version - Get Request Example
NFC Hardware’s EEPROM Version - Get Response Example
Securing Key
None
Min. Len (b)
N/A
Max. Len (b)
32
Data Type
ASCII String
Valid Values
Example:
Default
None
Securing Key
None
Min. Len (b)
4
Max. Len (b)
4
Data Type
IP4 Format/quad decimal (x.x.x.x)
Valid Values
0.0.0.0 to 255.255.255
Default
192.168.0.1
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – 0x02
Default
0x02
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – 0x01
Default
0x01
Securing Key
None
Min. Len (b)
N/A
Max. Len (b)
64
Data Type
ASCII String with no spaces
Valid Values
Any string
Example: test.mosquitto.org
Default
test.mosquitto.org
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
0x00 0x00 (0) – 0xFF 0xFF (65535) MSB first
Default
8883
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – 0x02
Default
0x00
Description
The device uses this property to determine how many days before a certificate expires it should start notifying the host that it is about to expire. If the value is set to 0, the notification will be disabled.
The notification will only be sent if TLS is enabled, and the notification will only be sent for they server certificate that the device is configured to use. The notification will be sent every time the first client connects to the device shortly after it connects.
Notification 0x1001 - Device Information Update category Key management, reason Certificate Expiring Soon is related.
The device uses this property to set up the Username for EAP-PEAP authentication method which is used to connect to an WiFi Access Point. Username is not used by PSK authentication method.
This OID is used to store a soft AP IP address. When a device starts AP mode, it reads this value as its IP address. A new value will be stored with this OID if a user modifies the soft AP IP address.
The device uses this property to disable/enable WLAN Feature.
0x00 = WLAN Disabled
0x01 = WLAN Enabled
Changes to this property do not take effect until the device is power cycled or reset.
The device uses this property to connect to broker on this network port. MQTT Port addresses are normally 8883 for secure (Recommended), 1883 for unsecure.
Reduce Power During USB Suspend - Property 1.2.2.2.1.1
Property Description
Property OID
1.2.2.2.1.1 / 0x010202020101
Name
Reduce Power During USB Suspend
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = HID only 0x01 = iAP2 only
0x02 = autodetect (iAP2 with HID fallback)
The autodetect option can allow a device to work with iAP2 hosts and HID hosts. With this option, every time the device is attached to a USB host it will first enumerate as an iAP2 device, if the device does not receive an iAP2 initialization sequence response from the host within 2 seconds the device will perform a soft USB detach from the host and then a soft USB attach and next enumerate as a USB HID device.
Default
0x02
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = NORMAL_BATTERY_CHARGING
0x01 = DYNAMIC_BATTERY_CHARGING
When the device is in NORMAL_BATTERY_CHARGING mode it charges continuously until full, if it is connected to a dedicated charger or a USB host device like a tablet.
When the device is VBUS_BATTERY_DYNAMIC_CHARGING mode the device will run off the battery only until it reaches the battery charge percentage defined in Property 1.2.2.2.1.4 Battery Charging Start Level, then it will charge until it reaches the battery charge percentage defined in Property 1.2.2.2.1.5 Battery Charging Stop Level. In this mode it will repeat this cycle repeatedly. However, if the device is connected to dedicated charger, it will charge until full and not run off the battery unless the charger is disconnected.
The Property 1.2.2.2.1.6 Battery Charging Schedule feature can optionally be enabled while in DYNAMIC_BATTERY_CHARGING mode. When ON-DUTY the charging behavior is as described above When OFF-DUTY it will charge until full and not run off the battery until ON-DUTY.
Default
0x00 NORMAL_BATTERY_CHARGING
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Range 0x0A – 0x63
0x0A = Minimum value (10%) 0x63 = Maximum value (99%)*
*The maximum value must be less than the value set in Property 1.2.2.2.1.5 Battery Charging Stop Level
Default
0x19 (25%)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Range 0x0B – 0x64
0x0B = Minimum value (11%) 0x64 = Maximum value (100%)*
*The minimum value must be greater than the value set in Property 1.2.2.2.1.4 Battery Charging Start Level
The Battery Charging Schedule determines when the goes ON-DUTY and OFF_DUTY. The start hour and minute are used to determine the start of ON-DUTY. The device will remain On-DUTY until the duration hour and minute expires. Then it will go OFF- DUTY.
ON-DUTY starts at 08:00 and lasts for 12 hours 0 minutes
Description
The device uses this property to determine whether it should reduce its power consumption when a USB host directs it to suspend. If this property is set to Disabled, the device will not have a USB compliant current draw when suspended, which, for example, allows it to continue to turn on LEDs and the display if present.
To activate changes made to this property, the device must be reset or power cycled.
The device uses this property to determine if it should behave as a USB HID device or an USB iAP2 device. USB HID devices can communicate with most hosts except for Apple hosts. USB iAP2 devices can communicate to Apple hosts like iPads and iPhones. The behavior affects USB enumeration and communications.
To activate changes made to this property, the device must be reset or power cycled.
The device uses this property to determine if it should charge continuously, or run off the battery only [even if it is plugged into a USB power source], or if it should dynamically run off the battery until it reaches a configurable low level before charging to a configurable high level, then run off the battery again (repeating this cycled indefinitely).
The device uses this property to determine the lowest charge percentage level the battery must reach, before the device starts charging the battery. This forces the device to run off the battery as much as possible, only charging when necessary.
To activate this property, NORMAL_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode must be enabled first.
The device uses this property to determine the highest charge percentage level the battery must reach, before the device stops charging the battery. This forces the device to run off the battery as much as possible and only charge when necessary.
To activate this property, NORMAL_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode must be enabled first.
The device uses this property to define on-duty hours. It consists of an on-duty starting time and on-duty duration. When on-duty the battery charging behavior matches the DYNAMIC_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode. While off-duty the battery charging behavior is the same except it will charge to 100%, instead of the stop level set in Property 1.2.2.2.1.5 Battery Charging Stop Level. NOTE: The battery charging schedule is an optional feature of DYNAMIC_BATTERY_CHARGING.
The battery charging schedule is disabled by default. After enabling it, the charging mode must also be set to DYNAMIC_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode. When disabled, the dynamic battery charging behavior does not take into account of on-duty or off-duty times, instead it charges according to the charging start and stop level properties only.
Battery Charging Stop Level - Get Response Example
Battery Charging Stop Level - Set Request Example
Battery Charging Stop Level - Set Response Example
Battery Charging Schedule - Property 1.2.2.2.1.6
Battery Charging Schedule - Get Request Example
Battery Charging Schedule - Get Response Example
Battery Charging Schedule - Set Request Example
Battery Charging Schedule - Set Response Example
About Configuration Mechanisms
The device provides two mechanisms for the host to retrieve information about the device and to configure / customize device behavior:
Properties are smaller configuration values (generally up to 255 bytes and often significantly smaller). The device stores properties in a hierarchical tree, where each property has its own unique ID (sometimes referred to as an Object Identifier or OID) that identifies its position in the tree. The host can set and get properties using the commands in Command Group 0xD1nn - Settings and Information. For further information about OIDs, see Appendix A Object IDs (OIDs) and ITU-T X660.
Files are larger configuration values, which include custom graphics files and large configuration data blobs such as EMV terminal and application settings. Each file has a unique identifier more akin to a file path in a file system. The host can set and get files using the commands in File Operations - Command Group 0xD8nn.
This section focuses on properties, which the host can either read from the device to retrieve device information (such as its PCI hardware ID, serial number, firmware revision numbers, etc.), or write to the device to change device behavior, or to store values for future reference.
Property unique IDs represent a tree structure, where each property is at the “leaf” level of the tree. Some operations allow the host to work with entire groups of properties (branches or even the trunk containing all its leaves) by using a property number representing a higher level of the tree.
Each property (a “leaf” in the tree) is described in a subsection below, including whether it can be written to, how it is secured, how to construct or interpret its value(s), and how it affects device behavior.
To reflect this hierarchy, this section of the document groups settings by major categories that correspond to the tree structure, which roughly breaks down into overall property type, module, and submodule.
1.1.2.nnn - SRED Settings - B
Property 1.1.2.4.1.6 - Key Mapping of User Data 1
This OID is reserved for Key Mapping of User Data 1.
Property 1.1.2.4.1.7 - Key Mapping of PIN-AES (Touch Only) -
Property Description
Property OID
1.1.2.4.1.7 / 0x010102040107
Name
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
0x00 = Disabled 0x01 = Enabled
Default
0x01
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
0x00 = Disabled 0x01 = Enabled
Default
0x01
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
0x00 = Disabled 0x01 = Enabled
Default
0x01
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
0x00 = Disabled 0x01 = Enabled
Default
0x01
Securing Key
Refer to 0xD112 Command.
Min. Len (b)
0x02
Max. Len (b)
0x02
Data Type
Binary
Valid Values
This OID is bit mapped as follows: Byte 0• bit 0: Card Holder Name• bit 1: Primary Account Number• bit 2: Expiration Date• bit 3: Service Code• bit 4: T1 Discretionary Data• bit 5: T2 Discretionary Data• bit 6 - 7: Reserved Byte 1• bit 0 - 7: ReservedThe host shall set all the reserved bits to 0.
Default
0x0000
Key Mapping of PIN-AES
Description
The device uses this property to determine which DUKPT Key Set and Usage shall be used for PIN-AES.
The device uses this property to determine whether it should accept AAMVA (driver’s license) and other permutations of ISO encoded cards in addition to ISO/ABA financial cards. If this is disabled, the EMV ARQC Type the device returns to the host includes Track Status = Error for any track that exists but does not comply with ISO/ABA financial card format.
The device uses this property to determine whether it should read include or suppress Track 1 data when reading and transmitting ISO/ABA account information from a card’s magnetic stripe.
The device uses this property to determine whether it should read include or suppress Track 2 data when reading and transmitting ISO/ABA account information from a card’s magnetic stripe.
The device uses this property to determine whether it should read include or suppress Track 3 data when reading and transmitting ISO/ABA account information from a card’s magnetic stripe.
The host can use this property to enable Selectable Card Data Encryption. Each bit enables a specific card data encryption by setting that bit to 1. Byte 0 is the first byte, bit 0 is the LSB of each byte. This is a secured OID, the set request shall be from 0xD112 command. If the Key DKPTM1F has not been injected, enabling any bits in this OID will return failure response status 80-02-05-27 (TR31 errors, Key not present). If the Key DKPTM1F becomes unavailable after this OID has been enabled, then this OID will be reset to 0 as a status indicator.
Property 1.1.2.6.1.1. - Selectable Card Data Encryption Enable
Get Request Example
Get Response Example
Set Request Example
Set Response Example
2.2.1.1.1.n - Device Common Configuration Information
Serial Number - Property 2.2.1.1.1.1
Property Description
Property OID
2.2.1.1.1.1 / 0x020201010101
Name
Device Serial Number
Securing Key
None
Min. Len (b)
10
Max. Len (b)
256
Data Type
Alphanumeric
Valid Values
Any string
Default
Description
The device uses this property to report its serial number. The left 3.5 bytes represent the 7 digit serial number, and the remaining half byte is always 0.
Example: Serial number B603226 is reported as 0xB6, 0x03, 0x22, 0x60.
The device uses this property to report its PCI Hardware ID. Customers can use this value to compare against the device’s certification records on the PCI web site.
The device uses this property to set SSID for WLAN settings. If the SSID is shorter than 32 bytes, all remaining bytes after the SSID should be set to zeros.
The device uses this property to set password for WLAN settings. If the password is shorter than 63 bytes, all remaining bytes after the password should be set to zeros.
For EAP-PEAP authentication, the maximum length of password is 32 bytes. The real password has to be <= 32 bytes, all bytes after the desired password must be set to zeroes.
For security, the Get request for this property will always return a value with 63 zeroes, so you can only set the password and not get it.
The device uses this property to set Device Name for WLAN settings. Device Name is registered to the DNS which adds the domain name to create a hostname. Use Hostname to connect to device WebSocket. If the Device Name is shorter than 64 bytes, all remaining bytes after the Device Name should be set to zeros.
The device uses this property to set Heartbeat Time for WLAN settings. Device will check the Websocket connection based on this timer setting. The unit is second.
The device uses this property to determine how many clients it will allow to connect to its WLAN WebSocket server at one time. Most use cases will only want to allow one client at a time. If more than one client is connected, all outgoing data from the device will be sent to all clients. For example, all notifications and all command responses will be sent to all clients. If more than one client is connected, any client can send a command to the device at any time. Since having more than one client send commands to the device at the same time can result in command collisions and unexpected device behavior, it is recommended that only one client be in charge of sending commands and that other clients only listen to outgoing messages. A use case for allowing more than once client may be to have a second client for diagnostic or monitoring purposes.
Property 2.1.2.5.6.4 Active Client Connections is related.
These sections of the DynaFamily Programmer's Manual details information on EMV Settings.
Applies to: All Dyna Family products
Settings in this group
Setting
Information
Part A of EMV Terminal ID settings.
2.3.1.2.1.n - System Status Device State Information
The device uses this property to report its operational status.
Online is the status the manufacturer populates in this property before shipping, and is the result of the device going through processes that configure its security subsystems and features. In this state, the device is fully functional and can perform transactions.
Offline means the device is no longer fully functional and can no longer perform transactions. The device automatically transitions to this state if it detects a problem with security or any of the subsystems it checks. For example, trying to open the device triggers a tamper response, which causes the device to change its operational status to Offline. To retrieve more information about the cause of an Offline status, the host can retrieve Property 2.3.1.2.1.2 Offline Status Detail.
The device uses this property to report the status of every subsystem that can cause the device’s operation status to be set to Offline in Property 2.3.1.2.1.1 Device Operational Status.
The property consists of a sequence of bytes where each bit in each byte represents the status of a subsystem. If a bit is set to one, then there is a problem with the subsystem, otherwise no problem was detected.
Some subsystems provide other properties or commands that can be used to get more information about the subsystem’s status. For example, Property 2.3.1.1.2.2 Tamper Sensors Activated and Property 2.3.1.1.2.3 Tamper Sensor Tampered.
2.1.2.3.B.1 - China Union Pay Kernel ID (Contactless Only) (Common Kernel)
China Union Pay Kernel ID (Contactless Only) (Common Kernel Only) - Property 2.1.2.3.B.1
Property Description
Name
China Union Pay Kernel ID
Property OID
2.1.2.3.B.1 / 0x020102030B01
2.1.2.nnn - Firmware Identification Information
This section details settings about the device's top-level firmware identifier — the composite firmware ID that ties together the individual component versions and checksums listed below.
Securing Key
None
Min. Len (b)
1
Max. Len (b)
16 (reserved for future expansion)
Data Type
Binary
Valid Values
Byte 0
· 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
Default
None
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = No external power supplied 0x01 = Power supplied by USB port
Default
None
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00..0x64
Default
None
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Precharge
0x01 = Fast charge – constant current
0x02 = Fast charge – constant voltage
0x03 = End of charge
0x04 = Charge complete
0x08 = No external power supplied
Default
None
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Signed Binary
Valid Values
0x80 .. 0x7F (-128 .. 127)
Default
None
Securing Key
None
Min. Len (b)
3
Max. Len (b)
3
Data Type
Unsigned Binary
Valid Values
HH (0x00 – 0x17) MM (0x00 – 0x3B) SS(0x00 – 3B)
Default
None
Securing Key
None
Min. Len (b)
18
Max. Len (b)
18
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
Variable
Max. Len (b)
75
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
11
Max. Len (b)
11
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
18
Max. Len (b)
18
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
Variable
Max. Len (b)
75
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
13
Max. Len (b)
13
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
19
Max. Len (b)
19
Data Type
Alphanumeric
Valid Values
Any string
Default
Securing Key
None
Min. Len (b)
Variable
Max. Len (b)
75
Data Type
Alphanumeric
Valid Values
Any string
Default
Description
The device uses this property to report the China Union Pay Kernel ID as string, padded with null characters.
The device's top-level firmware identifier — the composite firmware ID that ties together the individual component versions and checksums listed below.
0x00 = Infinite timeout 0x01..0xFE = Timeout in seconds 0xFF = Use Transaction Timeout parameter in Command 0x1001 - Start Transaction
Default
0xFF
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00..0xFF
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
102
Data Type
Binary
Valid Values
00 or see Table 393 - VAS Merchant ID and URL Type
Default
0x00
9F29
Var up to 0x40
Merchant URL
B
O
Securing Key
None
Min. Len (b)
1
Max. Len (b)
102
Data Type
Binary
Valid Values
00 or see Table 393 - VAS Merchant ID and URL Type
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
102
Data Type
Binary
Valid Values
00 or see Table 393 - VAS Merchant ID and URL Type
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
102
Data Type
Binary
Valid Values
00 or see Table 393 - VAS Merchant ID and URL Type
Default
0x00
Description
The device uses this property to report its Terminal ID / Terminal Identification in tag 9F1C in all EMV-related communication. Merchants usually configure each device with a different terminal ID per their own proprietary system standards to help identify the source of a transaction.
Securing Key
None
Min. Len (b)
8
Max. Len (b)
8
Data Type
Alphanumeric
Valid Values
Any string
Default
“00000000” (0x3030303030303030)
Property OID
1.1.1.1.1.2 / 0x010101010102
Name
EMV ARQC Message Tag List
Description
The device uses this property when it generates an EMV ARQC Type data object, to determine what tags to include in the data object. It serves the same purpose that MagTek custom tag DFDF02 serves on some other MagTek devices. For the DynaFlex II family the CDOL tag list generated by the card is checked, and any unsupported tags mentioned in the CDOL also gets added to the EMV ARQC Type data object.
Property OID
1.1.1.1.1.3 / 0x010101010103
Name
EMV Batch Data Tag List
Description
The device uses this property when it generates an EMV Batch Data Type data object to contain transaction result data, to determine what tags to include in the data object. It serves the same purpose that MagTek custom tag DFDF17 serves on some other MagTek devices. For the DynaFlex II family the CDOL tag list generated by the card is checked, and any unsupported tags mentioned in the CDOL also gets added to the EMV Batch Data Type data object.
Property OID
1.1.1.1.1.4 / 0x010101010104
Name
EMV Reversal Data Tag List
Description
The device uses this property when it generates an EMV Batch Data Type data object to contain reversal data, to determine what tags to include in the data object. It serves the same purpose that MagTek custom tag DFDF05 serves on some other MagTek devices.
Property OID
1.1.1.1.1.5 / 0x010101010105
Name
ARPC Receive Timeout
Description
The device uses this property to determine how long to wait for the host to send Command 0x1004 - Resume Transaction with ARPC data before it times out and continues a transaction the host started with Command 0x1001 - Start Transaction.
Property OID
1.1.1.1.1.6 / 0x010101010106
Name
ARPC Retry Attempts
Description
The device uses this property to control its ARPC Retry Attempts. If a timeout occurs when the device is waiting for the host to send Command 0x1004 - Resume Transaction with ARPC data, the device re-sends Notification 0x0101 - Transaction Information Update to report ARQC Update and waits for ARPC data again, up to the number of retries specified by this property. After the final retry, the device continues with the transaction.
Property OID
1.1.1.1.1.7 / 0x010101010107
Name
Apple VAS Merchant ID and URL Slot 1
Description
The device uses this property for Apple VAS processing to configure the device’s supported Merchant ID and URL.
9F25
0x20
Merchant ID
B
Property OID
1.1.1.1.1.8 / 0x010101010108
Name
Apple VAS Merchant ID and URL Slot 2
Description
The device uses this property for Apple VAS processing to configure the device’s supported Merchant ID and URL.
Property OID
1.1.1.1.1.9 / 0x010101010109
Name
Apple VAS Merchant ID and URL Slot 3
Description
The device uses this property for Apple VAS processing to configure the device’s supported Merchant ID and URL.
Property OID
1.1.1.1.1.A / 0x01010101010A
Name
Apple VAS Merchant ID and URL Slot 4
Description
The device uses this property for Apple VAS processing to configure the device’s supported Merchant ID and URL.
EMV Settings - Get Request
EMV Settings - Get Response
EMV Settings - Set Request
EMV Settings - Set Response
EMV ARQC Message Tag List - 1.1.1.1.1.2
EMV ARQC Message Tag List - Get Request
EMV ARQC Message Tag List - Get Response
EMV ARQC Message Tag List - Set Request
EMV ARQC Message Tag List - Set Response
EMV Batch Data Tag List - Property 1.1.1.1.1.3
EMV Batch Data Tag List - Get Request
EMV Batch Data Tag List - Get Response
EMV Batch Data Tag List - Set Request
EMV Batch Data Tag List - Set Response
EMV Reversal Data Tag List (EMV Contact Only) - Property 1.1.1.1.1.4
EMV Reversal Data Tag List (EMV Contact Only) - Get Request
EMV Reversal Data Tag List (EMV Contact Only) - Get Response
EMV Reversal Data Tag List (EMV Contact Only) - Set Request
EMV Reversal Data Tag List (EMV Contact Only) - Set Response Example (Hex)
ARPC Receive Timeout - Property 1.1.1.1.1.5
ARPC Receive Timeout - Get Request Example (Hex)
ARPC Receive Timeout - Get Response Example (Hex)
ARPC Receive Timeout - Set Request Example (Hex)
ARPC Receive Timeout - Set Response Example (Hex)
ARPC Retry Attempts - Property 1.1.1.1.1.6
ARPC Retry Attempts - Get Request Example (Hex)
ARPC Retry Attempts - Get Response Example (Hex)
ARPC Retry Attempts - Set Request Example (Hex)
ARPC Retry Attempts - Set Response Example (Hex)
Apple VAS Merchant ID and URL Slot 1 - Property 1.1.1.1.1.7
Apple VAS Merchant ID and URL Slot 1 - Get Request Example (Hex)
Apple VAS Merchant ID and URL Slot 1 - Get Response Example (Hex)
Apple VAS Merchant ID and URL Slot 1 - Set Request Example (Hex)
Apple VAS Merchant ID and URL Slot 1 - Set Response Example (Hex)
Apple VAS Merchant ID and URL Slot 2 - Property 1.1.1.1.1.8
Apple VAS Merchant ID and URL Slot 2 - Get Request Example (Hex)
Apple VAS Merchant ID and URL Slot 2 - Get Response Example (Hex)
Apple VAS Merchant ID and URL Slot 2 - Set Request Example (Hex)
Apple VAS Merchant ID and URL Slot 2 - Set Response Example (Hex)
Apple VAS Merchant ID and URL Slot 3 - Property 1.1.1.1.1.9
Apple VAS Merchant ID and URL Slot 3 - Get Request Example (Hex)
Apple VAS Merchant ID and URL Slot 3 - Get Response Example (Hex)
Apple VAS Merchant ID and URL Slot 3 - Set Request Example (Hex)
Apple VAS Merchant ID and URL Slot 3 - Set Response Example (Hex)
Apple VAS Merchant ID and URL Slot 4 - Property 1.1.1.1.1.A
Apple VAS Merchant ID and URL Slot 4 - Get Request Example (Hex)
Apple VAS Merchant ID and URL Slot 4 - Get Response Example (Hex)
Apple VAS Merchant ID and URL Slot 4 - Set Request Example (Hex)
Apple VAS Merchant ID and URL Slot 4 - Set Response Example (Hex)
This property specifies a list of tags to be included in the encrypted portion of the ARQC and batch data (0xDFDF59/0xFC).
For EMV transactions, any tags not present in this list will not appear encrypted in the ARQC/batch data but will instead be included in the cleartext portion of the ARQC (0xF9/0xFA/0x70) and batch data (F9/F2).
For MSR transactions, the behavior is the same but there's an additional property that specifies which tags to include in cleartext (Property 1.1.1.1.5.3 MSR Cleartext Tag List).
For MSR transactions, only tags that are present in that list will appear in cleartext.
This OID contains a 32-bit bitmap. Each bit indicates the status of a transaction key. A bit value of 1 indicates the corresponding key has been injected.
The device maps this property to its internal register that enables its internal real-time clock.
Need More Help
Need Help?
For additional support, please contact MagTek Support:
Technical Support:
📧 Email:
1.2.nnnn - Device Settings
Device Settings
These sections of the DynaFamily Programmer's Manual details information on sending masked/tracking data..
Applies to: All Dyna Family products
Settings in this group
Setting
Information
Configure how the device runs financial transactions — EMV terminal and kernel parameters, supported entry methods, and amount, currency, and timeout handling.
Read the device's core identity and status: model name, serial number, firmware and boot versions, real-time clock, and operational state. These are mostly read-only values for identifying and health-checking the reader.
Configure Wi-Fi connectivity on WLAN-equipped models, including network SSID, security mode, and credentials. Applies only to devices with a WLAN radio.
Configure the USB interface on USB-connected devices, including communication mode and power behavior during USB suspend. Applies only when connected over USB.
2.3.1.1.2.n - System Status Security Protection Information
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Unlocked, 0x01 = Locked
Default
0x00
Securing Key
See Command 0xD112 - Set Property (Secured).
Min. Len (b)
4
Max. Len (b)
63
Data Type
Binary
Valid Values
It can only contain any printable ASCII character.
Default
0x34 0x33 0x32 0x31 (“4321”)
Description
This property can be used to get or set the device lock state. Getting this property does not require security, however setting it does. Setting it requires the use of Command 0xD112 - Set Property (Secured) which requires MagTek's involvement. To set the device lock state without involving MagTek use Command 0xEF04 – Load LTPK Protection Key. The value of the device lock state will revert to the value of Property 1.2.5.2.1.2 Device Lock State After Reset after a reset or a power cycle. See Device Lock Feature for more information.
Securing Key
See Command 0xD112 - Set Property (Secured).
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Unlocked, 0x01 = Locked
Default
See Property 1.2.5.2.1.2 Device Lock State After Reset.
This property can be used to get or set what Property 1.2.5.2.1.1 Device Lock State will be set to after the device is reset or power cycled. Systems that use the optional device lock feature should set this property to locked, otherwise all someone would need to do to unlock the device would be to power cycle or reset it. The value of the device lock state after reset property is stored in non-volatile memory so changes made to it will persist after the device is reset or power cycled. See Device Lock Feature for more information.
This property can be used to set the device lock passcode. The value of the device lock passcode is stored in non-volatile memory so changes made to it will persist after the device is reset or power cycled. For security, the host can’t get the value of the device lock passcode from the device. If the host gets this property, the device will always return a length of 0 and no value. Setting this property requires security. Setting it requires the use of Command 0xD112 - Set Property (Secured) which requires MagTek's involvement. To set the device lock passcode without involving MagTek use Command 0xEF07 – Change Device Lock Passcode. See Device Lock Feature for more information.
The device maps this property to its internal register that enables its internal real-time clock. Because the device ensures that register is enabled every time it powers up, this property should always report Real Time Clock Enabled.
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Real Time Clock Not Enabled 0x01 = Real Time Clock Enabled
The device uses this property to report whether its tamper sensors have been activated using Command 0xF016 - Activate Device Security (MAGTEK INTERNAL ONLY). A device that is operating normally should always have its tamper sensors activated.
The device uses this property to report whether a tamper sensor has tampered. A device that is operating normally should not reported that it has been tampered with. To examine the device’s tamper history to determine the cause, use Command 0xF014 - Read Log (MAGTEK INTERNAL ONLY) or Command 0xF015 - Read Log & Clear Tamper (MAGTEK INTERNAL ONLY).
The device uses this property to set the MQTT Keep Alive timing. Value is in seconds, used to guarantee the connection between device and MQTT broker remains active. A value of 0 disables Keep Alive monitoring.
These sections of the DynaFamily Programmer's Manual details two mechanisms - properties - for the host to retrieve information about the device and to configure / customize device behavior:
This section details the settings involving masked data.
This section details the settings involving payment brands.
This section details the settings involved with firmware numbers.
This section involves the settings involved with hardware serial numbers.
This sections involves the settings involving systems status.
Setting
Information
Part A of EMV Terminal ID settings.
Part B of EMV Terminal ID settings.
Part C of EMV Terminal ID settings.
Setting
Information
The device uses this property to determine what character it should use when sending masked ISO/ABA track data.
The device uses these properties to determine which DUKPT Key Set and Usage shall be used
Setting
Information
Configure how the device runs financial transactions — EMV terminal and kernel parameters, supported entry methods, and amount, currency, and timeout handling.
Continues the transaction group with the remaining financial/EMV properties, such as contactless and additional processing options.
Read the device's core identity and status: model name, serial number, firmware and boot versions, real-time clock, and operational state. These are mostly read-only values for identifying and health-checking the reader.
Notification
Information
The device's top-level firmware identifier — the composite firmware ID that ties together the individual component versions and checksums listed below.
Part number, version, and build details for the device's core application firmware — the main firmware that runs the reader.
Part number and version for the EMV firmware component that handles Level 2 EMV processing for contact and contactless transactions.
Notification
Information
The device uses this property to report its serial number.
Notification
Information
This OID contains a 32-bit bitmap. Each bit indicates the status of a transaction key,
The device maps this property to its internal register that enables its internal real-time clock.
The device uses this property to report its operational status.
Notification
Information
For modular management of device functions, information, and settings, this standard makes extensive use of Object Identifiers (also known as Object IDs or OIDs) as defined in ITU-T X.660 | ISO/IEC 9834-1.
Barcode symbology refers to the way in which data is encoded in a barcode. It uses either spaced lines, dots or squares.
This section will help erase already existing EMV configurations.
Configure Wi-Fi connectivity on WLAN-equipped models, including network SSID, security mode, and credentials. Applies only to devices with a WLAN radio.
Configure the USB interface on USB-connected devices, including communication mode and power behavior during USB suspend. Applies only when connected over USB.
When the device sends masked track data, it replaces some characters in the track data with a specified mask character. The specific characters the device masks depends on the card encode type. The device only selectively masks data that came from ISO/ABA cards (Financial Cards with ISO/IEC 7813 Format code B); it sends data from all other card types entirely unmasked.
The device masks all fields from ISO/ABA cards except a number of configurable leading and trailing characters of the PAN. See Property 1.1.2.2.1.3 PAN Number of Leading Unmasked Characters and Property 1.1.2.2.1.4 PAN Number of Trailing Unmasked Characters.
For chip card transactions, masked track 2 data is contained in TLV data object DFDF4D. For magnetic stripe transactions, masked track 1, 2 and 3 data is contained in TLV data objects DFDF31, DFDF33 and DFDF35, respectively.
Table 513 below provides an example of data from tracks 1, 2, and 3 of an ISO/ABA card after it has been decrypted or if the device has sent it in the clear. Table 514 shows the same data as it might appear with a specific set of masking rules applied.
This OID is reserved for Mey Mapping of MagTek Token.
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
Min 0x00
Max 0x08, if PAN length is less than 16, the number of unmasked characters will be limited to 6.
Default
0x04
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
Min 0x00 Max 0x04
Default
0x04
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
0x00 = Disabled 0x01 = Enabled
Default
0x01
Securing Key
None
Min. Len (b)
0x01
Max. Len (b)
0x01
Data Type
Binary
Valid Values
0x00 = Disabled 0x01 = Enabled
Default
0x00
Securing Key
None
Min. Len (b)
0x03
Max. Len (b)
0x03
Data Type
Binary
Valid Values
See DUKPT Key Mapping for detail information.
Default
0x00, 0x00, 0x01
Securing Key
None
Min. Len (b)
0x03
Max. Len (b)
0x03
Data Type
Binary
Valid Values
See DUKPT Key Mapping for detail information.
Default
0x20, 0x07, 0x04
Securing Key
None
Min. Len (b)
0x03
Max. Len (b)
0x03
Data Type
Binary
Valid Values
See DUKPT Key Mapping for detail information.
Default
0x20, 0x07, 0x02
Securing Key
None
Min. Len (b)
0x03
Max. Len (b)
0x03
Data Type
Binary
Valid Values
See DUKPT Key Mapping for detail information.
Default
0x20, 0x07, 0x04
Description
The device uses this property to determine what character it should use when sending masked ISO/ABA track data. If the Property 1.1.2.2.1.5 PAN MOD 10 Check Digit Correction is enabled, the masked portions of the track will always be masked with ‘0’. For more information about masking, see the information at the bottom of this section.
The device uses this property to determine how many of the leading characters of the PAN the device sends unmasked in Masked Track x Data in ISO/ABA account information For details about ISO/ABA track masking, see Property 1.1.2.2.1.2 ISO/ABA Masking Character.
The device uses this property to determine how many of the trailing characters of the PAN the device sends unmasked in Masked Track x Data in ISO/ABA account information For details about ISO/ABA track masking, see Property 1.1.2.2.1.2 ISO/ABA Masking Character.
The device uses this property to determine whether it should modify one of the masked PAN digits such that the masked PAN passes the Luhn MOD-10 algorithm check. If this property is enabled, the device uses masking character ‘0’ to mask the PAN, regardless of the setting in Property 1.1.2.2.1.2 ISO/ABA Masking Character, and masks the remainder of the track data with the configured masking character.
The device uses this property to determine whether to use the Luhn MOD-10 algorithm to validate card number (PAN) digits a cardholder or operator enters in manual card entry mode during Command 0x1001 - Start Transaction. If validation is enabled, the device checks the PAN digits during entry, and until the PAN passes the check, the device disables the ENTER key, sounds an error tone when the Enter key is pressed (if the command has audio feedback enabled), and stays at the Card Number prompt until the cardholder or operator presses the Cancel button or corrects the PAN.
The device uses this property to determine how to present a sequence of pages to the host, prompting the cardholder or operator to enter the specified sequence of values.
This property contains the Bluetooth® device name, which is typically used by the host software to present an operator with a list of devices to interact with. To avoid ambiguity, if the solution specifies that more than one device of the same name will be available, MagTek recommends including a unique identifier in the device name so the operator can differentiate.
The name should not contain any null string characters (0x00) at the beginning or in the middle, 0x00 can be used at the end of the name for padding to a total length of 20 characters. When setting this property, you can enter 0 to 20 characters. If set to a length of 0, the value reverts to its original default value described below. After modifying the Bluetooth® device name, you must reset the Bluetooth® LE module.
When getting this property, device will always return 20 characters If the name is less than 20 characters long, device will return 0x00 for the remaining characters.
Securing Key
None
Min. Len (b)
0
Max. Len (b)
20
Data Type
Binary
Valid Values
Default
A prefix, such as “DF II Go-“ for DynaFlex II Go, followed by the device’s serial number. For example, “DF II Go-B603226”.
Devices are always deployed with the serial number loaded, but prior to loading the serial number at MagTek, the prefix will be followed by the second to last and the last least significant bytes of the Bluetooth® device address converted to ASCII hex. For example, “DF II Go-97C2”.
This two-byte property, in most significant byte order, contains the Interval Min value in
1.25 millisecond units that the device sends to a Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for details. Only values between 6 and 3200 are valid.
After the host changes this property, the device must be reset before the changes will take effect.
This two-byte property, in most significant byte order, contains the Interval Max value in
1.25 millisecond units that the device sends to a Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for more details. Only values between 6 and 3200 are valid.
After the host changes this property, the device must be reset before the changes will take effect.
This two byte property, in most significant byte order, contains the Slave Latency value the device sends to the Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for details. Only values between 0 and 499 are valid.
After the host changes this property, the device must be reset before the changes will take effect.
This two-byte property, in most significant byte order, contains the value of the Timeout Multiplier sent in 10 millisecond units that the device sends to a Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for details. Only values between 10 and 3200 are valid.
After the host changes this property, the device must be reset before the changes will take effect.
Bluetooth® LE Connection Parameter Update Request Control
Description
The device uses this property to determine if the Bluetooth® LE connection parameter update request control is enabled. When it is enabled, the device sends a connection parameter update request once after each Bluetooth® LE connection.
After the host changes this property, the device must be reset before the changes will take effect.
This two property, in most significant byte order, contains the device’s minimum Bluetooth® LE advertising interval in 625 microsecond increments. This property, combined with Property 1.2.2.3.1.8 Bluetooth® LE Maximum Advertising Interval, specifies the Bluetooth® LE advertising interval the device uses. Smaller advertising intervals cause the device to consume more power when advertising, which may be a concern when running on battery power.
Only values between 32 (20ms) and 65535 (40.96s) are valid. The host may need to adjust the maximum advertising interval property when changing this property; if the maximum advertising interval is less than the minimum, the device may behave unpredictably.
After the host changes this property, the device must be reset before the changes will take effect.
This two-byte property, in most significant byte order, contains the device’s maximum Bluetooth® LE advertising interval in 625 microsecond increments. This property, combined with Interval, specifies the Bluetooth® LE advertising interval the device uses. Smaller advertising intervals cause the device to consume more power when advertising, which may be a concern when running on battery power.
Only values between 32 (20ms) and 65535 (40.96s) are valid. The host may need to adjust the minimum advertising interval property when changing this property. If the minimum advertising interval is greater than the maximum, the device may behave unpredictably.
After the host changes this property, the device must be reset before the changes will take effect.
The device uses this property to determine if the Bluetooth® LE Never Advertise is enabled. When it is enabled, the device never advertises. This mode may be useful for operators who only want to use the USB interface and don’t want the device to advertise.
After the host changes this property, the device must be reset before the changes will take effect.
The device uses this property to determine if Bluetooth® LE Debug Mode is enabled. When it is enabled, the secure connections bonding uses known debug keys, so that the encrypted packet can be opened by a Bluetooth® protocol analyzer. Bondings made in debug mode are unsecure. This mode should only be enabled for debugging for development purposes and not for regular device use.
Prior to enabling or disabling Debug Mode, the following should be done. Erase all of the device's bonds with Command 0x1F05 – Erase All Bluetooth® LE Bonds (Bluetooth® LE Only). Forget the device on all hosts that have paired with it by using the host's Bluetooth® settings application. Reboot all of those hosts.
Some hosts like Windows 10 will not pair with devices that use known debug keys.
If the value of this property is set to 0, Debug Mode is disabled. If it is set to 1, Debug Mode is enabled.
After the host changes this property, the device must be reset before the changes will take effect.
The device uses this property to report the certificate chain used for server certificate. Server Certificate Chain Select is set by loading a Trust Configuration File.
The device uses this property to report a list of available access points. The access points are in a list of tags starting with 0xA0 and incrementing. The list can contain up to 20 access points. Each access point contains two tags. Tag 0x80 contains the access point’s SSID. The SSID is a text string of 1 to 32 characters. Tag 0x81 is the RSSI for the access point. The RSSI is a signed binary number between -30 and -90.
The device automatically chooses the application that is mutually supported by the card and the terminal, based on the priority order specified by the card. This is the default and is standard EMV transaction flow behavior.
0x01 – Reserved 0x02 – Reserved
0x03 – Enhanced Prompt Cardholder.
The device sends the host Notification 0x1803 – 02 02 00 00 (Display Cardholder, Data Attached, Reserved) to request that the cardholder select from a list of available applications. Each application may include additional tags such as - priority indicator, Issuer Country Code and Issuer Identification Number. After the cardholder selects an application, the host passes the selection to the device using Command 0x1802 - Report Cardholder Selection to device to return the cardholder’s selection to the device.
0x00 = Include signature data in EMV Batch Data Type
0x01 = RESERVED. Make signature data available as file. Use Command 0xD821 - Start Get File from Device to request file type Signature Capture File to retrieve the data as a Signature Capture File Type.
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = No Wait Time. If the device uses this setting, the host must wait at least one second after receiving Notification 0x0105 - Transaction Operation Complete before performing any other operations.
0x01..0xFF = Wait the Specified Number of Seconds
Default
0x01 (second)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Disable 0x01 = Enable
Default
0x00 - Disabled
Securing Key
None
Min. Len (b)
16
Max. Len (b)
16
Data Type
Binary
Valid Values
Default
49454D4B 41455242 214E4143 554F5946
Securing Key
None
Min. Len (b)
16
Max. Len (b)
16
Data Type
Binary
Valid Values
Default
00000000 00000000 00000000 00000000
Securing Key
None
Min. Len (b)
16
Max. Len (b)
16
Data Type
Binary
Valid Values
Default
00000000 00000000 00000000 00000000
Securing Key
None
Min. Len (b)
16
Max. Len (b)
16
Data Type
Binary
Valid Values
Default
00000000 00000000 00000000 00000000
Description
The device uses this property to determine whether it should automatically implement payment brand fallback rules without host intervention when running Command 0x1001 - Start Transaction.
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = No device-driven fallback 0x01 = Device-driven fallback enabled
The host can use this property to change whether the device automatically prompts the cardholder for a signature when running Command 0x1001 - Start Transaction, or leaves the triggering of signature capture prompts to the host.
The device uses this property to determine whether to include signature capture coordinate data in TLV data object DFDF3E when it returns EMV Batch Data Type while running Command 0x1001 - Start Transaction.
The device uses this property to determine how long to wait, in seconds, for Command 0x1801 - Request Cardholder Signature while running Command 0x1001 - Start Transaction.
The device uses this property to enable/disable contactless low power card detect (Proximity Detection Mode). When disabled, device will read a contactless card as soon as the card is detected. If enabled, device will track and delay reading a contactless card, allowing user to use Contact or MSR card slots.
MIFARE Ultralight AES OriginalityKey. - Get Request Example
MIFARE Ultralight AES OriginalityKey. - Get Response Example
MIFARE Ultralight AES OriginalityKey. - Set Request Example
MIFARE Ultralight AES OriginalityKey. - Set Response Example
Valid Values
Note that if the device is configured to use this option, the cardholder must hold the card or contactless payment device in contact with the device for until cardholder application selection is complete, otherwise the device will report the transaction failed. For this reason, MagTek does not recommend using this setting.
1.2.7.nnn - System Settings - B
Device Reset Occurred Notification Control - Property 1.2.7.1.1.1
Property Description
Property OID
1.2.7.1.1.1 / 0x010207010101
Name
Device Reset Occurred Notification Control
1.2.3.nnn - User Interface Settings - B
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Not acknowledged. Only the device can set to this value. 0x01 = Acknowledged. Do not continue to send the notification.
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Never send this notification.
0x01..0xFF = Number of minutes before a reset to send the notification message.
Default
0x03
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
First byte 0 - 23 hours and second byte 0 - 59 minutes = Reset at the time of day specified. The time of day specified should be 24-hour Universal Time Coordinated (UTC). For example, values of 0 0 would be 12:00am UTC and values of 23 59 (0x17 0x3B) would be 11:59pm UTC.
First byte 0xFF and second byte 0xFF = Auto reset 23 hours after booting up.
First byte 0xEE and second byte 0xEE = Device enters Restricted Mode 24 hours after booting up.
Default
0xFF 0xFF
Securing Key
None
Min. Len (b)
4
Max. Len (b)
4
Data Type
Binary
Byte 0
· bit 0 = Reason: Contactless Card Presented
· bit 1 = Reason: Contactless Card Removed
· bit 2 = Reason: Card Seated in Slot
· bit 3 = Reason: Card Unseated from Slot
· bit 4 = Reason: Card Swiped
· bit 5 = Reason: Touch Sensor Press Detected
· bit 6 = Reason: Touch Sensor Release Detected
Default
0x00, 0x00, 0x00, 0x00 (all User Event notifications disabled)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
· 0x00 = Invalid value. (will be converted to 0x02 in the firmware)
· 0x01 to 0xFF = 1 to 255 seconds
Default
0x02 (2 seconds)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x0A..0x64
Default
0x64 (100%) if WLAN device 0x50 (80%) for all other devices
Changes to this property will be applied permanently and will not be overwritten in the event of a reset, FW update, etc.
Description
The device uses this property to control behavior of the Device Reset Occurred
notification in Notification 0x1001 - Device Information Update.
Changes to this property do not take effect until the device is power cycled or reset.
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Never send this notification.
0x01..0xFE = The frequency in seconds the device should repeat sending the notification until the host requests that it stop with Property 1.2.7.1.1.2 Device Reset Occurred Notification Acknowledged.
The host can use this property to acknowledge it has received the Device Reset Occurred notification in Notification 0x1001 - Device Information Update and to request that the device stop sending it.
Alternatively, because the device automatically sets the value of this property to 0x00 on boot, the host can use this property to detect power cycles or resets using a polling method. To implement this, the host should read the value on a set schedule (for example, every 2 seconds). If the host finds a value of 0x00, a power cycle or reset has occurred, and the host should set the value back to 0x01. From that point until the next power cycle or reset, the value will remain 0x01.
Changes made to this property will not persist after a power cycle or reset. After a power cycle or reset, this property has a value of 0x00 until the host changes it to 0x01.
This property controls the device’s auto reset feature. The auto reset feature can be configured such that the device automatically resets 23 hours after booting up or at a specific time of day. Or device can be configured to enter a restricted mode after 24 hours without a reset or power down. When device enters restricted mode it will respond to first command received with Response Message - Request Handler: Group 0x02, Subgroup 0x01, Code 0x1D. Device then sends Notification 0x1001 – Device Information Update: Category 0x00, Reason 0x01 - Reset will occur soon. Device will then auto reset. The auto-reset feature cannot be disabled.
See 24 Hour Automatic Reset PCI Requirement for more information.
Changes to this property do not take effect until the device is power cycled or reset.
The host can use this property to enable notification reasons defined in Notification 0x1001 - Device Information Update in the User Events Category. Each bit enables a specific Reason by setting that bit to 1. Byte 0 is the first byte, bit 0 is the LSB of each byte.
The device only detects these user events and sends these notifications when it is idle. While processing a command (not idle), such as when processing a transaction with Command 0x1001 - Start Transaction, the device only sends notifications related to the command it is currently processing.
Notification reasons may consume power when idle. For example, enabling Contactless reasons requires the device to continuously consume some radio frequency power to detect the presence of a contactless card when idle. To conserve power, only enable the notification reasons that are required by the solution design, if any. The readers and their associated notifications will be disabled if the battery charge is 5 percent or lower.
Changes to this property do not take effect until the device is power cycled or reset.
This parameter defines the number of seconds the device waits for the host to take action (by sending Command 0x1001 - Start Transaction) after the device sends Notification 0x1001 - Device Information Update to report a User Event / Card Swiped event.
After this period of time passes, the device erases the buffered card data from memory.
Changes to this property do not take effect until the device is power cycled or reset.
This OID has been deprecated. The OID can be written or read but it will have no effect of the device’s behavior.
The host can use this property to control the maximum charge level for the battery. All charge percentages reported or displayed will use this percentage as 100% charged.
Setting this value to lower than 0x64 (100%) will increase the life of the battery but reduce the run time when running from the battery.
The Maximum Battery Charge Level takes effect immediately after the host changes it.
The device will send a high temperature notification when the device’s temperature rises above this temperature. The temperature is in degrees Celsius.
The Device High Temperature Notification Level takes effect immediately after the host changes it.
While the device’s temperature is outside of the range defined by Device Low Temperature Notification Level (1.2.7.1.4.1) and Device High Temperature Notification Level (1.2.7.1.4.2), notifications will be sent to the host. This property sets the period between notifications.
The Device Temperature Notification Repeat Interval takes effect immediately after the host changes it.
Device Reset Occurred Notification Acknowledged - Get Request Example
Device Reset Occurred Notification Acknowledged - Get Response Example
Device Reset Occurred Notification Acknowledged - Set Request Example
Device Reset Occurred Notification Acknowledged - Set Response Example
Device Reset Will Occur Soon Notification Control - Property 1.2.7.1.1.3
Device Reset Will Occur Soon Notification Control - Get Request Example
Device Reset Will Occur Soon Notification Control - Get Response Example
Device Reset Will Occur Soon Notification Control - Set Request Example
Device Reset Will Occur Soon Notification Control - Set Response Example
Auto Reset Configuration - Property 1.2.7.1.1.4
Auto Reset Configuration - Get Request Example
Auto Reset Configuration - Get Response Example
Auto Reset Configuration - Set Request Example
Auto Reset Configuration - Set Response Example
User Event Notification Controls Enable - Property 1.2.7.1.2.1
User Event Notification Controls Enable - Get Request Example
User Event Notification Controls Enable - Get Response Example
User Event Notification Controls Enable - Set Request Example
User Event Notification Controls Enable - Set Response Example
User Event Notification MSR Data Timeout (MSR Only) - Property 1.2.7.1.2.2
User Event Notification MSR Data Timeout (MSR Only) - Get Request Example
User Event Notification MSR Data Timeout (MSR Only) - Get Response Example
User Event Notification MSR Data Timeout (MSR Only) - Set Request Example
User Event Notification MSR Data Timeout (MSR Only) - Set Response Example
Maximum Battery Charge Level (Deprecated) - Property 1.2.7.1.3.1
Maximum Battery Charge Level (Deprecated) - Get Request Example
Maximum Battery Charge Level (Deprecated) - Get Response Example
Maximum Battery Charge Level (Deprecated) - Set Request Example
Maximum Battery Charge Level (Deprecated) - Set Response Example
Device Low Temperature Notification Level - Property 1.2.7.1.4.1
Device Low Temperature Notification Level - Get Request Example
Device Low Temperature Notification Level - Get Response Example
Device Low Temperature Notification Level - Set Request Example
Device Low Temperature Notification Level - Set Response Example
Device High Temperature Notification Level - Property 1.2.7.1.4.2
Device High Temperature Notification Level - Get Request Example
Device High Temperature Notification Level - Get Response Example
Device High Temperature Notification Level - Set Request Example
Device High Temperature Notification Level - Set Response Example
Device Temperature Notification Repeat Interval - Property 1.2.7.1.4.3
Device Temperature Notification Repeat Interval - Get Request Example
Device Temperature Notification Repeat Interval - Get Response Example
Device Temperature Notification Repeat Interval - Set Request Example
Device Temperature Notification Repeat Interval - Set Response Example
Enable Barcode Types - Property 1.2.7.1.5.1
Enable Barcode Types - Get Request Example
Enable Barcode Types - Get Response Example
Enable Barcode Types - Set Request Example
Enable Barcode Types - Set Response Example
The device uses this property to set which custom image it displays when idle. If the selected image does not exist, the device falls back to showing text. This property does not take effect instantly; it takes effect the next time the device transitions to idle (for example, after a transaction or after resetting).
The device uses this property to set which custom image it displays when idle and locked. If the selected image does not exist, the device falls back to showing text. This property does not take effect instantly; it takes effect the next time the device transitions to idle (for example, after a transaction or after resetting). See Device Lock Feature for more information.
· 0x00 = Show text “Welcome” “Device is Locked”
· 0x01 = Show custom image 1
· 0x02 = Show custom image 2
· 0x03 = Show custom image 3
· 0x04 = Show custom image 4
To use this feature, the host must first load an image into the selected slot using Command 0xD812 - Start Send File to Device (Unsecured). Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.
The device uses this property to set the orientation of the display. There are four modes: Landscape with magnetic stripe reader (MSR) on the top, Landscape with MSR on the bottom, Portrait with MSR on the right, and Portrait with MSR on the left. This property does not take effect immediately, it takes effect the next time the device transitions to idle (for example, after a transaction or after power cycle / reset).
Send UI notifications along with showing message on the display
Description
This property is used to enable/disable the device to send UI notifications to the Host (similars to non-display device) in addition to showing UI message on the display device.
Property Description
Property OID
1.2.3.1.2.2 / 0x010203010202
Name
Display Backlight Intensity
Description
The device uses this property to set the intensity of the display’s backlight, expressed as a percentage range from 1% to 100%.
The backlight setting takes effect immediately after the host changes it.
Send UI notifications along with showing message on the display
Description
This property is used to enable/disable the device to send UI notifications to the Host (similars to non-display device) in addition to showing UI message on the display device.
Property Description
1.2.3.1.3.2 / 0x010203010302
Property OID
Name
Display Card Logo While Authorizing
Description
Enable display of logo for card brand used in transaction
This property sets the output volume for all sounds the device produces after startup, expressed as a percentage range from 0% (no sound) to 100%. The volume setting takes effect immediately after the host changes it.
Note that devices with limited volume control hardware allocate ranges of numbers to represent the same physical volume level (for example, 1..49 = Low, 50..100 = High).
This property is used to change the displayed format of the phone number entered in the touch screen. It fully supports the International E.164 format that defines the fields allowed for global phone numbers. This property is an array of 7 bytes divided into fields. All values are HEX.
Byte 0-1 – Country code (0x0000): 1 – 999 (value range 0x01 – 0x3E7) see NOTE 1
Byte 2 – Number of Area code digits: 0 – 3 (value range 0x00 – 0x03)
Byte 3 – Add Area code leading zero: (T/F) 0 – 1 (value range 0x00 – 0x01) NOTE 3
Byte 4 – Number of local number digits: l – 12 (value range 0x01 – 0x0C)
Byte 5 – Local number dash position: 0 – ‘Byte 4’s value minus 1’
Byte 6 – Hide digits with ‘*’: (T/F) 0 – 1 (value range 0x00 – 0x01)
NOTE 1: If country code is set to zero, then the local number format is automatically enabled.
NOTE 2: The maximum number of digits specified by the E.164 format is 15. The country code digits + area code digits + local number digits cannot exceed 15 total digits.
This property is used to format the zip code. Byte 2 is used to control the input type, For example, a numeric zip code 23452 (United states) or an alphanumeric zip code M5V 2T6 (Canada).
Byte 0 – Number of digits: 1 – 9 (value range 0x01 – 0x09)
Byte 1 – Dash position: 0 – ‘Byte 0’s value minus 1’
When set to 0, no dash will appear
Byte 2 – Zip code type: Numeric or Alphanumeric 0 - 1 (value 0x00 – 0x01)
Byte 3 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)
This property is used to determine if the Email should be displayed on the screen or hidden. The default hidden character is ‘*’. The maximum number of characters for Email is 29
Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)
This property is used to determine if the General Information should be displayed on the screen or hidden. The default hidden character is ‘*’. The maximum number of characters for General Information is 18.
Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)
Display Backlight Intensity (Display Only) - Get Request Example
Display Backlight Intensity (Display Only) - Get Response Example
Display Backlight Intensity (Display Only) - Set Request Example
Display Backlight Intensity (Display Only) - Set Response Example
Send UI Notifications Along with Showing Message on the Display (Display Only) - Property 1.2.3.1.2.3
Send UI Notifications Along with Showing Message on the Display (Display Only) - Get Request Example
Send UI Notifications Along with Showing Message on the Display (Display Only) - Get Response Example
Send UI Notifications Along with Showing Message on the Display (Display Only) - Set Request Example
Send UI Notifications Along with Showing Message on the Display (Display Only) - Set Response Example
Display Card Logo While Authorizing - Property 1.2.3.1.3.2
Display Card Logo While Authorizing - Get Request Example
Display Card Logo While Authorizing - Get Response Example
Display Card Logo While Authorizing - - Display Card Logo While Authorizing - Set Request Example
Display Card Logo While Authorizing - Set Response Example
System Volume Control - Property 1.2.3.2.1.1
System Volume Control - Get Request Example
System Volume Control - Get Response Example
System Volume Control - Set Request Example
System Volume Control - Set Response Example
Touch Keypress Beep Enable - Property 1.2.3.2.2.1
Touch Keypress Beep Enable - Get Request Example
Touch Keypress Beep Enable - Get Response Example
Touch Keypress Beep Enable - Set Request Example (enable)
Touch Keypress Beep Enable - Set Response Example (enable)
Touch Keypress Beep Enable - Set Request Example (disable)
Touch Keypress Beep Enable - Set Response Example (disable)
Phone Number Format - Property 1.2.3.3.1.1
Phone Number Format - Get Request Example
Phone Number Format - Get Response Example
Phone Number Format - Set Request Example
Phone Number Format - Set Response Example (enable)
Phone Number Format - Set Request Example
Phone Number Format - Set Request Example
Phone Number Format - Set Request Example
Phone Number Format - Set Request Example
Phone Number Format - Set Request Example
Social Security Number Format - Property 1.2.3.3.2.1
Social Security Number Format - Get Request Example
Social Security Number Format - Get Response Example
Social Security Number Format - Set Request Example
Social Security Number Format - Set Response Example
Zip Code Format - Property 1.2.3.3.3.1
Zip Code Format - Get Request Example
Zip Code Format - Get Response Example
Zip Code Format - Set Request Example
Zip Code Format - Set Response Example
Birth Date Format - Property 1.2.3.3.4.1
Birth Date Format - Get Request Example
Birth Date Format - Get Response Example
Birth Date Format - Set Request Example
Birth Date Format - Set Response Example
Personal ID Format - Property 1.2.3.3.5.1
Personal ID Format - Get Request Example
Personal ID Format - Get Response Example
Personal ID Format - Set Request Example
Personal ID Format - Set Response Example
Email Format - Property 1.2.3.3.6.1
Email Format - Get Request Example
Email Format - Get Response Example
Email Format - Set Request Example
General Information Format - Property 1.2.3.3.7.1
General Information Format - Get Request Example
General Information Format - Get Response Example
General Information Format - Set Request Example
General Information Format - Set Response Example (enable)
Valid Values
· bit 7 = Reason: Barcode Read Detected
Byte 1
· bit 0 = Reason: Encrypt Barcode Reader Event Data
· bit 1 = Reserved (set to 0x00)
· etc.
Byte 2
· bit 0 = Reserved (set to 0x00)
· etc.
Byte 3
· bit 0 = Reserved (set to 0x00)
· etc.
Any byte / bit not listed here is reserved for future use. The host should set those values to 0, so if a future revision of firmware starts using those bits, the related notifications will be disabled and will not affect the existing host software.
Byte 1 - bit 0: ITF-6
Byte 1 - bit 1: Matrix 2 of 5
Byte 1 - bit 2: Code 39, Code 32
Byte 1 - bit 3: Codabar
Byte 1 - bit 4: Code 93
Byte 1 - bit 5: AIM 128
Byte 1 - bit 6: ISSN
Byte 1 - bit 7: ISBN
Byte 2 - bit 0: Industrial 25
Byte 2 - bit 1: Standard 25
Byte 2 - bit 2: Plessey
Byte 2 - bit 3: Code 11
Byte 2 - bit 4: MSI Plessey
Byte 2 - bit 5: GS1 Databar (RSS)
Byte 2 - bit 6: PDF417
Byte 2 - bit 7: QR Code
Byte 3 - bit 0: Aztec
Byte 3 - bit 1: Data Matrix
Byte 3 - bit 2: Micro QR
To use this feature, the host must first load an image into the selected slot using Command 0xD812 - Start Send File to Device (Unsecured). Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.
Description
NOTE 3: Setting Byte 3 to true only takes effect if country code is set to zero. If Byte 3 is set to true, then Byte 2 must be set to 2 or 3. Reason: Adding a leading zero automatically makes the number of area code digits greater than 1.
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Any number
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Landscape with MSR on Top 0x01 = Portrait with MSR on Right 0x02 = Portrait with MSR on Left
0x03 = Landscape with MSR on Bottom
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x01..0x64
Default
0x5A (90%)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – Disable UI notification
0x01 – Enable UI notification
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x01..0x64
Default
0x5A (90%)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – Disable UI notification
0x01 – Enable UI notification
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Disable Logo 0x01 = Enable Logo
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00..0x64
Default
0x32 (50%)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x0 - 0x1
Default
0x1
Securing Key
None
Min. Len (b)
7
Max. Len (b)
7
Data Type
Binary
Valid Values
Example valid HEX value for the USA
0001 03 00 07 03 00
Default
OID Default
0x0001 = country code (+1) USA 0x03 = num area code digits
0x00 = add area code leading zero (T/F)
0x07 = num local number Digits
0x03 = local number dash position 0x00 = hide digits (T/F)
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
Example valid value for the USA
04 00 – (04 capture 4 digits, 00 show digits)
09 00 – (09 capture 9 digits, 00 show digits)
04 01 – (04 capture 4 digits, 01 hide)
09 01 – (09 capture 9 digits, 01 hide)
Default
09 01 = 9 digits, hide
Securing Key
None
Min. Len (b)
4
Max. Len (b)
4
Data Type
Binary
Valid Values
Example valid HEX value for the USA 09 05 00 00
(capture 9 digits, add dash after digit 5, Numeric Zip code, show digits)
Default
05 00 00 00
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Digits, 01 Hide Digits
Default
00 00
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Characters, 01 Hide Characters
Default
00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Digits, 01 Hide Digits
Default
00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Digits, 01 Hide Digits
United States +1 (321) 689-1234, international number, with 1-digit country code, 3-digit area code
United States (321) 689-2213, local number, with 3-digit area code, dash in position 3
Australia +61 (5) 1234-5678, international number, with 2-digit country code, 1-digit area code
Australia (05) 1234-5678, local number, with leading zero, 1-digit area code, dash in position 4
Hong Kong +852 12345678, international number, with 3-digit country code, no area code
Hong Kong 1234-5678, local number, with no area code, dash in position 4
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Any number
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Landscape with MSR on Top 0x01 = Portrait with MSR on Right 0x02 = Portrait with MSR on Left
0x03 = Landscape with MSR on Bottom
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – Disable UI notification
0x01 – Enable UI notification
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Disable Logo Page at Startup 0x01 = Enable Logo Page at Startup
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 = Disable Logo 0x01 = Enable Logo
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x01..0x64
Default
0x5A (90%)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00..0x64
Default
0x32 (50%)
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x0 - 0x1
Default
0x1
Securing Key
None
Min. Len (b)
7
Max. Len (b)
7
Data Type
Binary
Valid Values
Example valid HEX value for the USA
0001 03 00 07 03 00
Default
OID Default
0x0001 = country code (+1) USA 0x03 = num area code digits
0x00 = add area code leading zero (T/F)
0x07 = num local number Digits
0x03 = local number dash position 0x00 = hide digits (T/F)
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
Example valid value for the USA
04 00 – (04 capture 4 digits, 00 show digits)
09 00 – (09 capture 9 digits, 00 show digits)
04 01 – (04 capture 4 digits, 01 hide)
09 01 – (09 capture 9 digits, 01 hide)
Default
09 01 = 9 digits, hide
Securing Key
None
Min. Len (b)
4
Max. Len (b)
4
Data Type
Binary
Valid Values
Example valid HEX value for the USA 09 05 00 00
(capture 9 digits, add dash after digit 5, Numeric Zip code, show digits)
Default
05 00 00 00
Securing Key
None
Min. Len (b)
2
Max. Len (b)
2
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Digits, 01 Hide Digits
Default
00 00
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Characters, 01 Hide Characters
Default
00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Digits, 01 Hide Digits
Default
00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
Example valid HEX value for the USA
00 Show Digits, 01 Hide Digits
Default
00
Description
The device uses this property to set which custom image it displays when idle. If the selected image does not exist, the device falls back to showing text. This property does not take effect instantly; it takes effect the next time the device transitions to idle (for example, after a transaction or after resetting).
· 0x00 = Show text “Welcome”
· 0x01 = Show custom image 1
· 0x02 = Show custom image 2
· 0x03 = Show custom image 3
· 0x04 = Show custom image 4
To use this feature, the host must first load an image into the selected slot using Command 0xD812 - Start Send File to Device (Unsecured). Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.
The device uses this property to set which custom image it displays when idle and locked. If the selected image does not exist, the device falls back to showing text. This property does not take effect instantly; it takes effect the next time the device transitions to idle (for example, after a transaction or after resetting). See Device Lock Feature for more information.
· 0x00 = Show text “Welcome” “Device is Locked”
· 0x01 = Show custom image 1
· 0x02 = Show custom image 2
· 0x03 = Show custom image 3
· 0x04 = Show custom image 4
To use this feature, the host must first load an image into the selected slot using Command 0xD812 - Start Send File to Device (Unsecured). Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.
The device uses this property to set the orientation of the display. There are four modes: Landscape with magnetic stripe reader (MSR) on the top, Landscape with MSR on the bottom, Portrait with MSR on the right, and Portrait with MSR on the left. This property does not take effect immediately, it takes effect the next time the device transitions to idle (for example, after a transaction or after power cycle / reset).
Send UI notifications along with showing message on the display
Description
This property is used to enable/disable the device to send UI notifications to the Host (similars to non-display device) in addition to showing UI message on the display device.
Property Description
Property OID
1.2.3.1.3.1 / 0x010203010301
Name
Enable Card Logos Page at Startup
Description
Enables a page at startup that displays supported payment type brand logos.
This property sets the output volume for all sounds the device produces after startup, expressed as a percentage range from 0% (no sound) to 100%. The volume setting takes effect immediately after the host changes it.
Note that devices with limited volume control hardware allocate ranges of numbers to represent the same physical volume level (for example, 1..49 = Low, 50..100 = High).
This property is used to change the displayed format of the phone number entered in the touch screen. It fully supports the International E.164 format that defines the fields allowed for global phone numbers. This property is an array of 7 bytes divided into fields. All values are HEX.
Byte 0-1 – Country code (0x0000): 1 – 999 (value range 0x01 – 0x3E7) see NOTE 1
Byte 2 – Number of Area code digits: 0 – 3 (value range 0x00 – 0x03)
Byte 3 – Add Area code leading zero: (T/F) 0 – 1 (value range 0x00 – 0x01) NOTE 3
Byte 4 – Number of local number digits: l – 12 (value range 0x01 – 0x0C)
Byte 5 – Local number dash position: 0 – ‘Byte 4’s value minus 1’
Byte 6 – Hide digits with ‘*’: (T/F) 0 – 1 (value range 0x00 – 0x01)
NOTE 1: If country code is set to zero, then the local number format is automatically enabled.
NOTE 2: The maximum number of digits specified by the E.164 format is 15. The country code digits + area code digits + local number digits cannot exceed 15 total digits.
NOTE 3: Setting Byte 3 to true only takes effect if country code is set to zero. If Byte 3 is set to true, then Byte 2 must be set to 2 or 3. Reason: Adding a leading zero automatically makes the number of area code digits greater than 1.
This property is used to format the zip code. Byte 2 is used to control the input type, For example, a numeric zip code 23452 (United states) or an alphanumeric zip code M5V 2T6 (Canada).
Byte 0 – Number of digits: 1 – 9 (value range 0x01 – 0x09)
Byte 1 – Dash position: 0 – ‘Byte 0’s value minus 1’
When set to 0, no dash will appear
Byte 2 – Zip code type: Numeric or Alphanumeric 0 - 1 (value 0x00 – 0x01)
Byte 3 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)
This property is used to determine if the Email should be displayed on the screen or hidden. The default hidden character is ‘*’. The maximum number of characters for Email is 29
Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)
This property is used to determine if the General Information should be displayed on the screen or hidden. The default hidden character is ‘*’. The maximum number of characters for General Information is 18.
Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)
Apple VAS Merchant ID and URL Slot 5 - Property 1.1.1.1.1.B
Property Description
Property OID
1.1.1.1.1.B / 0x01010101010B
Name
Apple VAS Merchant ID and URL Slot 5
Securing Key
None
Min. Len (b)
1
Max. Len (b)
102
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Type
Default
0x00
Securing Key
None
Min. Len (b)
A valid reverse-DNS similar to the Default below
Max. Len (b)
50
Data Type
ASCII
Valid Values
ASCII
Default
com.magtek.dynaflex2go
Securing Key
None
Min. Len (b)
1
Max. Len (b)
25
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Types
Default
0x00
R
DF7D
Var up to 0x0E
GWST Service Types
0x00 = All services
0x01 = All services except PPSE
0x02 = PPSE
0x03 = Loyalty
0x04 = Offer
0x05 = Gift card
0x06 = Private label card
B
R
Securing Key
None
Min. Len (b)
1
Max. Len (b)
25 Property
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Types
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
25
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Types
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
25
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Types
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
25
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Types
Default
0x00
Securing Key
None
Min. Len (b)
1
Max. Len (b)
25
Data Type
Binary
Valid Values
00 or see Table 8.2‑32 - VAS Merchant ID and URL Types
Default
0x00
Securing Key
None
Min. Len (b)
4
Max. Len (b)
4
Data Type
Binary
Valid Values
Byte value where each bit of the byte indicates a particular POS capability. Bit 0 is the least significant bit. The Tap byte is generated by the device.
Byte 1 – System:
Bit 0: Standalone
Bit 1: Semi-integrated
Bit 2: Unattended
Bit 3: Online
Bit 4: Offline
Default
DynaProx, DynaFlex II Go and DynaFlex II: 0x08, 0x10, 0x03, 0x00
All Other devices: 0x08, 0x14, 0x03, 0x05
Securing Key
None
Min. Len (b)
1
Max. Len (b)
1
Data Type
Binary
Valid Values
0x00 – Do not start Transaction on Touchscreen event 0x01 – Start Transaction on Touchscreen Event
Default
0x00 - Do not start Transaction on Touchscreen event s
Securing Key
None
Min. Len (b)
1F
Max. Len (b)
1F
Data Type
Binary
Byte 1 Tip Mode
0x00 – Disable Tip Mode
0x01 – Show Tip GUI immediately using % value 0x02 – Show Tip GUI immediately using $ amount
Byte 2, Display Mode for Button1
0 - % or Amount
1 – Display Custom
2 – Display NO TIP
3 – Disabled (An OID controls whether the button is blank, grayed out or not showing) Bytes 3 to 6 Value in % or Amount for Button 1, if applicable
This setting allows the iOS device to recommend installation of a specific app or set of apps to use with the iOS device when connects to an accessory.
When enabled, pressing an amount, percent, or ‘no tip’ button on the tip entry page will proceed immediately without requiring a subsequent tap of the ‘Submit’ button.