Device Name Query
Last updated: 23-Sep-2025
This command retrieves the device name stored on the payment device.
Rules
The GET_DEVICENAME command is intended for non-payment purposes and is to be used outside of a payment transaction.
Configuration Parameters
Following are the related configuration parameters for this functionality. Refer to Application Parameters table for the parameter details.
- DEVICENAME
- DEVICENAMEENABLED
Note
Device Name Query functionality is independent of any configurable parameters. However, when the above mentioned parameters are set to the required, Device name query responses with that value in the DEVICENAME field.
GET_DEVICENAME (Message Interface)
The following tables provide detailed protocol information, including field descriptions and examples.
Device UI Required: No
Request Packet
Note
Neo device (M450) is being used to capture screenshots for the Device UI Requirement section.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | DEVICE | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | GET_DEVICENAME | Command name |
| POS_RECON | Optional | Character | 1 | 30 | POS reconciliation. POS Reconciliation field to be echoed back in response to POS. Example: RetailPOS1 | |
| COUNTER | Required | Numeric | 1 | 10 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. This is used to authenticate the POS. Example: 100 | |
| MAC | Required | Base64 Encoded Data | N/A | N/A | N/A | Message Authentication Code. This is used to authenticate the POS. |
| MAC_LABEL | Required | Character | 1 | 50 | Associated label that tells the device which MAC_KEY to use to decrypt the value of MAC. This is used to authenticate the POS. Example: REG1 |
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>GET_DEVICENAME</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: Operation SUCCESSFUL | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1, 59006, 59040 | This indicates the result code. Refer to Result/Error Codes for details. |
| TERMINATION_STATUS | Character | SUCCESS or FAILURE | This indicates the transaction termination status. This is the overall status of the transaction irrespective of approved or declined. Like, if the output is generated then the status is SUCCESS and if no output is generated then the status will be FAILURE. |
| DEVICENAME | Character | Device name stored on the payment device. May be null if no device name was set up at network configuration. Example: LANE1 | |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 | |
| MAC_LABELS | List | List of MAC labels. Example: P_29K19J|P_48HDYL|P_6GQCE5|P_6JP4D7|P_7528ZO|P_7WO2PW|P_89G499|P_9BGLEO|P_FEZ2AP|P_GLZOFA|P_IJAJ6Z|P_LZIY1G|P_RD8FDD|P_XO95BS|P_Y3V1Q0|P_Z7I2IJ | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 |
Transaction Performance Metric
Note
These fields are returned, if SCAPERFMETRIC parameter (Application Parameters) is enabled.
| Field | Type | Value | Description |
|---|---|---|---|
| UI_TIME | Time | This indicates the time duration, for which the device screen is displayed (like error message, prompt screen, remove card screen) till any user action is performed in the command execution flow. This field is not applicable to capture the time for the Processing, Authorizing and transaction status screen. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <UI_TIME>44.028</UI_TIME> |
|
| HOST_TIME | Time | This indicates the time taken for the Connection to the host, sending request and receives data from the host. This field also take the cumulative time for multiple requests which may sent to the host during the transaction including two legged transactions, timeout requests, Auto Last Tran requests, DCC, Credit app proxy. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <HOST_TIME>1.389</HOST_TIME> |
|
| CMD_TIME | Time | This field indicates the total amount of time for a command, which is executed by the application from request received to the response sent. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <CMD_TIME>70.765</CMD_TIME> |
Example
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>Operation SUCCESSFUL</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<DEVICENAME>POINTSCA</DEVICENAME>
<MAC_LABELS>P_29K19J|P_48HDYL|P_6GQCE5|P_6JP4D7|P_7528ZO|P_7WO2PW|P_89G499|P_9BGLEO|P_FEZ2AP|P_GLZOFA|P_IJAJ6Z|P_LZIY1G|P_RD8FDD|P_XO95BS|P_Y3V1Q0|P_Z7I2IJ</MAC_LABELS>
<COUNTER>26</COUNTER>
</RESPONSE>
Rate this article:
