Get Tables Command

Overview

The getTables command returns a list of open tables assigned to the server.

Request Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
terminalId	String	Terminal ID request originated from	V8	Required
merchantId	String	Merchant ID of requestor	V13	Required
apiVersion	String	API version number	V20	Required
requestId	String	A unique identifier for this request	V50	Required
requestTimestamp	String	Date and time of the request	F19	Required
action	String	Transaction type – “getTables”	V24	Conditional
data	Object	Data applicable to this transaction type	–	–
server	Object	–	–	–
serverId	String	Server ID entered on the terminal	V50	Optional
trackData	Object	–	–	–
Track1	String	Track 1 from server card swiped	V50	Optional
Track2	String	Track 2 from server card swiped	V50	Optional
Track3	String	Track 3 from server card swiped	V50	Optional
error	Object	Present if the terminal detects an error in the previous response. Applicable to all actions.	–	–
status	String	Status code	F3	Conditional
statusDesc	String	Description for status code	V50	Conditional
session	String	Session ID from Moneris cloud	V50	Conditional


{
   "terminalId": "I9000001",
   "merchantId": "0030112345678",
   "apiVersion": "1.0",
   "requestId": "I9000001-1555449670-037",
   "requestTimestamp": "2020-01-01 09:00:00",
   "action": "getTables",
   "data": {
      "server": {
         "serverId": "1234",
         "trackData": {
            "track1": "",
            "track2": "",
            "track3": ""
         }
      }
   },
   "error": {
      "status": "703",
      "statusDesc": "Table Number Error"
   },
   "session": "c9e5558c-3dfb-4359-adcf-c3c3de0d269d"
}

Response Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
terminalId	String	Terminal ID request originated from	V8	Required
merchantId	String	Merchant ID of requestor	V13	Required
configCode	String	Integration configuration code provided by Moneris	V25	Required
requestId	String	A unique identifier for this request	V50	Required
requestTimestamp	String	Date and time of the request	F19	Required
status	String	RMS status code	F3	Required
statusDesc	String	RMS status code description	V50	Required
data	Object	Data applicable to this transaction type	–	–
tables	Array	An array of table objects	–	–
tableId	String	Primary key, used in subsequent requests to address particular table	V50	Required
tableName	String	Table name for display in terminal user interface	V50	Required
tableTotalAmount	Number	Total amount due for the table (in cents)	V9	Required
tableRemainingAmount	Number	Amount due, partial authorisation (in cents)	V9	Required
session	String	Session ID from Moneris cloud	V50	Conditional


{
   "terminalId": "I9000001",
   "merchantId": "0030112345678",
   "configCode": "C12345678SI",
   "requestId": "I9000001-1555449670-037",
   "responseTimestamp": "2020-01-01 09:00:00",
   "status": "600",
   "statusDesc": "Internal Error",
   "data": {
      "tables": [
         {
            "tableId": "5cbb687bb376894ed03662db",
            "tableName": "DiningRoom1",
            "tableTotalAmount": 12300,
            "tableRemainingAmount": 12300
         },
         {
            "tableId": "5cbb687bb376894ed03662dc",
            "tableName": "0002",
            "tableTotalAmount": 15000,
            "tableRemainingAmount": 15000
         },
         {
            "tableId": "5cbb687bb376894ed03662ec",
            "tableName": "7",
            "tableTotalAmount": 20000,
            "tableRemainingAmount": 19000
         }
      ]
   },
   "session": "c9e5558c-3dfb-4359-adcf-c3c3de0d269d"
}