Authenticate Command

Overview

When the RMS establishes an outbound socket, it sends an authentication handshake message that includes the merchantId and apiToken. Moneris provides a Merchant ID and API Token for each merchant solution. A handshake is required each time a socket is established. The handshake pairs the terminal with the RMS and authenticates it. Transaction processing can proceed after a successful handshake.

NOTE: Each restaurant POS connection to the Moneris RMS must use a unique merchantId.

Request Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
action	String	Transaction type - “authenticate”	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": "authenticate",
   "apiToken": "P14i5WS4P0uhgbrnN7BZ",
   "cloudApiVersion": "1.0",
   "merchantId": "1234567890",
   "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": "authenticate",
   "cloudApiVersion": "1.0",
   "merchantId": "0030112345678",
   "requesId": "I9000001-1555449670-037",
   "responseTimestamp": "yyyy-mm-dd hh:mm:ss",
   "status": "200",
   "statusDesc": "OK"
}