Shutdown

Overview

The Shutdown Command is used to remotely power down a Moneris Go payment terminal from an integrated POS system. This command is typically used for maintenance, security or end-of-day procedures.

Note: Once shut down, the terminal must be manually powered back on. If a forced shutdown is issued, the terminal will shut down immediately, even if it is in the middle of a transaction.

Note: This command is not applicable for devices that are connected to a power supply, such as the IM30 and A35 devices.

Request Structure

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
istConfigCode	String	Moneris provided integration configuration code	V50	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
request	Array	Contains data applicable to transaction request	—	—
terminalId	String	Destination Terminal ID	F8	Optional
action	String	"shutdown"	V50	Required
force	String	If value is set to "true", terminal will perform a forced shutdown. Warning: Forced shutdown will shutdown the terminal regardless of its current state. Therefore, if the terminal is in the middle of a transaction and a forced shutdown command is issued, the terminal will shutdown mid transaction.	V4	Optional

Request example

{
  "apiVersion": "3.0",
  "istConfigCode": "example_istConfigCode",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "request": [
      {
        "terminalId": "example_terminalId",
        "action": "shutdown"
      }
    ]
  }
}

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
apiToken	String	Moneris assigned identifier	V50	Required
storeId	String	Store ID of requestor	V50	Required
istConfigCode	String	Moneris provided integration configuration code	V50	Required
postBackUrl	String	This field is required for postback and combined integration	V2000	Conditional
polling	String	This field is required for combined integration	V5	Conditional
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
request	Array	Contains data applicable to transaction request	—	—
terminalId	String	Destination Terminal ID	F8	Optional
action	String	"shutdown"	V50	Required
force	String	If value is set to "true", terminal will perform a forced shutdown. Warning: Forced shutdown will shutdown the terminal regardless of its current state. Therefore, if the terminal is in the middle of a transaction and a forced shutdown command is issued, the terminal will shutdown mid transaction.	V4	Optional

Request example

{
  "apiVersion": "3.0",
  "apiToken": "example_apiToken",
  "storeId": "example_storeId",
  "istConfigCode": "example_istConfigCode",
  "polling": "true",
  "postBackUrl": "https://example.client.url",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "request": [
      {
        "terminalId": "example_terminalId",
        "action": "shutdown"
      }
    ]
  }
}

Response Structure

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
statusCode	String	Status code for the overall transaction request	V4	Required
status	String	Description of the statusCode	V50	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
response	Array	Contains data applicable to transaction request	—	—
action	String	"shutdown"	V50	Required
statusCode	String	Status code for individual request	V4	Required
status	String	Description of the individual statusCode	V50	Required
completed	String	"true" or "false"	V5	Required
terminalId	String	Destination Terminal ID	F8	Optional

Response example

{
  "apiVersion": "3.0",
  "statusCode": "example_statusCode",
  "status": "example_status",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "response": [
      {
        "statusCode": "example_statusCode",
        "status": "example_status",
        "completed": "true",
        "action": "shutdown"
      }
    ]
  }
}

Element	Type	Description	Size	Required
receipt	Object	Contains the response data message	—	—
apiVersion	String	API version number	V20	Required
statusCode	String	Status code for the overall transaction request	V4	Required
status	String	Description of the statusCode	V50	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
response	Array	Contains data applicable to transaction request	—	—
action	String	"shutdown"	V50	Required
statusCode	String	Status code for individual request	V4	Required
status	String	Description of the individual statusCode	V50	Required
completed	String	"true" or "false"	V5	Required
cloudTicket	String	This is the unique reference id of the cloud request	V100	Required
terminalId	String	Destination Terminal ID	F8	Required

Response example

{
  "receipt": {
    "apiVersion": "3.0",
    "statusCode": "example_statusCode",
    "status": "example_status",
    "dataId": "example_dataId",
    "dataTimestamp": "1969-12-31 23:59:59",
    "data": {
      "response": [
        {
          "terminalId": "example_terminalId",
          "statusCode": "example_statusCode",
          "status": "example_status",
          "cloudTicket": "example_cloudTicket",
          "completed": "true",
          "action": "shutdown"
        }
      ]
    }
  }
}

Errors

If your response contains errors, visit the Errors page for a detailed description of each one.

Updated 8 days ago

Did this page help you?