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ément | Type | Description | Taille | Obligatoire |
|---|---|---|---|---|
| apiVersion | String (chaîne) | Numéro de version de l'API | V20 | Obligatoire |
| istConfigCode | String (chaîne) | Code de configuration d'intégration fourni par Moneris | V50 | Obligatoire |
| dataId | String (chaîne) | Identifiant unique défini par le commerçant pour l'objet de données | V50 | Obligatoire |
| dataTimestamp | String (chaîne) | Date et heure de la requête (AAAA-MM-JJ HH:MM:SS) | F19 | Obligatoire |
| data | Object (objet) | Objet contenant toutes les requêtes de transaction | - | - |
| request | Array (tableau) | Contient les données applicables à la requête de transaction | - | - |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Facultatif |
| action | String (chaîne) | "shutdown" | V50 | Obligatoire |
| force | String (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. |
V4 | Facultatif |
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"
}
]
}
}| Élément | Type | Description | Taille | Obligatoire |
|---|---|---|---|---|
| apiVersion | String (chaîne) | Numéro de version de l'API | V20 | Obligatoire |
| apiToken | String (chaîne) | Identifiant attribué par Moneris | V50 | Obligatoire |
| storeId | String (chaîne) | ID du magasin du demandeur | V50 | Obligatoire |
| istConfigCode | String (chaîne) | Code de configuration d'intégration fourni par Moneris | V50 | Obligatoire |
| postBackUrl | String (chaîne) | Ce champ est requis pour l'intégration avec postback et l'intégration combinée | V2000 | Conditionnel |
| polling | String (chaîne) | Ce champ est requis pour l'intégration combinée | V5 | Conditionnel |
| dataId | String (chaîne) | Identifiant unique défini par le commerçant pour l'objet de données | V50 | Obligatoire |
| dataTimestamp | String (chaîne) | Date et heure de la requête (AAAA-MM-JJ HH:MM:SS) | F19 | Obligatoire |
| data | Object (objet) | Objet contenant toutes les requêtes de transaction | - | - |
| request | Array (tableau) | Contient les données applicables à la requête de transaction | - | - |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Facultatif |
| action | String (chaîne) | "shutdown" | V50 | Obligatoire |
| force | String (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. |
V4 | Facultatif |
Exemple de requête
{
"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"
}
]
}
}Structure de la réponse
| Élément | Type | Description | Taille | Obligatoire |
|---|---|---|---|---|
| apiVersion | String (chaîne) | Numéro de version de l'API | V20 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour la requête de transaction globale | V4 | Obligatoire |
| status | String (chaîne) | Description du code d'état | V50 | Obligatoire |
| dataId | String (chaîne) | Identifiant unique défini par le commerçant pour l'objet de données | V50 | Obligatoire |
| dataTimestamp | String (chaîne) | Date et heure de la requête (AAAA-MM-JJ HH:MM:SS) | F19 | Obligatoire |
| data | Object (objet) | Objet contenant toutes les requêtes de transaction | - | - |
| response | Array (tableau) | Contient les données applicables à la requête de transaction | - | - |
| action | String (chaîne) | "shutdown" | V50 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour la requête individuelle | V4 | Obligatoire |
| status | String (chaîne) | Description du code d'état individuel | V50 | Obligatoire |
| completed | String (chaîne) | "true" ou "false" | V5 | Obligatoire |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Facultatif |
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"
}
]
}
}| Élément | Type | Description | Taille | Obligatoire |
|---|---|---|---|---|
| receipt | Object (objet) | Contient le message de données de la réponse | - | - |
| apiVersion | String (chaîne) | Numéro de version de l'API | V20 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour la requête de transaction globale | V4 | Obligatoire |
| status | String (chaîne) | Description du code d'état | V50 | Obligatoire |
| dataId | String (chaîne) | Identifiant unique défini par le commerçant pour l'objet de données | V50 | Obligatoire |
| dataTimestamp | String (chaîne) | Date et heure de la requête (AAAA-MM-JJ HH:MM:SS) | F19 | Obligatoire |
| data | Object (objet) | Objet contenant toutes les requêtes de transaction | - | - |
| response | Array (tableau) | Contient les données applicables à la requête de transaction | - | - |
| action | String (chaîne) | "shutdown" | V50 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour la requête individuelle | V4 | Obligatoire |
| status | String (chaîne) | Description du code d'état individuel | V50 | Obligatoire |
| completed | String (chaîne) | "true" ou "false" | V5 | Obligatoire |
| cloudTicket | String (chaîne) | Ceci est l'ID de référence unique de la requête cloud | V100 | Obligatoire |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Obligatoire |
Exemple de réponse
{
"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"
}
]
}
}
}Erreurs
Si votre réponse contient des erreurs, consultez la page Erreurs pour une description détaillée de chacune.
Mise à jour il y a 3 jours
Cette page vous a-t-elle aidé ?