Guides
Log In
Guides

Arrêt

Vue d'ensemble

La commande shutdown (arrêt) vous permet d’éteindre le terminal. Cela peut être utile si le terminal ne répond plus. Si vous souhaitez forcer un arrêt, définissez la valeur force (forcer) à "true" (valeur booléenne vraie). Cela redémarrera le terminal, que celui-ci traite actuellement une transaction ou soit non réactif.

Remarque: Une fois éteint, le terminal doit être rallumé manuellement. Si un arrêt forcé est déclenché, le terminal s’éteindra immédiatement, même s’il est au milieu d’une transaction.

Remarque: Cette commande ne s’applique pas aux appareils connectés à une source d’alimentation, tels que les appareils IM30 et A35.


Structure de la requête

ÉlémentTypeDescriptionTailleObligatoire
apiVersionString (chaîne)Numéro de version de l'APIV20Obligatoire
istConfigCodeString (chaîne)Code de configuration d'intégration fourni par MonerisV50Obligatoire
dataIdString (chaîne)Identifiant unique défini par le commerçant pour l'objet de donnéesV50Obligatoire
dataTimestampString (chaîne)Date et heure de la requête (AAAA-MM-JJ HH:MM:SS)F19Obligatoire
dataObject (objet)Objet contenant toutes les requêtes de transaction
requestArray (tableau)Contient les données applicables à la requête de transaction
terminalIdString (chaîne)ID du terminal de destinationF8Facultatif
actionString (chaîne)"shutdown"V50Obligatoire
forceString (chaîne)Si la valeur est définie sur "true", le terminal effectuera un arrêt forcé.
Avertissement : L'arrêt forcé éteindra le terminal quel que soit son état actuel. Par conséquent, si le terminal est au milieu d'une transaction et qu'une commande d'arrêt forcé est émise, le terminal s'éteindra en plein milieu de la transaction.
V4Facultatif

Exemple de requête

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

Structure de la réponse

ÉlémentTypeDescriptionTailleObligatoire
apiVersionString (chaîne)Numéro de version de l'APIV20Obligatoire
statusCodeString (chaîne)Code d'état pour la requête de transaction globaleV4Obligatoire
statusString (chaîne)Description du code d'étatV50Obligatoire
dataIdString (chaîne)Identifiant unique défini par le commerçant pour l'objet de donnéesV50Obligatoire
dataTimestampString (chaîne)Date et heure de la requête (AAAA-MM-JJ HH:MM:SS)F19Obligatoire
dataObject (objet)Objet contenant toutes les requêtes de transaction
responseArray (tableau)Contient les données applicables à la requête de transaction
actionString (chaîne)"shutdown"V50Obligatoire
statusCodeString (chaîne)Code d'état pour la requête individuelleV4Obligatoire
statusString (chaîne)Description du code d'état individuelV50Obligatoire
completedString (chaîne)"true" ou "false"V5Obligatoire
terminalIdString (chaîne)ID du terminal de destinationF8Facultatif

Exemple de réponse

{
  "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"
      }
    ]
  }
}

Erreurs

Si votre réponse contient des erreurs, consultez la page Erreurs pour une description détaillée de chacune.