> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_b259c67979486db4cd1816234700c14a/dir_699851f087f6e6136e28f04fc8a16e7d/msr__common_8h.md). # msr\_common.h [Data Structures](#nested-classes) | [Macros](#define-members) | [Typedefs](#typedef-members) | [Functions](#func-members) This graph shows which files directly or indirectly include this file: ![](/files/T1hzxqAnESyx9gFZYwHl) [Go to the source code of this file.](/adk-5.0-programmers-guide/msr__common_8h_source.md) | | | | --------------- | ------------------------------------------------------------ | | Data Structures | | | struct | [MSR\_Track\_1](#struct_m_s_r___track__1) | | struct | [MSR\_Track\_2](#struct_m_s_r___track__2) | | struct | [MSR\_Track\_3](#struct_m_s_r___track__3) | | struct | [MSR\_TrackData](#struct_m_s_r___track_data) | | struct | [MSR\_TrackData2](#struct_m_s_r___track_data2) | | struct | [MSR\_TrackData3](#struct_m_s_r___track_data3) | | struct | [MSR\_TrackData4](#struct_m_s_r___track_data4) | | struct | [MSR\_Decoded\_Track\_1](#struct_m_s_r___decoded___track__1) | | struct | [MSR\_Decoded\_Track\_2](#struct_m_s_r___decoded___track__2) | | struct | [MSR\_DecodedData](#struct_m_s_r___decoded_data) | | struct | [MSR\_DecodedData4](#struct_m_s_r___decoded_data4) | | | | | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Macros | | | #define | [MSR\_OK](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#ga56ff5f02000b1dcc767ffeea8f6478a7) 0 | | #define | [MSR\_ERROR](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#ga2754c1ade01b6307220538b6bb3f885a) -1 | | #define | [MSR\_TIMEOUT](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#ga7748ace924420e05ea909b2944de3ba5) -2 | | #define | [MSR\_ABORTED](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#ga82fd0492568ada8925a66121a6f03935) -3 | | #define | [MSR\_ACTIVE](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#ga1c81c696181e8a6201fd677a7b65252a) -4 | | #define | [MSR\_PARAM](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#gade0e4ea4922a01a559e73f5c3d0e4f03) -5 | | #define | [MSR\_PROCESS](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#ga2af4877ec63b78f5c2a85d77813bc056) -6 | | #define | [MSR\_NO\_DEVICE](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___e_r_r_o_r___c_o_d_e_s.md#gac5b787f430958b4aa763512e00a8a2d0) -7 | | #define | [MSR\_STATUS\_NOERR](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga791110bd9543183bccb3576c41575938) 0 | | #define | [MSR\_STATUS\_NODATA](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga78f00eb4a34fb6966520570d235bd36a) 1 | | #define | [MSR\_STATUS\_NOSTX](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga5da86efc698957f2c01ffb169c9d1102) 2 | | #define | [MSR\_STATUS\_NOETX](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga759e75448ce4d6b1560c5b65e2d19f65) 3 | | #define | [MSR\_STATUS\_BADLRC](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#gaf431be387ced31744bc6456927ada79c) 4 | | #define | [MSR\_STATUS\_PARITY](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#gaf57d5c094671227287fc967b5750b98a) 5 | | #define | [MSR\_STATUS\_REVETX](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga3424e09ced6c7d2a7dae1b44e6308cfe) 6 | | #define | [MSR\_STATUS\_BADJIS](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga0c6116104431a3b7c405427a07142dd1) 7 | | #define | [MSR\_STATUS\_BADTRK](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md#ga23f94d4756b6a52ea54f9ad22c33cea6) 8 | | #define | [MSR\_TYPE\_PHYSICAL](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___c_a_r_d___c_o_d_e_s.md#ga1f9ee619462acf4e0999965beb6a2825) 0 | | #define | [MSR\_TYPE\_SAMSUNG](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___c_a_r_d___c_o_d_e_s.md#gaecc9c77eb4203573d61e90952bbe1d20) 1 | | #define | [MSR\_CARD\_UNKNOWN](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md#ga723f8beb3336381c5ecb8f1ec9bba0f4) 0x00 | | #define | [MSR\_CARD\_ISO](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md#gacd72026476677415eaf482b2fb2e0032) 0x01 | | #define | [MSR\_CARD\_JIS\_II](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md#gaf1dad30c2494f4da59022687eb8e9dc1) 0x02 | | #define | [MSR\_CARD\_AAMVA](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md#ga6cc72de09ffb5837fe5c292afaccba2e) 0x04 | | #define | [MSR\_CARD\_CADLID](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md#ga73c4fdf1b21740a38b2d3a3bf00d3f00) 0x08 | | #define | [MSR\_UX\_ENHANCEMENTS](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#ga2a413b4af9749ddf671d95422930aa38) 0x01 | | |

