SET_PARM
Last updated: 07-Apr-2025
This command is used to set SCA parameters on the payment device. Direct to Processor implementations only. Not supported by TSYS Direct Engage.
Device UI Required: No
Request Packet
| 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 | SET_PARM | Command name. |
| PARAM | Optional | Character | 1 | If the user wants to set multiple parameters, then each parameter should be separated by pipe | symbol in request. Example: 1: TIP=PROMPT; 2: GRATUITYPERCENT1=1000|GRATUITYPERCENT2=1100 | ||
| PARM_MID | Optional | Numeric | 1 | 20 | Merchant Gateway ID | |
| PARM_TID | Optional | Numeric | 1 | 20 | Terminal ID | |
| PARM_LANE | Optional | Numeric | 1 | 20 | Lane ID | |
| PARM_HOST_IND | Required | List | 1 | 20 |
|
Host to which the values correspond. Example: VANTIV |
| PARM_ADMINURL | Optional | Character | 1 | 80 | Admin URL | |
| PARM_PRIMURL | Optional | Character | 1 | 80 | Primary URL | |
| PARM_SCNDURL | Optional | Character | 1 | 80 | Secondary URL | |
| PARM_USERNAME | Optional | Character | 1 | 20 | Username | |
| PARM_PASSWORD | Optional | Character | 1 | 20 | Password | |
| ARM_ALTMERCHID | Optional | Numeric | 1 | 20 | Alternative merchant ID | |
| PARM_TIMEZONE | Optional | Numeric | 1 | 20 | Time zone | |
| PARM_TOKEN_TYPE | Optional | Character | 1 | 20 | Token type | |
| PARM_PARTNERID | Optional | Character | 1 | 20 | ||
| PARM_TRANSPORT_KEY | Optional | Character | 1 | 20 | Transport key | |
| 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 sed to authenticate the POS. Example: 18 | |
| 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>SET_PARM</COMMAND>
<PARAM>GRATUITYPERCENT1=1000|GRATUITYPERCENT2=1100</PARAM>
<PARM_HOST_IND>FDRC</PARM_HOST_IND>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: VTP COMMND PROCESSED418 | |
| RESULT | Character | This indicates the Result details. Example: CAPTURED | |
| RESULT_CODE | Numeric | Expected result code: -1, 4, 59001, 59006, 59040 | This indicates the result code. |
| TERMINATION_STATUS | Character | SUCCESS and 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. |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 18 |
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> |
NOTE: After modification of the MID/TID/URLS/Lane ID or any host related parameters it is required to restart the application for the parameter to take an effect.
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>
<COUNTER>144</COUNTER>
</RESPONSE>
Rate this article:
