Guides
Log In
Guides

Reboot

Overview

The reboot command allows you to restart the terminal. This can be useful if the terminal seems to be running slow or if it has stopped responded. If you want to force a reboot, set the "force" value to "true". This will restart the terminal regardless of whether it is currently processing a transaction or unresponsive.


📘

NOTE

This is only available for the Direct and App-to-app Integration methods and not for Cloud.


List of coding scenarios that use this endpoint:

  1. Reboot Command

Request Structure

ElementTypeDescriptionSizeRequired
apiVersionStringAPI version numberV20Required
istConfigCodeStringMoneris provided integration configuration codeV50Required
dataIdStringMerchant defined unique identifier for the data objectV50Required
dataTimestampStringDate and time of the request (YYYY-MM-DD HH:MM:SS)F19Required
dataObjectObject that contains all transaction requests
requestArrayContains data applicable to transaction request
terminalIdStringDestination Terminal IDF8Optional
actionString"cancel"V50Required
forceStringIf value is set to "true", terminal will perform a forced reboot. Warning: Forced reboot will restart the terminal regardless of its current state. Therefore, if the terminal is in the middle of a transaction and a forced reboot command is issued, the terminal will reboot mid transaction.V4Optional

Request example

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

Response Structure

ElementTypeDescriptionSizeRequired
apiVersionStringAPI version numberV20Required
statusCodeStringStatus code for the overall transaction requestV4Required
statusStringDescription of the statusCodeV50Required
dataIdStringMerchant defined unique identifier for the data objectV50Required
dataTimestampStringDate and time of the request (YYYY-MM-DD HH:MM:SS)F19Required
dataObjectObject that contains all transaction requests
responseArrayContains data applicable to transaction request
actionString"cancel"V50Required
statusCodeStringStatus code for individual requestV4Required
statusStringDescription of the individual statusCodeV50Required
completedString"true" or "false"V5Required
terminalIdStringDestination Terminal IDF8Optional

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": "reboot"
      }
    ]
  }
}

Errors

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