STATUS
Last updated: 04-Dec-2024
This command queries the status of a device.
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 | 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>STATUS</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: SUCCESS or MSG_SECONDARYPORT_STATUS_SUCCESS | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1, 59001, 59006 | 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. |
| SECONDARY_DATA | Numeric | Refer to Secondary Data Values for all the secondary data value. | This indicates the status of the secondary data upon sending queries on the device. |
| DETAILED_STATUS | Numeric | Refer to Detailed Status Values for all the status codes and description. | Returns the status code. |
| MACLABEL_IN_SESSION | Character | MACLABEL is in session. This is applicable when session is in progress. Example: P_GBO | |
| SESSION_DURATION | Character | This indicates the duration of the session. This is applicable when session is in progress. Example: HH:MM:SS | |
| INVOICE_SESSION | Character | 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 | This indicates the serial number of the terminal. Example: POINTSCA | |
| SERIALNUMBER | Character | This indicates the serial number of the terminal. Example: 987-654-321 | |
| BATTERY_LEVEL | Numeric | This field indicates the current battery level of the terminal (for example: e280, e285, v400m) This is applicable to all battery devices. For non-battery devices, this field will not be returned in the STATUS response. The value will be an integer between 0 and 100 (in percentage). Example: 64 | |
| 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>
<BATTERY_LEVEL>64</BATTERY_LEVEL>
<SECONDARY_DATA>11</SECONDARY_DATA>
<DETAILED_STATUS>40</DETAILED_STATUS>
<MACLABEL_IN_SESSION>REG1</MACLABEL_IN_SESSION>
<SESSION_DURATION>00:10:05</SESSION_DURATION>
<DEVICENAME>LANE1</DEVICENAME>
<SERIALNUMBER>987-654-321</SERIALNUMBER>
<INVOICE_SESSION>12345</INVOICE_SESSION>
</RESPONSE>
Secondary Data Values
Following table describes the valid values, received by POS in SECONDARY_DATA field of STATUS command response.
| Valid Values | Definition | Description | Device Screen Status | Associated Commands |
|---|---|---|---|---|
| 0 | CANCELLED | This value returned when Secondary port CANCEL is processed. | Transaction status screen indicating POS Cancelled. | This Status would be returned for any payment and device command when secondary port cancel command is being exercised. |
| 10 | NO SESSION IDLE | Device is on Idle screen and there is no open session. | Idle screen | |
| 11 | IN SESSION IDLE | When Session is started , and there is no active transaction yet. This value is returned when Line items are disabled for the device. | Welcome screen | |
| 12 | IN SESSION LINE ITEM | When Session is started , and there is no active transaction yet. This value is returned when Line items are enabled for the device. | Line-item screen | |
| 13 | IN SESSION PAYMENT | Within the session when payment transaction is being processed. | Card entry, Pin entry, Tip entry, Amount confirmation, DCC selection screen. | Payment commands |
| 14 | POSTING PAYMENT | When transaction is in-flight for Sale, Pre-Auth, Completion. | Authorization screen | Auth, Capture |
| 16 | CAPTURING VOID | Device is processing void transaction | Authorizing screen | Void |
| 17 | PROCESSING VOID | Void transaction is in-flight. | Authorization screen and Transaction status screen. | Void |
| 18 | CAPTURING REFUND | Device is processing Refund transaction. | Card Entry screen. | Credit |
| 19 | POSTING REFUND | Refund transaction is in-flight. | Authorization screen and transaction status screen. | Credit |
| 20 | CAPTURING GIFT | Device is processing for all the Gift transaction. This is also applicable for EBT/Private Label balance transaction. | Card Entry screen | Gift commands and EBT Balance command |
| 21 | POSTING GIFT | Gift transaction is in-flight. | Authorization screen and transaction status screen. | Gift commands |
| 23 | SAF QUERY | Device is processing SAF query. | SAF Query | |
| 24 | SAF REMOVAL | Device is processing SAF removal. | SAF Removal | |
| 25 | CAPTURING MAIL | Device is processing Email command. | Email capture screen | Device Command - Email |
| 26 | CAPTURING CUST QUESTION | Device is processing Customer question command. | Customer question screen | Device Command - Customer question |
| 27 | CAPTURING CUST SURVEY | Device is processing Customer survey commands. | Survey screen | Device Command - Survey5, Survey10, Survey |
| 28 | CAPTURING LOYALTY | Device is processing Loyalty details. | Loyalty command flow screens | Device Command - Loyalty |
| 29 | CAPTURING SIGNATURE | Device is processing Signature command. | Signature capture screen | Device Command - Signature Capture and Signature Capture Expanded |
| 30 | CAPTURING CHARITY | Device is processing Charity command. | Charity Donation screen. | Device Command - Charity |
| 31 | CAPTURING VERSION | Device is processing Version command. | Version Screen NOTE: Terminal will display system information on screen, only if DISPLAY_VERSION field is set to 1. Refer to VERSION command more details on the request fields. | Device Command - Version |
| 32 | CAPTURING CUST BUTTON | Device is processing Customer button. | Customer button screen | Device Command - Customer Button |
| 33 | LANE_CLOSED | After the device processing lane closed command. | Lane closed screen | Lane Closed |
| 34 | IN_WELCOME_SCREEN | This returns when the session is active. On Welcome screen when card readers are not active, and no card data is presented. (i.e. No card has been tapped, inserted, or swiped yet) | Welcome Screen | |
| 35 | CAPTURING CREDIT APP | Device is processing Credit App command. | Credit app screen | Device Command - Credit App |
| 41 | TRANSACTION COMPLETED | This returns when the device is in Transaction status screen after successfully completing the payment transaction. | Transaction status screen | Payment commands |
| 42 | PROCESSING_SET_PARM | Device is processing Set Parm command. | Device Command - Set Parameter | |
| 43 | PROCESSING_GET_PARM | Device is processing Get Parm command. | Device Command - Get Parameter | |
| 44 | PROCESSING_VHQ_UPDATES | Device is processing the Apply Updates command to process the VHQ updates available. | Apply Updates | |
| 46 | PROCESSING_DISPLAY_MESSAGE | Device is processing Display Message command. | Display message screen. | Device Command - Display Message |
| 47 | PROCESSING GET CARD DATA | Device is processing Get Card Data command. | ||
| 48 | DISPLAYING_QR_CODE | Device is processing QR code. | QR code screen. | Device Command - Display QR Code |
| 50 | CAPTURING CHECKBOX | Device is processing Checkbox command. | CheckBox screen | Device Command - Checkbox |
| 52 | CAPTURING DISPLAY IMAGE | Device is processing Display Image command. | Display Image screen | Device Command - Display Image |
| 53 | DISPLAYING LEFT PANEL LINE ITEM | Device is proccesing Display Left Panel and Cancel left panel commands. | Display Left Panel screen | Device Commands: Display Left Panel and Cancel Display Left Panel |
| 57 | Klarna ID Check Processing | When application is waiting for Customer ID confirmation from POS during Klarna APM transaction. | Klarna APM screen | Capture with Klarna APM |
| 58 | Barcode Scanning in Progress | Device is processing Multi-Scan Barcode command. | Barcode Start (Multi Scan) and Barcode Stop (Multi-Scan) | |
| 59 | Initializing startup flow | During application startup. NOTE: Once the startup flow is complete, then SCA will be in NO SESSION IDLE state (SECONDARY_DATA 10). | Startup flow screens | |
| 60 | IN CAPK UPDATE | When device is updating CAPK file from the processor. NOTE: This is applicable only to SCA Direct to Fiserv solution. |
Detailed Status Values
Following table defines the valid values, received by POS in DETAILED_STATUS field of STATUS command response.
| Valid Values | Definition |
|---|---|
| -1 | NO STATE. NOTE: Startup Complete with SECONDARY_DATA 10 (NO SESSION IDLE) |
| 0 | TRANSACTION COMPLETED |
| 1 | PROCESSING PLEASE WAIT |
| 2 | CAPTURING CARD DETAILS(Non-Manual Card Entry Mode - Swipe/Insert/Tap) |
| 3 | CAPTURING PIN DETAILS |
| 4 | CAPTURING SPLIT TENDER AMOUNT |
| 5 | CAPTURING TENDER/PAYMENT TYPE |
| 6 | CAPTURING CASHBACK |
| 7 | CAPTURING ACCOUNT NUM (manual) |
| 8 | CAPTURING EXPIRY |
| 9 | CAPTURING CVV |
| 10 | CAPTURING ZIP CODE |
| 11 | CAPTURING CASHBACK AMOUNT |
| 12 | IN LINE ITEM |
| 13 | CANCELLED BY POS |
| 14 | POS WAS DISCONNECTED |
| 15 | REBOOTING DEVICE |
| 16 | CAPTURING PAN CVV EXPIRY |
| 17 | PAN CVV EXPIRY CAPTURED |
| 18 | CAPTURING CVV EXPIRY |
| 19 | CVV EXPIRY CAPTURED |
| 20 | CARD DETAILS CAPTURED |
| 21 | PIN DETAILS CAPTURED |
| 22 | SPLIT TENDER CAPTURED |
| 23 | TENDER TYPE CAPTURED |
| 34 | CASHBACK CAPTURED |
| 25 | ACCOUNT NUM CAPTURED |
| 26 | EXPIRY CAPTURED |
| 27 | CVV CAPTURED |
| 28 | ZIP CODE CAPTURED |
| 29 | CASHBACK AMOUNT CAPTURED |
| 30 | CAPTURING CASHBACK PERCENTAGE |
| 31 | CASHBACK PERCENTAGE CAPTURED |
| 32 | CAPTURING TIP |
| 33 | TIP CAPTURED |
| 34 | CAPTURING TIP AMOUNT |
| 35 | TIP AMOUNT CAPTURED |
| 36 | CAPTURING SPLIT TENDER AMOUNT |
| 37 | SPLIT TENDER AMOUNT CAPTURED |
| 38 | CAPTURING AMOUNT CONFIRMATION |
| 39 | AMOUNT CONFIRMATION CAPTURED |
| 40 | CAPTURING DCC FLAG SELECTION |
| 41 | DCC FLAG SELECTION CAPTURED |
| 42 | CAPTURING GIFT PIN |
| 43 | CAPTURED GIFT PIN |
| 44 | CAPTURING EBT TYPE |
| 45 | CAPTURED EBT TYPE |
| 46 | CAPTURING LOYALTY |
| 47 | LOYALTY CAPTURED |
| 48 | CAPTURING EMAIL |
| 49 | EMAIL CAPTURED |
| 50 | CAPTURING SIGNATURE |
| 51 | SIGNATURE CAPTURED |
| 52 | SHOWING CARD REMOVE SCREEN |
| 53 | REMOVE INSERTED CARD |
| 54 | CAPTURING CUST QUESTION |
| 55 | CUST QUESTION CAPTURED |
| 56 | CAPTURING CUST SURVEY |
| 57 | CUST SURVEY CAPTURED |
| 58 | CAPTURING CHARITY DONATION |
| 59 | CHARITY DONATION CAPTURED |
| 60 | CAPTURING CUSTOMER BUTTON |
| 61 | CUSTOMER BUTTON CAPTURED |
| 62 | SHOWING QR CODE SCREEN |
| 63 | PRESSED BUTTON ON QR SCREEN |
| 64 | CAPTURING CUSTOMER CHECKBOX |
| 65 | CUSTOMER CHECKBOX CAPTURED |
| 66 | SHOWING DISPLAY MESSAGE |
| 67 | PRESSED BUTTON ON DISPLAY MESSAGE |
| 68 | SHOWING DISPLAY IMAGE |
| 69 | PRESSED BUTTON ON DISPLAY IMAGE |
| 70 | DISPLAYING VERSION |
| 71 | VERSION DISPLAYED |
| 72 | CAPTURING PROVISION PASS |
| 73 | PROVISION PASS CAPTURED |
| 74 | CAPTURING PROMPT CONFIRMATION |
| 75 | PROMPT CONFIRMATION CAPTURED |
| 76 | CAPTURING TRURATING SURVEY |
| 77 | TRURATING SURVEY CAPTURED |
| 78 | DISPLAYING TRURATING ACK SCREEN |
| 79 | TRURATING ACK SCREEN DISPLAYED |
| 80 | CAPTURING CREDIT APP PROMPT1 |
| 81 | CAPTURING CREDIT APP PROMPT2 |
| 82 | CAPTURING CREDIT APP PROMPT3 |
| 83 | CAPTURING CREDIT APP PROMPT4 |
| 84 | CAPTURING CREDIT APP PROMPT5 |
| 85 | CAPTURING CREDIT APP PROMPT6 |
| 86 | CAPTURING CREDIT APP PROMPT7 |
| 87 | CAPTURING CREDIT APP PROMPT8 |
| 88 | CAPTURING CREDIT APP PROMPT9 |
| 89 | CAPTURING CREDIT APP PROMPT10 |
| 90 | CREDIT APP PROMPT1 CAPTURED |
| 91 | CREDIT APP PROMPT2 CAPTURED |
| 92 | CREDIT APP PROMPT3 CAPTURED |
| 93 | CREDIT APP PROMPT4 CAPTURED |
| 94 | CREDIT APP PROMPT5 CAPTURED |
| 95 | CREDIT APP PROMPT6 CAPTURED |
| 96 | CREDIT APP PROMPT7 CAPTURED |
| 97 | CREDIT APP PROMPT8 CAPTURED |
| 98 | CREDIT APP PROMPT9 CAPTURED |
| 99 | CREDIT APP PROMPT10 CAPTURED |
| 100 | CREDIT APP HOST REQUEST |
| 101 | SENDING HOST REQUEST |
| 102 | SENDING TOKEN QUERY REQUEST |
| 103 | SENDING DCC LOOK UP REQUEST |
| 104 | SENDING EMV VOID REVERSAL REQUEST |
| 105 | SENDING TOR REQUEST |
| 106 | SENDING EMV ADMIN REQUEST |
| 107 | SENDING TRURATING HOST REQUEST |
| 108 | RECEIVED HOST RESPONSE |
| 109 | CONNECTION TIME OUT |
| 110 | RESPONSE TIME OUT |
| 111 | TRYING ON PRIMARY URL |
| 112 | TRYING ON SECONDARY URL |
| 113 | HOST UNAVAILABLE |
| 114 | FRAMING HOST REQUEST |
| 115 | FRAMING HOST RESPONSE |
| 116 | STORING SAF RECORD |
| 117 | SAF RECORD STORED |
| 118 | PROCESSING SAF QUERY |
| 119 | PROCESSING SAF REMOVE |
| 120 | BAD CARD READ |
| 121 | INVALID CARD DATA |
| 122 | INVALID USER DATA |
| 123 | READING EMV CARD |
| 124 | FALLBACK OCCURRED |
| 125 | TIMEOUT ON CARD READ SCREEN |
| 126 | BUTTON SELECTED |
| 127 | BUTTON DESELECTED |
| 128 | FRAMING POS RESPONSE WITH RECEIPT |
| 129 | FRAMING POS RESPONSE WITHOUT RECEIPT |
| 130 | CUSTOMER SKIPPED THE STEP |
| 138 | PROCESSING CP_SYSTEM_NOTIFIES_TRANSACTION_STARTED TRIGGER |
| 139 | PROCESSED CP_SYSTEM_NOTIFIES_TRANSACTION_STARTED TRIGGER |
| 140 | PROCESSING CP_SYSTEM_REQUESTS_BASKET_ADJUSTMENT TRIGGER |
| 141 | PROCESSED CP_SYSTEM_REQUESTS_BASKET_ADJUSTMENT TRIGGER |
| 142 | PROCESSING CP_SYSTEM_NOTIFIES_BASKET_FINALIZED TRIGGER |
| 143 | PROCESSED CP_SYSTEM_NOTIFIES_BASKET_FINALIZED TRIGGER |
| 144 | PROCESSING CP_SYSTEM_REQUESTS_LOYALTY TRIGGER |
| 145 | PROCESSED CP_SYSTEM_REQUESTS_LOYALTY TRIGGER |
| 146 | PROCESSING CP_SYSTEM_REQUESTS_AMOUNT_ADJUSTMENT TRIGGER |
| 147 | PROCESSED CP_SYSTEM_REQUESTS_AMOUNT_ADJUSTMENT TRIGGER |
| 148 | PROCESSING CP_SYSTEM_NOTIFIES_AMOUNT_FINALIZED TRIGGER |
| 149 | PROCESSED CP_SYSTEM_NOTIFIES_AMOUNT_FINALIZED TRIGGER |
| 150 | PROCESSING CP_SYSTEM_REQUESTS_ALT_PAYMENT TRIGGER |
| 151 | PROCESSED CP_SYSTEM_REQUESTS_ALT_PAYMENT TRIGGER |
| 152 | PROCESSING CP_SYSTEM_NOTIFIES_CARD_PRESENTED TRIGGER |
| 153 | PROCESSED CP_SYSTEM_NOTIFIES_CARD_PRESENTED TRIGGER |
| 154 | PROCESSING CP_SYSTEM_NOTIFIES_CARD_BIN_RECEIVED TRIGGER |
| 155 | PROCESSED CP_SYSTEM_NOTIFIES_CARD_BIN_RECEIVED TRIGGER |
| 156 | PROCESSING CP_SYSTEM_REQUESTS_PAYMENT_AMOUNT_ADJUSTMENT TRIGGER |
| 157 | PROCESSED CP_SYSTEM_REQUESTS_PAYMENT_AMOUNT_ADJUSTMENT TRIGGER |
| 158 | PROCESSING CP_SYSTEM_NOTIFIES_AUTHORIZATION_COMPLETED TRIGGER |
| 159 | PROCESSED CP_SYSTEM_NOTIFIES_AUTHORIZATION_COMPLETED TRIGGER |
| 160 | PROCESSING CP_SYSTEM_NOTIFIES_PAYMENT_COMPLETED TRIGGER |
| 161 | PROCESSED CP_SYSTEM_NOTIFIES_PAYMENT_COMPLETED TRIGGER |
| 162 | PROCESSING CP_SYSTEM_REQUESTS_RECEIPT_MANAGEMENT TRIGGER |
| 163 | PROCESSED CP_SYSTEM_REQUESTS_RECEIPT_MANAGEMENT TRIGGER |
| 164 | PROCESSING CP_SYSTEM_NOTIFIES_TRANSACTION_ENDED TRIGGER |
| 165 | PROCESSED CP_SYSTEM_NOTIFIES_TRANSACTION_ENDED TRIGGER |
| 166 | PROCESSING CP_SYSTEM_NOTIFIES_IDLE_ENTERED TRIGGER |
| 167 | PROCESSED CP_SYSTEM_NOTIFIES_IDLE_ENTERED TRIGGER |
| 168 | PROCESSING CP_SYSTEM_NOTIFIES_MANUAL_LAUNCH_SELECTED TRIGGER |
| 169 | PROCESSED CP_SYSTEM_NOTIFIES_MANUAL_LAUNCH_SELECTED TRIGGER |
| 170 | PROCESSING CP_APP_REQUESTS_POS_INPUT |
| 171 | IN STARTUP FLOW |
| 172 | IN HOST REGISTRATION FLOW |
| 173 | HOST REGISTRATION FAILED: DEVICE LOCKED |
| 174 | IN MAC KEY DOWNLOAD |
| 175 | MAC KEY DOWNLOAD FAILED |
| 176 | IN CAPK UPDATE |
| 177 | CAPK UPDATE FAILED |
| 178 | IN EMV CONFIGURATION |
| 179 | IN ENCRYPTION REGISTRATION |
| 180 | ENCRYPTION REGISTRATION FAILED: DEVICE LOCKED |
| 181 | IN BIN UPDATE |
| 182 | BIN UPDATE FAILED |
| 183 | IN TEST SALE. NOTE: This will be set before test sale. However, as part of the test sale flow, the detailed status can get updated, as like as in a regular sale. |
| 184 | TEST SALE FAILED: DEVICE LOCKED |
| 185 | IN PROPERTIES DB HEALTHCHECK |
| 186 | PROPERTIES DB HEALTHCHECK FAILED: REBOOTING |
| 187 | PROPERTIES DB HEALTHCHECK FAILED: DEVICE LOCKED |
| 188 | IN VERIFONE DB HEALTHCHECK |
| 189 | VERIFONE DB HEALTHCHECK FAILED: DEVICE LOCKED |
| 190 | IN BLUETOOTH UNPAIR CONFIRMATION SCREEN |
Rate this article:
