Ctrlk

About Files

Large blobs of data uploaded to / downloaded from the device are referred to as “files” and share a common set of commands documented here, and special message type Data File Message. Some file types can be sent in the File Payload fields in “raw” form (e.g. certificates and images) with metadata coming from the command request and response. Other file types require the addition of MagTek metadata included inside the File Payload blob; these are documented in the “File Type” subsections of section: Data Types and Shared TLV Data Objects.

Files Types that may come from the host include:

  • EMV configuration

  • Firmware updates

  • Public Key Infrastructure (PKI) Certificates

  • User interface images and prompts

  • EMV kernels

  • SRED BIN tables

File Types that may come from the device include:

  • Read back of the above file types

  • Signature Capture

  • Logs

  • Certificate Requests

The commands in this section share a common list of 4-byte file types, listed in the table below. File types marked as Secured = Yes must be loaded using Command 0xD811 - Start Send File to Device (Secured); file types that are marked as Secured = No can be loaded using Command 0xD812 - Start Send File to Device (Unsecured).

Table - File Types

Description
Secured
File Type
File Type Version
File Subtype
File Instance

EMV configuration, terminal file. See file definition in section 4.8

Get: No Set: No

0x00

0x00

0x00

0x00

EMV configuration, processing file. See file definition in section 4.9

Get: No Set: No

0x00

0x00

0x01

0x00

EMV configuration, entry point file. See file definition in section 4.10

Get: No Set: No

0x00

0x00

0x02

0x00

EMV configuration, CA keys file. See file definition in section 4.10.6

Get: No Set: No

0x00

0x00

0x03

0x00

EMV configuration, Visa DRL set. Reserved for future use.

Get: No Set: No

0x00

0x00

0x04

0x00

EMV configuration, American Express DRL set. See file definition in section 4.12

Get: No Set: No

0x00

0x00

0x05

0x00

EMV configuration, MasterCard update conditions. Reserved for future use.

Get: No Set: No

0x00

0x00

0x06

0x00

EMV configuration, American Express update conditions. Reserved for future use.

Get: No Set: No

0x00

0x00

0x08

0x00

EMV configuration, Discover update conditions. Reserved for future use.

Get: No Set: No

0x00

0x00

0x09

0x00

EMV configuration, CA revocation list. Reserved for future use.

Get: No Set: No

0x00

0x00

0x0A

0x00

EMV configuration, exception file list. Reserved for future use.

Get: No Set: No

0x00

0x00

0x0B

0x00

EMV configuration, DPAS data storage. Reserved for future use.

Get: No Set: No

0x00

0x00

0x0C

0x00

(Touch Only) Signature capture file. See file definition in section 4.15

Get: No Set: NA

0x01

0x00

0x00

0x00

(Display Only) Custom Idle Page Image 1. For details, see Property 1.2.3.1.1.1 Custom Idle Page Image.

Get: NA Set: No

0x02

0x00

0x00

0x00

(Display Only) Custom Idle Page Image 2. For details, see Property 1.2.3.1.1.1 Custom Idle Page Image.

Get: NA Set: No

0x02

0x00

0x00

0x01

(Display Only) Custom Idle Page Image 3. For details, see Property 1.2.3.1.1.1 Custom Idle Page Image.

Get: NA Set: No

0x02

0x00

0x00

0x02

(Display Only) Custom Idle Page Image 4. For details, see Property 1.2.3.1.1.1 Custom Idle Page Image.

Get: NA Set: No

0x02

0x00

0x00

0x03

(WLAN Only) Apollo root CA certificate See Certificate File Types.

Get: No Set: Yes

0x03

0x00

0x00

0x00

(WLAN Only) Apollo intermediate CA certificate See Certificate File Types.

Get: No Set: Yes

0x03

0x00

0x01

0x00

(WLAN Only) Apollo server certificate See Certificate File Types.

Get: No Set: No

0x03

0x00

0x02

0x00

(WLAN Only) Customer root CA certificate See Certificate File Types.

Get: No Set: Yes

0x03

0x00

0x03

0x00

(WLAN Only) Customer intermediate CA certificate See Certificate File Types.

Get: No Set: Yes

0x03

0x00

0x04

0x00

(WLAN Only) Customer server certificate See Certificate File Types.

Get: No Set: No

0x03

0x00

0x05

0x00

(WLAN Only) Commercial root CA certificate See Certificate File Types.

Get: No Set: Yes

0x03

0x00

0x06

0x00

(WLAN Only) Commercial intermediate CA certificate See Certificate File Types.

Get: No Set: Yes

0x03

0x00

0x07

0x00

(WLAN Only) Commercial server certificate See Certificate File Types.

Get: No Set: No

0x03

0x00

0x08

0x00

(WLAN Only) Apollo trust certificate See Certificate File Types.

Get: No Set: No

0x03

0x00

0x09

0x00

(WLAN Only) Customer trust certificate See Certificate File Types.

Get: No Set: No

0x03

0x00

0x0A

0x00

(WLAN Only) Apollo client certificate See Certificate File Types.

Get: No Set: No

0x03

0x00

0x0B

0x00

(WLAN Only) Certificate signing request (CSR) See Certificate Signing Request (CSR) File Types.

Get: No Set: N/A

0x04

0x00

0x00

0x00

(WLAN Only) WebSocket Trust configuration file, Request file from MagTek.

Get: N/A Set: No

0x05

0x00

0x00

0x00

(WLAN Only) MQTT Trust configuration file, Request file from MagTek.

Get: N/A Set: No

0x05

0x00

0x01

0x00

UI configuration file. See file definition in section 4.30 UI Configuration File Type.

Get: No Set: No

0x06

0x00

0x00

0x00

(Display Only) Magtek signed image file type

Get: N/A Set: No

0x07

0x00

0x00

0x00

User File, users may send a file to or fetch a file from the device with this File ID. The maximum file size is 10,000 bytes.

Get: No Set: No

0x08

0x00

0x00

0x00

Last updated