options\[0] Hybrid reader: ignore card insertion More...

| | #define | [MSR\_SAMSUNG\_TRACK1](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#ga438dcfd6297f14140bc73db42ea4c54e) 0x02 | | |

options\[0] not used anymore More...

| | #define | [MSR\_ONE\_SWIPE](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#gaa4d91d314d57eb36a8816606cd4ccc18) 0x04 | | |

options\[0] Only read on first swipe More...

| | #define | [MSR\_LEDS](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#ga34c87a41aa36b56652314f471121b53a) 0x08 | | |

options\[0] Light MSR LEDs while card swipe is possible. More...

| | #define | [MSR\_ENABLE\_LICENSE\_DECODE](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#ga57908026ec7d34ab1eab699f5a01bfdc) 0x10 | | |

options\[0] Enable detection of US driving license More...

| | #define | [MSR\_DETECT\_ISO](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#ga552908ea327761a80fc0557a4f617f97) 0x01 | | |

options\[1] Detect ISO cards More...

| | #define | [MSR\_DETECT\_JIS\_II](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#ga9f84cf93e845a72a46da5530a2f0fda6) 0x02 | | |

options\[1] Detect JIS-II cards More...

| | #define | [MSR\_DETECT\_ALL](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___o_p_t_i_o_n_s___b_i_t_m_a_s_k.md#gaa52493f56c3780ac75f5ca4043c3c5fa) 0x03 | | |

options\[1] Detect both ISO and JIS-II cards. More...

