> For the complete documentation index, see [llms.txt](https://developer.magtek.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.magtek.com/sdks-and-tools/universal-sdk-documentation/.net-windows/classes.md).

# Classes

These classes are equipped with helper classes named Builders. Builders can parse the raw data byte array of an OnEvent() into a format required by a builder’s class.

### BarCodeData <a href="#id-10.1_barcodedata" id="id-10.1_barcodedata"></a>

These constructors initialize a BarCodeData object. Use BarCodeDataBuilder.GetBarCodeData with data from the BarCodeData event to return a BarcodeData.

{% code overflow="wrap" %}

```
BarCodeData BarCodeDataBuilder.GetBarCodeData( 
    DeviceType deviceType,
    byte[] dataBytes
    );
    
new BarCodeData(
byte[] Data, 
boolean Encrypted,
byte EncryptionType, byte[] 
KSN
);
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="179" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Member</td><td valign="top">Description</td></tr><tr><td valign="top">Data</td><td valign="top">Returns the data payload.</td></tr><tr><td valign="top">Encrypted</td><td valign="top">Returns the encryption status. false = data is not encrypted true = data is encrypted</td></tr><tr><td valign="top">EncryptionType</td><td valign="top">Returns the encryption type.</td></tr><tr><td valign="top">KSN</td><td valign="top">Returns the Key Serial Number.</td></tr></tbody></table>

Return Value:

Returns an instance of BarCodeData.

### CertificateInfo <a href="#id-10.2_certificateinfo" id="id-10.2_certificateinfo"></a>

CertificateInfo is used for the connection to a device requiring client credentials. See the following for details on installing a certificate chain: <mark style="color:red;">**DynaFlex II PED Using Wireless LAN Guide.**</mark>

<table data-header-hidden><thead><tr><th width="192.6666259765625" valign="top"></th><th width="132.66668701171875"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">CertificateInfo</td></tr><tr><td valign="top">Member</td><td>Type/ Format</td><td>Description</td></tr><tr><td valign="top">format getFormat()</td><td>string</td><td>Certificate data format. “PKCS12” – for .p12 file. “PFX” – for .pfx file.</td></tr><tr><td valign="top">data getData()</td><td>byte[]</td><td>Certificate data</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="204" valign="top"></th><th width="85.33331298828125"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">CertificateInfo</td></tr><tr><td valign="top">password getPassword()</td><td>string</td><td>Password to access the certificate data.</td></tr></tbody></table>

Example of using CertificateInfo.

### ConnectionStateBuilder <a href="#id-10.3_connectionstatebuilder" id="id-10.3_connectionstatebuilder"></a>

This class returns the connection state of the device when supplied the data object of the OnEvent() ConnectionState event.

{% code overflow="wrap" %}

```
string ConnectionStateBuilder.GetString(ConnectionState value); 
ConnectionState ConnectionStateBuilder.GetValue(string data);
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="189" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Member</td><td valign="top">Description</td></tr><tr><td valign="top">CONNECTED</td><td valign="top">Returns string of connected.</td></tr><tr><td valign="top">CONNECTING</td><td valign="top">Returns string of connecting.</td></tr><tr><td valign="top">DISCONNECTED</td><td valign="top">Returns string of disconnected.</td></tr><tr><td valign="top">DISCONNECTING</td><td valign="top">Returns string of disconnecting.</td></tr><tr><td valign="top">ERROR</td><td valign="top">Returns string of error.</td></tr><tr><td valign="top">GetString()</td><td valign="top">Returns string of the ConnectionState enum.</td></tr><tr><td valign="top">GetValue()</td><td valign="top">Returns ConnectionState enum from the event data string value.</td></tr></tbody></table>

Return Value:

Returns an instance of ConnectionStateBuilder.

### DirectoryEntry <a href="#id-10.4_directoryentry" id="id-10.4_directoryentry"></a>

DirectoryEntry is similar to an InputRequest for Application during a transaction. Other fields of information are included besides Application Label. During a transaction, the device selects the PPSE. The directory entries are the PPSE response starting from the BF0C tag. The number of directory entries correspond to the number of applications on the card.

This takes the data from the EnhancedInputRequest event and returns an enhanced application selection list. This class extends InputRequest.

Code paths to receiving DirectoryEntry:

These constructors initialize a DirectoryEntry object.

{% code overflow="wrap" %}

```
new DirectoryEntry(); 
new DirectoryEntry(
    String Aid, 
    String Label, 
    byte Priority,
    byte[] ProprietaryData, 
    byte KernelIdentifier, 
    byte[] IssuerIN,
    byte[] IssuerINE,
    byte[] IssuerCountryCodeAlpha2, 
    byte[] IssuerCountryCodeAlpha3, 
    byte[] CardProductDetails
    );
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="128.66668701171875" valign="top"></th><th width="95.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Parameter</td><td valign="top">Type</td><td valign="top">Description</td></tr><tr><td valign="top">Aid</td><td valign="top">String</td><td valign="top">Application Identifier. Tag 4F Max 16</td></tr><tr><td valign="top">Label</td><td valign="top">String</td><td valign="top">Application Label. Tag 50 Max 16</td></tr><tr><td valign="top">Priority</td><td valign="top">byte</td><td valign="top">Application Priority Indicator. Tag 87</td></tr><tr><td valign="top">ProprietaryData</td><td valign="top">byte[]</td><td valign="top">Application Selection Registered Proprietary Data. Tag 9F0A</td></tr><tr><td valign="top">KernelIdentifier</td><td valign="top">byte</td><td valign="top">Kernel Identifier. Tag 9F2A</td></tr><tr><td valign="top">IssuerIN</td><td valign="top">byte[3]</td><td valign="top">Issuer Identification Number. Tag 42</td></tr><tr><td valign="top">IssuerINE</td><td valign="top">byte[4]</td><td valign="top">Issuer Identification Number Extended. Tag 9F0C</td></tr><tr><td valign="top">IssuerCountryCodeAlpha2</td><td valign="top">byte[2]</td><td valign="top">Issuer Country Code (alpha2 format). Tag 5F55</td></tr><tr><td valign="top">IssuerCountryCodeAlpha3</td><td valign="top">byte[3]</td><td valign="top">Issuer Country Code (alpha3 format). Tag 5F56</td></tr><tr><td valign="top">CardProductDetails</td><td valign="top">byte[2]</td><td valign="top">Card Product Details. Tag 9F7D</td></tr></tbody></table>

Return Value:

Returns an instance of DirectoryEntry.

### EnhancedInputRequest <a href="#id-10.5_enhancedinputrequest" id="id-10.5_enhancedinputrequest"></a>

This supplies a directory entry list for application selection after a card has been presented to the device during a transaction. To be implemented, Application Selection Behavior property 1.2.1.1.1.2 must be set to 0x03 – Enhanced Prompt Cardholder.

The data byte array from the EnhancedInputRequest event is parsed and returned as an enhanced application selection list (directory entry). This list is the PPSE response starting from tag BF0C. EnhancedInputRequest class extends InputRequest.

{% code overflow="wrap" %}

```
new EnhancedInputRequest();
new EnhancedInputRequest(byte[] data);
```

{% endcode %}

<table data-header-hidden><thead><tr><th valign="top"></th><th></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">EnhancedInputRequest</td></tr><tr><td valign="top">Member</td><td>Return</td><td>Description</td></tr><tr><td valign="top">EnhancedSelectionList()</td><td>List&#x3C;DirectoryEntry></td><td>Returns a list of enhanced application selection.</td></tr><tr><td valign="top">setEnhancedSelectionList()</td><td>List&#x3C;DirectoryEntry></td><td>Sets a list of enhanced application selection.</td></tr><tr><td valign="top">Title()</td><td>String</td><td>Title to display.</td></tr><tr><td valign="top">Type()</td><td>int</td><td>Selection type.</td></tr><tr><td valign="top">Timeout()</td><td>long</td><td>Timeout in seconds to make selection.</td></tr></tbody></table>

### InputRequest <a href="#id-10.6_inputrequest" id="id-10.6_inputrequest"></a>

This is used for displaying messages prompted by the card during a transaction. The data byte array from the InputRequest event is parsed and returned as an InputRequest.

{% code overflow="wrap" %}

```
new InputRequest(); 
new InputRequest(byte[] data);
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="144" valign="top"></th><th width="134.33331298828125"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">InputRequest</td></tr><tr><td valign="top">Member</td><td>Type/ Format</td><td>Description</td></tr><tr><td valign="top">Type</td><td>byte</td><td><p>Input type.</p><p>0x00 = INPUT_TYPE_APPLICATION</p><p>0x01 = INPUT_TYPE_LANGUAGE</p></td></tr><tr><td valign="top">Timeout</td><td>byte</td><td>Timeout in seconds</td></tr><tr><td valign="top">Title</td><td>string</td><td>Title</td></tr><tr><td valign="top">SelectionList</td><td>List&#x3C;string></td><td>List of selections for Application and Language depending on the Type.</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="244.6666259765625" valign="top"></th><th width="102"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">Static</td></tr><tr><td valign="top">Member</td><td>Retu rn</td><td>Description</td></tr><tr><td valign="top">INPUT_TYPE_APPLICATION</td><td>byte</td><td>Selection type is for Application.</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="267.66668701171875" valign="top"></th><th width="99.33331298828125"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">Static</td></tr><tr><td valign="top">INPUT_TYPE_LANGUAGE</td><td>byte</td><td>Selection type is for Language.</td></tr><tr><td valign="top">INPUT_STATUS_COMPLETED</td><td>byte</td><td>To send the status of completed for sendSelection().</td></tr><tr><td valign="top">INPUT_STATUS_CANCELLED</td><td>byte</td><td>To send the status of canceled for sendSelection().</td></tr><tr><td valign="top">INPUT_STATUS_TIMED_OUT</td><td>byte</td><td>To send the status of timed out for sendSelection().</td></tr></tbody></table>

Return:

Returns and instance of InputRequest.

### IData <a href="#id-10.7_idata" id="id-10.7_idata"></a>

IData is used for the payload of events and passing data to functions. When assigning the member StringValue, the member ByteArray is automatically assigned. Same is true vice versa. In this way either a string or an array can be accessed without need of data conversion.

Use the BaseData() function to assign an instance of IData.

<table data-header-hidden><thead><tr><th width="121.33331298828125" valign="top"></th><th width="135.33331298828125"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">IData</td></tr><tr><td valign="top">Member</td><td>Type/ Format</td><td>Description</td></tr><tr><td valign="top">StringValue</td><td>string</td><td>String value</td></tr><tr><td valign="top">ByteArray</td><td>byte[]</td><td>Byte array</td></tr></tbody></table>

Example of using IData.

<pre data-overflow="wrap"><code>// String usage
IData data1 = new BaseData("3030");
<strong>
</strong><strong>IData data2 = new BaseData(""); 
</strong><strong>data2.StringValue = "3030";
</strong>
// Array usage
IData data3 = new BaseData(new byte[] {0x30, 0x30});

IData data4 = new BaseData(""); data4.ByteArray = new byte[] {0x30, 0x30};
</code></pre>

### ITransaction <a href="#id-10.8_itransaction" id="id-10.8_itransaction"></a>

This is the interface used as the parameter for startTransaction(). For an example, see the sample code in IDevice Walk Through.

<table data-header-hidden><thead><tr><th width="168" valign="top"></th><th width="155.66668701171875"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">ITransaction</td></tr><tr><td valign="top">Member</td><td>Type/ Format</td><td>Description</td></tr><tr><td valign="top">PaymentMethods</td><td>List of PaymentMeth od</td><td><p>List of the PaymentMethod enumeration.</p><p> </p><p>MSR         = For magnetic stripe cards.</p><p>Contact     = For EMV chip cards.</p><p>Contactless = For NFC contactless cards. ManualEntry = Manually entry, no card. When set, other payment methods must not be included.</p><p> </p><p>Barcode          = For barcode. BarcodeEncrypted = For barcode with encrypted response.</p><p>AppleVAS         = For Apple VAS.</p><p>GoogleVAS        = For Apple VAS.</p><p>NFC              = For NFC tag.</p></td></tr><tr><td valign="top">QuickChip</td><td>bool</td><td><p>In QuickChip mode, the device does not prompt for an amount. Device sends an ARQC request to the host. Device automatically populates the ARPC response data with EMV Tag 8A set to “Z3”. Card holder is prompted to remove the card. Transaction result is later determined by the processor and not by the card.</p><p> </p><p>false - Do not enable QuickChip mode.</p><p>true - Enable QuickChip mode. Default.</p></td></tr><tr><td valign="top">Timeout</td><td>byte</td><td><p>Transaction timeout in seconds. Default is 60 seconds.</p><p> </p><p>0 to 255 - Depending on the device, 0 means no timeout.</p></td></tr><tr><td valign="top">Amount</td><td>string Max 13</td><td><p>EMV Tag 9F02 - Authorized amount of the transaction.</p><p> </p><p>Example:</p><p>“1.23” = $1.23</p><p>“10” = $10.00</p></td></tr><tr><td valign="top">CashBack</td><td>string Max 13</td><td><p>EMV Tag 9F03 - Secondary amount associated with the transaction.</p><p> </p><p>Example:</p><p>“1.23” = $1.23</p><p>“10” = $10.00</p></td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="181.33331298828125" valign="top"></th><th width="114"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">ITransaction</td></tr><tr><td valign="top">CurrenyCode</td><td>byte[] 2</td><td><p>EMV Tag 5F2A - Currency code of the transaction according to ISO 4217. The byte array is null by default.</p><p>Example:</p><p>0x0840 = US Dollar 0x0978 = Euro 0x0826 = UK Pound</p></td></tr><tr><td valign="top">CurrencyExponent</td><td>byte[] 1</td><td><p>EMV Tag 5F36 - The decimal point position from the right of the transaction amount. The byte array is null by default.</p><p>Example:</p><p>0x02 = decimal point at 2 positions from the right.</p></td></tr><tr><td valign="top">EMVOnly</td><td>bool</td><td><p>Flag that determines whether or not to start a transaction in EMV mode. This takes effect for devices which support both MSR and EMV mode (not limited to eDynamo, tDynamo, and DynaPro Family). This has no effect on non EMV devices.</p><p>false = Do not start transaction in EMV mode.</p><p>true = Only start transaction in EMV mode. Default.</p></td></tr><tr><td valign="top">PreventMSRSignatureF orCardWithICC</td><td>bool</td><td><p>Flag that forces the device to skip signature capture during an MSR-only transaction if the card’s service code indicates it is a chip card.</p><p> </p><p>false = Allow the prompt for a signature if requested.</p><p>true = Do not prompt for signature.</p></td></tr><tr><td valign="top">SuppressThankYouMes sage</td><td>bool</td><td><p>By default, devices with a display signal the end of a transaction by briefly showing “THANK YOU,” then “WELCOME.”</p><p> </p><p>false = Do not suppress the thank you message.</p><p>true = Suppress the thank you message.</p></td></tr><tr><td valign="top">DisplayAmountForQuic kChip</td><td>bool</td><td><p>Display Amount for Quick Chip Transaction Flow.</p><p> </p><p>false = Do not display Amount when QuickChip mode is true. Default.</p><p>true = Display Amount when QuickChip mode is true.</p></td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="206" valign="top"></th><th width="86"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">ITransaction</td></tr><tr><td valign="top">OverrideFinalTransacti onMessage</td><td>byte</td><td><p>By default, devices with a display signal the end of a transaction by returning to the idle page and showing “WELCOME.” This parameter directs the device to show a message based on the Message ID from the command displayMessage(). This option completely overrides the device’s idle page behavior until the next transaction, power cycle, or other similar state change.</p><p>Examples:</p><p>0x00 - reserved, do not use. 0x01 - “AMOUNT”</p><p>0x02 - “AMOUNT OK?”</p><p>0x03 - “APPROVED”</p><p>0x04 - “CALL YOUR BANK”</p><p>0x05 - “CANCEL OR ENTER”</p><p>0x06 - “CARD ERROR”</p><p>0x07 - “DECLINED”</p></td></tr><tr><td valign="top">EMVResponseFormat</td><td>byte</td><td><p>The format of the EMV response.</p><p> </p><p>0x00 = Legacy. Default.</p><p>0x01 = RFU</p></td></tr><tr><td valign="top">MerchantCategory</td><td>byte[] 2</td><td>EMV Tag 9F15 - The type of business being done by the merchant, represented according to ISO 18245. The byte array is null by default.</td></tr><tr><td valign="top">MerchantCustomData</td><td>byte[] 20</td><td>EMV Tag 9F7C – Proprietary merchant data that may be requested. The byte array is null by default.</td></tr><tr><td valign="top">MerchantID</td><td>byte[] 15</td><td>EMV Tag 9F16 - Used to uniquely identify a given merchant. The byte array is null by default.</td></tr><tr><td valign="top">TransactionCategory</td><td>byte[] 1</td><td>EMV Tag 9F53 - The type of contactless transaction being performed. The byte array is null by default.</td></tr><tr><td valign="top">TransactionType</td><td>byte 1</td><td><p>EMV Tag 9C - The type of financial transaction, represented by the first two digits of the ISO 8583:1987 Processing Code.</p><p> </p><p>0x00 = purchase. Default.</p><p>0x01 = cash advance</p><p>0x09 = purchase with cashback</p><p>0x20 = refund</p><p>Supported transaction types can found in the commands programmers manual specific to the device.</p></td></tr><tr><td valign="top">AppleVASMode</td><td>VASMode</td><td>An enumeration for the Apple VAS Mode.</td></tr><tr><td valign="top">AppleVASProtocol</td><td>VASProtocol</td><td>An enumeration for the Apple VAS Protocol.</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="177.3333740234375" valign="top"></th><th width="132.6666259765625"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">ITransaction</td></tr><tr><td valign="top">ECP2FrameData</td><td>byte[] 3-18</td><td><p>Apple ECP2.0 frame from Byte 2 to Byte N. See Apple ECP2.0 specification.</p><p>·       For example, if ECP2.0 VASUP-A frame is 6A02C3020003FFFF</p><p>then Byte 2-N is 0xC3020003FFFF.</p><p> </p><p>·       By default, ECP2.0 frame (Byte 2 -N) is 0xC3020003FFFF</p></td></tr><tr><td valign="top">CustomNFCTransactio nMode</td><td>List of NFCTransacti onMode</td><td>List of NFC transaction modes.</td></tr><tr><td valign="top">CustomNFCReadData Mode</td><td>NFCDataMod e</td><td>Custom NFC data mode.</td></tr><tr><td valign="top">ManualEntryType</td><td>byte</td><td><p>User interface sequence.</p><p>0x00 = Card Number, Expiration Date, Security Code 0x01 = Name on Card, Card Number, Expiration Date, Security Code (Reserved for Future Use)</p><p>0x02 = Qwick Code, Last 4 digits of Card Number, Security Code (Reserved for future use)</p></td></tr><tr><td valign="top">ManualEntryFormat</td><td>byte</td><td><p>Card number valid format.</p><p>0x00 = PAN min 8, max 21 digits</p></td></tr><tr><td valign="top">ManualEntrySound</td><td>byte</td><td><p>Beeper feedback.</p><p>0x00 = On keypress sound disabled</p><p>0x01 = On keypress sound enabled</p></td></tr><tr><td valign="top">TipMode</td><td>byte</td><td><p>Tip mode.</p><p> </p><p>0x00 = Disable Tip Mode</p><p>0x01 = Show Tip GUI immediately using %</p><p>0x02 = Show Tip GUI immediately using $</p><p>0x11 = Enable Read Channel(s), with +Tip Button using %</p><p>0x12 = Enable Read Channel(s), with +Tip Button, using $</p></td></tr><tr><td valign="top">Tip1DisplayMode</td><td>byte</td><td><p>Display mode for Tip button 1.</p><p>0x00 = % or $</p><p>0x01 = Display Custom 0x02 = Display NO TIP 0x03 = Disabled</p></td></tr><tr><td valign="top">Tip2DisplayMode</td><td>byte</td><td><p>Display mode for Tip button 2.</p><p>0x00 = % or $</p><p>0x01 = Display Custom 0x02 = Display NO TIP 0x03 = Disabled</p></td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="174.66668701171875" valign="top"></th><th width="131"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">ITransaction</td></tr><tr><td valign="top">Tip3DisplayMode</td><td>byte</td><td><p>Display mode for Tip button 3.</p><p>0x00 = % or $</p><p>0x01 = Display Custom 0x02 = Display NO TIP 0x03 = Disabled</p></td></tr><tr><td valign="top">Tip4DisplayMode</td><td>byte</td><td><p>Display mode for Tip button 4.</p><p>0x00 = % or $</p><p>0x01 = Display Custom 0x02 = Display NO TIP 0x03 = Disabled</p></td></tr><tr><td valign="top">Tip5DisplayMode</td><td>byte</td><td><p>Display mode for Tip button 5.</p><p>0x00 = % or $</p><p>0x01 = Display Custom 0x02 = Display NO TIP 0x03 = Disabled</p></td></tr><tr><td valign="top">Tip6DisplayMode</td><td>byte</td><td><p>Display mode for Tip button 6.</p><p>0x00 = % or $</p><p>0x01 = Display Custom 0x02 = Display NO TIP 0x03 = Disabled</p></td></tr><tr><td valign="top">Tip1Value</td><td>string Max 7</td><td><p>Display value for Tip button 1.</p><p>“1.00” = $1.00 (Display Mode is $)</p><p>“10.0001” = 10.0001% (Display Mode is %)</p></td></tr><tr><td valign="top">Tip2Value</td><td>string Max 7</td><td><p>Display value for Tip button 2.</p><p>“1.00” = $1.00 (Display Mode is $)</p><p>“10.0001” = 10.0001% (Display Mode is %)</p></td></tr><tr><td valign="top">Tip3Value</td><td>string Max 7</td><td><p>Display value for Tip button 3.</p><p>“1.00” = $1.00 (Display Mode is $)</p><p>“10.0001” = 10.0001% (Display Mode is %)</p></td></tr><tr><td valign="top">Tip4Value</td><td>string Max 7</td><td><p>Display value for Tip button 4.</p><p>“1.00” = $1.00 (Display Mode is $)</p><p>“10.0001” = 10.0001% (Display Mode is %)</p></td></tr><tr><td valign="top">Tip5Value</td><td>string Max 7</td><td><p>Display value for Tip button 5.</p><p>“1.00” = $1.00 (Display Mode is $)</p><p>“10.0001” = 10.0001% (Display Mode is %)</p></td></tr><tr><td valign="top">Tip6Value</td><td>string Max 7</td><td><p>Display value for Tip button 6.</p><p>“1.00” = $1.00 (Display Mode is $)</p><p>“10.0001” = 10.0001% (Display Mode is %)</p></td></tr><tr><td valign="top">TaxAmount</td><td>string Max 7</td><td><p>Tax amount.</p><p>“1.00” = $1.00</p></td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="256.6666259765625" valign="top"></th><th width="93.33331298828125"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">ITransaction</td></tr><tr><td valign="top">FunctionalButtonRight Option</td><td>byte[] 2</td><td><p>String ID to use for the Right functional button. The byte array is null by default.</p><p>When user presses this button, device sends a notification to the host to indicate the present card functional button Right is pressed. Device then waits for the next command from the host. While waiting, the screen shows “PLEASE WAIT”.</p><p>NULL = Disable.</p><p>0x0000 to 0x00FF = String ID</p></td></tr></tbody></table>

### NFCData <a href="#id-10.9_nfcdata" id="id-10.9_nfcdata"></a>

These constructors initialize an NFCData object. Use NFCDataBuilder.GetNFCData with data byte array from the NFCData event to return an NFCData.

{% code overflow="wrap" %}

```
NFCData NFCDataBuilder.GetNFCData( 
DeviceType deviceType,
byte[] dataBytes);

new NFCData(
        byte[] Data, 
        boolean Encrypted,
        byte EncryptionType, 
        byte[] KSN
        );
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="185" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Member</td><td valign="top">Description</td></tr><tr><td valign="top">Data()</td><td valign="top">Returns the data payload.</td></tr><tr><td valign="top">Encrypted()</td><td valign="top">Returns the encryption status. false = data is not encrypted true = data is encrypted</td></tr><tr><td valign="top">EncryptionType()</td><td valign="top">Returns the encryption type.</td></tr><tr><td valign="top">KSN()</td><td valign="top">Returns the Key Serial Number.</td></tr></tbody></table>

Return Value:

Returns an instance of NFCData.

### NFCRAPDUData <a href="#id-10.10_nfcrapdudata" id="id-10.10_nfcrapdudata"></a>

These constructors initialize an NFCRAPDUData object. Use NFCDataBuilder.GetNFCRAPDUData with data byte array from the NFCRAPDUResponse event to return an NFCRAPDUData.

{% code overflow="wrap" %}

```
NFCRAPDUData NFCRAPDU(
    byte[] response, 
    byte[] data, 
    boolean encrypted,
    byte encryptionType, 
    byte[] ksn
    );
NFCRAPDUData NFCDataBuilder.GetNFCRAPDUData( 
    DeviceType deviceType,
    byte[] dataBytes,
    );
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="153" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Parameter</td><td valign="top">Description</td></tr><tr><td valign="top">response</td><td valign="top">Response data.</td></tr><tr><td valign="top">data</td><td valign="top">The data payload.</td></tr><tr><td valign="top">encrypted</td><td valign="top"><p>Encryption status.</p><p>false = data is not encrypted true = data is encrypted</p></td></tr><tr><td valign="top">encryptionType</td><td valign="top">The encryption type.</td></tr><tr><td valign="top">ksn</td><td valign="top">The Key Serial Number.</td></tr><tr><td valign="top">deviceType</td><td valign="top">Device type.</td></tr><tr><td valign="top">dataBytes</td><td valign="top">Data bytes from the NFCAPDUResponse event.</td></tr></tbody></table>

Return Value:

Returns an instance of NFCRAPDUData.

### NFCEventBuilder <a href="#id-10.11_nfceventbuilder" id="id-10.11_nfceventbuilder"></a>

This class assist in parsing NFCEvent data.

<table data-header-hidden><thead><tr><th width="231.66668701171875" valign="top"></th><th width="128"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">Static</td></tr><tr><td valign="top">Member</td><td>Return</td><td>Description</td></tr><tr><td valign="top">GetDetail(string data)</td><td>string</td><td>Returns a string containing NFC detail.</td></tr><tr><td valign="top">GetEventValue(string data)</td><td>NFCEvent</td><td>Returns the NFCEvent enumeration.</td></tr><tr><td valign="top">GetString(NFCEvent value)</td><td>string</td><td>Returns a string representation of NFCEvent enumeration.</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="249.66668701171875" valign="top"></th><th width="91.33331298828125"></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">Static</td></tr><tr><td valign="top">Member</td><td>Value</td><td>Description</td></tr><tr><td valign="top">NFC_MIFARE_ULTRALIGHT</td><td>String</td><td>"nfc_mifare_ultralight"</td></tr><tr><td valign="top">MIFARE_CLASSIC_1K</td><td>String</td><td>"mifare_classic_1k"</td></tr><tr><td valign="top">MIFARE_CLASSIC_4K</td><td>String</td><td>"mifare_classic_4k"</td></tr><tr><td valign="top">MIFARE_DESFIRE</td><td>String</td><td>“mifare_desfire”</td></tr><tr><td valign="top">TAG_REMOVED</td><td>String</td><td>"tag_removed"</td></tr><tr><td valign="top">FAILED</td><td>String</td><td>"failed"</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th valign="top"></th><th></th><th></th></tr></thead><tbody><tr><td colspan="3" valign="top">Static</td></tr><tr><td valign="top">IO_FAILED</td><td>String</td><td>"io_failed"</td></tr><tr><td valign="top">AUTHENTICATION_FAILED</td><td>String</td><td>"authentication_failed"</td></tr></tbody></table>

### PersonalInfoEntry <a href="#id-10.12_personalinfoentry" id="id-10.12_personalinfoentry"></a>

These constructors initialize a PersonalInfoEntry object.

* Call startPersonalInfoEntry()
* At OnEvent():TouchscreenPersonalInfoEntry build the object.

{% code overflow="wrap" %}

```
PersonalInfoEntry PersonalInfoEntry.GetPersonalInfoEntry( 
DeviceType deviceType,
byte[] dataBytes);

new PersonalInfoEntry( 
    byte[] Data, 
    CaptureType DataType, 
    bool Encrypted,
    byte EncryptionType, 
    byte[] KSN
    );
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="133.66665649414062" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Member</td><td valign="top">Description</td></tr><tr><td valign="top">deviceType</td><td valign="top">Type of device.</td></tr><tr><td valign="top">dataBytes</td><td valign="top">Data to pass in from OnEvent().</td></tr><tr><td valign="top">Data()</td><td valign="top">Returns the data payload.</td></tr><tr><td valign="top">DataType()</td><td valign="top">Returns the capture type.</td></tr><tr><td valign="top">Encrypted()</td><td valign="top">Returns the encryption status. false = data is not encrypted true = data is encrypted</td></tr><tr><td valign="top">EncryptionType()</td><td valign="top">Returns the encryption type.</td></tr><tr><td valign="top">KSN()</td><td valign="top">Returns the Key Serial Number.</td></tr></tbody></table>

Return Value:

Returns an instance of PersonalInfoEntry.

### PersonalInfoEntryBuilder <a href="#id-10.13_personalinfoentrybuilder" id="id-10.13_personalinfoentrybuilder"></a>

This class assist in parsing PersonalInfoEntry data.

* Call startPersonalInfoEntry()
* At OnEvent():TouchscreenPersonalInfoEntry build the object.

{% code overflow="wrap" %}

```
PersonalInfoEntry GetPersonalInfoEntry( 
DeviceType deviceType,
byte[] dataBytes);
```

{% endcode %}

<table data-header-hidden><thead><tr><th width="128.33331298828125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Member</td><td valign="top">Description</td></tr><tr><td valign="top">deviceType</td><td valign="top">Type of device.</td></tr><tr><td valign="top">dataBytes</td><td valign="top">Data to pass in from OnEvent().</td></tr></tbody></table>

Return Value:

Returns an instance of PersonalInfoEntry.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.magtek.com/sdks-and-tools/universal-sdk-documentation/.net-windows/classes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
