Echo Command

Overview

Once the restaurant system has successfully performed an authentication handshake, it must send an echo request message to the RMS every 30 seconds to keep the connection alive. If the RMS fails to receive the echo command, the connection will be dropped. The Moneris RMS allows only one connection per merchant ID. Additional server connection attempts using an active merchant ID will be rejected.

Request Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
action	String	Transaction type - “echo”	V24	Required
apiToken	String	API Token of requestor	V50	Required
cloudApiVersion	String	API version number	V20	Required
merchantId	String	Merchant ID of requestor	V13	Required
requestId	String	Request identifier	V50	Required
requestTimestamp	String	Date and time of the request	F19	Required


{
   "action": "echo",
   "apiToken": "P14i5WS4P0uhgbrnN7BZ",
   "cloudApiVersion": "1.0",
   "merchantId": "0030112345678",
   "requestId": "I9000001-1555449670-037",
   "requestTimestamp": "yyyy-mm-dd hh:mm:ss"
}

Response Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
action	String	Transaction type - “authenticate”	V24	Required
cloudApiVersion	String	API version number	V20	Required
merchantId	String	Merchant ID of requestor	V13	Required
requestId	String	Request identifier	V50	Required
responseTimestamp	String	Date and time of the request	F19	Required
status	String	Status code	F3	Conditional
statusDesc	String	Status code description	V50	Conditional


{
   "action": "echo",
   "cloudApiVersion": "1.0",
   "merchantId": "0030112345678",
   "requestId": "I9000001-1555449670-037",
   "responseTimestamp": "yyyy-mm-dd hh:mm:ss",
   "status": "200",
   "statusDesc": "OK"
}