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é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 | - | - |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter une requête en double | V50 | Obligatoire |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Facultatif |
| action | String (chaîne) | "displayMessage" | V50 | Obligatoire |
| displayMessage | String (chaîne) | Message à afficher | V512 | Obligatoire |
| timeout | String (chaîne) | Permet d'afficher le message pendant une période déterminée | V2 | Facultatif |
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"
}
]
}
}| É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 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 | - | - |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter une requête en double | V50 | Obligatoire |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Obligatoire |
| action | String (chaîne) | "displayMessage" | V50 | Obligatoire |
| displayMessage | String (chaîne) | Message à afficher | V512 | Obligatoire |
| timeout | String (chaîne) | Permet d'afficher le message pendant une période déterminée | V2 | 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": [
{
"idempotencyKey": "example_idempotencyKey",
"terminalId": "example_terminalId",
"action": "displayMessage",
"displayMessage": "example message",
"timeout": "10"
}
]
}
}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 | - | - |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter une requête en double | V50 | Obligatoire |
| action | String (chaîne) | "displayMessage" | 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 |
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"
}
]
}
}| É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) | "displayMessage" | 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 | Obligatoire |
| cloudTicket | String (chaîne) | Ceci est l'ID de référence unique de la requête cloud | V100 | Obligatoire |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter une requête en double | V50 | 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": [
{
"idempotencyKey": "example_idempotencyKey",
"terminalId": "example_terminalId",
"cloudTicket": "example_cloudTicket",
"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.
Mise à jour il y a 3 jours
Cette page vous a-t-elle aidé ?