| | #define | [MSR\_LED\_OFF](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#ga732d5b4b7e9dc86936491616790f521c) 0x0000 | | #define | [MSR\_LED\_WHITE](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#gaf154b2af61487136381570a0a65eae95) 0x0001 | | #define | [MSR\_LED\_RED](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#ga9d645bdc79cf473ad1a4cb2c16e0d540) 0x0002 | | #define | [MSR\_LED\_GREEN](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#ga2e04bf1f17254549f2b8d591a4ea9474) 0x0003 | | #define | [MSR\_LED\_BLUE](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#ga02373c78ce2427317ac035d08e1fdc17) 0x0004 | | #define | [MSR\_LED\_YELLOW](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#ga5ed7fb7eb095670a3901df7f3ddebc50) 0x0005 | | #define | [MSR\_LED\_BLINK](/adk-5.0-programmers-guide/readme/modules/group___l_e_d___s_t_a_t_e_s.md#gac0602288caa7d6664024a579091ccaa2) 0x0100 | | | | | --------------- | ----------------------------------------------------------------------------------------- | | Typedefs | | | typedef void(\* | [MSR\_TraceCallback](#a812e455c2b03675c3df6148b21a87ae4)) (const char \*str, void \*data) | | | | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | void | [MSR\_Version](#a4c82e0afa0ae93bb7a97a03431c202b8) (char \*version, unsigned char len) | | void | [MSR\_SetTraceCallback](#ac4fab89b234ae87c7da91fb529b833e0) ([MSR\_TraceCallback](#a812e455c2b03675c3df6148b21a87ae4) cbf, void \*cb\_data) | *** ### DataStructure Documentation ### MSR\_Track\_1 struct MSR\_Track\_1 Track data of track 1. | | | | | ------------- | --------- | ---------------------------------------------------------------------------------------------------- | | Data Fields | | | | char | data\[80] | Track data including start sentinel, end sentinel and LRC, ASCII null-terminated. | | unsigned char | status | [Status code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md). | ### MSR\_Track\_2 struct MSR\_Track\_2 Track data of track 2. | | | | | ------------- | --------- | ---------------------------------------------------------------------------------------------------- | | Data Fields | | | | char | data\[41] | Track data including start sentinel, end sentinel and LRC, ASCII null-terminated. | | unsigned char | status | [Status code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md). | ### MSR\_Track\_3 struct MSR\_Track\_3 Track data of track 3. | | | | | ------------- | ---------- | ---------------------------------------------------------------------------------------------------- | | Data Fields | | | | char | data\[108] | Track data, ASCII null-terminated. | | unsigned char | status | [Status code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___s_t_a_t_u_s___c_o_d_e_s.md). | ### MSR\_TrackData struct MSR\_TrackData Track data. Collaboration diagram for MSR\_TrackData: ![Collaboration graph](/files/JKmff9I87vytPjVpfXx0) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | ----------------------------------------- | -- | ---------------------- | | Data Fields | | | | [MSR\_Track\_1](#struct_m_s_r___track__1) | t1 | Track data of track 1. | | [MSR\_Track\_2](#struct_m_s_r___track__2) | t2 | Track data of track 2. | | [MSR\_Track\_3](#struct_m_s_r___track__3) | t3 | Track data of track 3. | ### MSR\_TrackData2 struct MSR\_TrackData2 Track data including card type. Collaboration diagram for MSR\_TrackData2: ![Collaboration graph](/files/c3PRCm5Bh9fshuRwwttv) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | ----------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------- | | Data Fields | | | | unsigned char | card\_type | [Card Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___c_a_r_d___c_o_d_e_s.md). | | [MSR\_Track\_1](#struct_m_s_r___track__1) | t1 | Track data of track 1. | | [MSR\_Track\_2](#struct_m_s_r___track__2) | t2 | Track data of track 2. | | [MSR\_Track\_3](#struct_m_s_r___track__3) | t3 | Track data of track 3. | ### MSR\_TrackData3 struct MSR\_TrackData3 Track data including additional information. Collaboration diagram for MSR\_TrackData3: ![Collaboration graph](/files/1EggjNmnfYphSrFp5Jr2) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | ----------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Data Fields | | | | unsigned char | add\_info\[8] | additional information, add\_info\[0]: [Card Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___c_a_r_d___c_o_d_e_s.md), add\_info\[1]: [Track Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md), add\_info\[2..7]: RFU. | | [MSR\_Track\_1](#struct_m_s_r___track__1) | t1 | Track data of track 1. | | [MSR\_Track\_2](#struct_m_s_r___track__2) | t2 | Track data of track 2. | | [MSR\_Track\_3](#struct_m_s_r___track__3) | t3 | Track data of track 3. | ### MSR\_TrackData4 struct MSR\_TrackData4 Track data including additional information. Collaboration diagram for MSR\_TrackData4: ![Collaboration graph](/files/9ZhzNN1JSRKEmb8bmobY) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | ----------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Data Fields | | | | unsigned char | add\_info\[8] | Additional information, add\_info\[0]: [Card Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___c_a_r_d___c_o_d_e_s.md), add\_info\[1]: [Track Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md), add\_info\[2..7]: RFU. | | unsigned char | add\_info2\[8] | Second magstripe: Additional information, add\_info\[0]: [Card Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___c_a_r_d___c_o_d_e_s.md), add\_info\[1]: [Track Type Code](/adk-5.0-programmers-guide/readme/modules/group___m_s_r___t_r_a_c_k___t_y_p_e_s.md), add\_info\[2..7]: RFU. | | [MSR\_Track\_1](#struct_m_s_r___track__1) | t1 | Track data of track 1. | | [MSR\_Track\_2](#struct_m_s_r___track__2) | t2 | Track data of track 2. | | [MSR\_Track\_1](#struct_m_s_r___track__1) | t21 | Second magstripe: Track data of track 1. | | [MSR\_Track\_2](#struct_m_s_r___track__2) | t22 | Second magstripe: Track data of track 2. | | [MSR\_Track\_3](#struct_m_s_r___track__3) | t23 | Second magstripe: Track data of track 3. | | [MSR\_Track\_3](#struct_m_s_r___track__3) | t3 | Track data of track 3. | ### MSR\_Decoded\_Track\_1 struct MSR\_Decoded\_Track\_1 Decoded data of track 1. | | | | | ------------- | ----------------- | ------------------------------------------ | | Data Fields | | | | char | disc\_data\[72] | Discretionary data, ASCII null terminated. | | char | exp\_date\[5] | Expiry date, YYMM, ASCII null terminated. | | char | name\[27] | Cardholder name, ASCII null-terminated. | | char | pan\[20] | PAN, ASCII null-terminated. | | char | service\_code\[4] | Service code, ASCII null terminated. | | unsigned char | valid | 1: data valid, 0: data invalid. | ### MSR\_Decoded\_Track\_2 struct MSR\_Decoded\_Track\_2 Decoded data of track 2. | | | | | ------------- | ----------------- | ------------------------------------------ | | Data Fields | | | | char | disc\_data\[35] | Discretionary data, ASCII null terminated. | | char | exp\_date\[5] | Expiry date, YYMM, ASCII null terminated. | | char | pan\[20] | PAN, ASCII null-terminated. | | char | service\_code\[4] | Service code, ASCII null terminated. | | unsigned char | valid | 1: data valid, 0: data invalid. | ### MSR\_DecodedData struct MSR\_DecodedData Decoded track data. Collaboration diagram for MSR\_DecodedData: ![Collaboration graph](/files/96NjI8x9FBU9Yor1nEiN) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | ------------------------------------------------------------ | -- | ------------------------ | | Data Fields | | | | [MSR\_Decoded\_Track\_1](#struct_m_s_r___decoded___track__1) | t1 | Decoded data of track 1. | | [MSR\_Decoded\_Track\_2](#struct_m_s_r___decoded___track__2) | t2 | Decoded data of track 2. | ### MSR\_DecodedData4 struct MSR\_DecodedData4 Decoded track data. Collaboration diagram for MSR\_DecodedData4: ![Collaboration graph](/files/UEWpnXb7kER5rPCHj95Z) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | ------------------------------------------------------------ | --- | ------------------------------------------ | | Data Fields | | | | [MSR\_Decoded\_Track\_1](#struct_m_s_r___decoded___track__1) | t1 | Decoded data of track 1. | | [MSR\_Decoded\_Track\_2](#struct_m_s_r___decoded___track__2) | t2 | Decoded data of track 2. | | [MSR\_Decoded\_Track\_1](#struct_m_s_r___decoded___track__1) | t21 | Second magstripe: Decoded data of track 1. | | [MSR\_Decoded\_Track\_2](#struct_m_s_r___decoded___track__2) | t22 | Second magstripe: Decoded data of track 2. | ### TypedefDocumentation ### MSR\_TraceCallback typedef void(\\\* MSR\_TraceCallback) (const char \\\*str, void \\\*data) Type of function that is called for traces, see [MSR\_SetTraceCallback()](#ac4fab89b234ae87c7da91fb529b833e0) **Parameters** \[in] **str** : Trace message. \[in] **data** : Data pointer provided by the application. ### FunctionDocumentation ### MSR\_SetTraceCallback() void MSR\_SetTraceCallback Set callback function for trace output. **Parameters** \[in] **cbf** : Callback function for trace messages, may be NULL. \[in] **cb\_data** : Data pointer that is passed on to the callback function cbf, may be NULL. ### MSR\_Version() void MSR\_Version Get version of libmsr. **Parameters** \[out] **version** : Buffer to store null-terminated version string. \[in] **len** : Size of buffer version. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_b259c67979486db4cd1816234700c14a/dir_699851f087f6e6136e28f04fc8a16e7d/msr__common_8h.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.