GET SAF STATUS
Last updated: 04-Dec-2024
This command is used to obtain the status if the terminal has any SAF transactions, through a secondary port command.
Prerequisites: The terminal should be fully initialized on Idle screen.
Device UI Required: No
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | SECONDARYPORT | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | GET_SAF_STATUS | 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 | 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>SECONDARYPORT</FUNCTION_TYPE>
<COMMAND>GET_SAF_STATUS</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: SUCCESS | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1 | This indicates the result code. Refer to Result/Error Codes for details. |
| 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. |
| TOTAL_AMOUNT | Floating point number | 500.00 | Total amount of transactions in the SAF Table. This is a mandatory field. This is a total of Eligible, Processed, Deferred, Pre-Auth and Declined transactions. |
| COMPLETED_AMOUNT | Floating point number | 100.00 | This field is present if there are Declined, Processed Transactions in the database. This is a conditional field. |
| TOTAL_SAF_COUNT | Numeric | 50 | Total number of records present in the SAF Table. This is a mandatory field. |
| ELIGIBLE_COUNT | Numeric | 20 | This is a conditional field and present only if there are any Eligible transactions in the database. |
| DECLINED_COUNT | Numeric | 10 | This is a conditional field and present only if there are any Declined transactions in the database. |
| DEFERRED_COUNT | Numeric | 5 | This is a conditional field and present only if there are any Deferred transactions in the database. |
| IN_PROCESS_COUNT | Numeric | 1 | Number of transaction which are In-Process. This is a conditional field and present only if there are any In-Process transactions in the database. |
| PREAUTH_COUNT | Numeric | 15 | This is a conditional field and present only if there are any Pre-Auth transactions in the database. |
| PROCESSED_COUNT | Numeric | Number of transactions which are already processed. | |
| NOT_PROCESSED_COUNT | Numeric | Number of transactions those are not processed. | |
| MACLABEL_IN_SESSION | Character | Applicable when session is in progress. Example: P_GBO | |
| SESSION_DURATION | Numeric | Applicable when session is in progress. Example: HH:MM:SS | |
| INVOICE_SESSION | Numeric | Invoice number supplied by the POS Start Session for the session that is in progress. Only applicable when session is in progress. Example: 98985 | |
| DEVICENAME | Character | Device name. Example: LANE1 | |
| SERIALNUMBER | Numeric | Serial number of the device. Example: 987-654-321 | |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 |
Example
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>SUCCESS</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TOTAL_AMOUNT>50.00</TOTAL_AMOUNT>
<COMPLETED_AMOUNT>15.00</COMPLETED_AMOUNT>
<TOTAL_SAF_COUNT>32</TOTAL_SAF_COUNT>
<ELIGIBLE_COUNT>7</ELIGIBLE_COUNT>
<IN_PROCESS_COUNT>0</IN_PROCESS_COUNT>
<DECLINED_COUNT>2</DECLINED_COUNT>
<DEFERRED_COUNT>3</DEFERRED_COUNT>
<PREAUTH_COUNT>15</PREAUTH_COUNT>
<PROCESSED_COUNT>5</PROCESSED_COUNT>
</RESPONSE>
Rate this article:
