Guides
Log In
Guides

Afficher un message

Vue d'ensemble

La commande d’affichage de message est utilisée pour présenter un message en texte brut sur l’écran d’un terminal Moneris Go destiné au titulaire de carte ou à l’utilisateur final. Cette fonctionnalité est généralement utilisée pour fournir des instructions, des confirmations ou d’autres informations contextuelles pendant le flux de transaction.

Une fois affiché, le message reste visible sur le terminal jusqu’à ce que l’un des événements suivants se produise :

  • Une nouvelle commande est envoyée par le système PDV, ou
  • La période d’expiration spécifiée arrive à échéance, ou
  • La session PDV expire.

Cette commande est particulièrement utile pour guider les clients dans des flux de travail personnalisés, les avertir d’états d’attente ou les rassurer pendant les délais de traitement plus longs.


📘

Remarque

Le contenu du message est défini par le système PDV et peut être personnalisé pour s’adapter au flux opérationnel du marchand ou à sa stratégie d’expérience client.


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
idempotencyKeyString (chaîne)Identifiant unique de transaction pour éviter une requête en doubleV50Obligatoire
terminalIdString (chaîne)ID du terminal de destinationF8Facultatif
actionString (chaîne)"displayMessage"V50Obligatoire
displayMessageString (chaîne)Message à afficherV512Obligatoire
timeoutString (chaîne)Permet d'afficher le message pendant une période déterminéeV2Facultatif

Exemple de requête

{
  "apiVersion": "3.0",
  "istConfigCode": "example_istConfigCode",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "request": [
      {
        "idempotencyKey": "example_idempotencyKey",
        "action": "displayMessage",
        "displayMessage": "example message",
        "timeout": "10"
      }
    ]
  }
}

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
idempotencyKeyString (chaîne)Identifiant unique de transaction pour éviter une requête en doubleV50Obligatoire
actionString (chaîne)"displayMessage"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

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": [
      {
        "idempotencyKey": "example_idempotencyKey",
        "statusCode": "example_statusCode",
        "status": "example_status",
        "completed": "true",
        "action": "displayMessage"
      }
    ]
  }
}

Erreurs

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