Guides
Log In
Guides

Imprimer

Vue d'ensemble

La commande print (imprimer) vous permet de créer un reçu personnalisé pouvant être imprimé sur les terminaux disposant d’une imprimante intégrée. Le champ printData (données à imprimer) dans le corps de la requête contient les données à imprimer. Le printData doit être encodé en ISO-8859-1.

Le printData peut être mis en forme à l’aide de caractères de contrôle. Les caractères de contrôle doivent précéder les chaînes de données. Ils restent actifs jusqu’à ce qu’un autre caractère de contrôle ou un saut de ligne (“\n”) soit rencontré.


Voici une liste des caractères de contrôle pris en charge :

  • \1 - Petite police
  • \3 - Grande police, à utiliser pour les en-têtes de section comme “Résumé quotidien”, “Détails par type de carte” ou les titres de carte comme “Visa”, “Débit”, etc.
  • \B - Gras
  • \I - Inversé
  • \L - Alignement à gauche
  • \C - Centré
  • \R - Alignement à droite
  • \n - nouvelle ligne

Exemple de chaîne :


"\3\CCard Details\n" //centré, police grande 
"----------------------------------\n" //ligne de séparation pleine largeur  
"\LTransaction\RCount\RVolume\n" + //trois colonnes 
"----------------------------------\n" 
"\LPurchase\R150\R$123.45\n" + 
"\LRefund\R1\R$ 1.23\n" + 
"\LCorrections\R30\R$1.23\n" 

Liste des scénarios de codage qui utilisent cet endpoint (le point de terminaison) :

  1. Commande d’impression

Structure de la requête

ÉlémentTypeDescriptionTailleObligatoire
apiVersionString (chaîne)Numéro de version de l'API.V20Obligatoire
istConfigCodeString (chaîne)Code de configuration d'intégration fourni par Moneris.V50Obligatoire
dataIdString (chaîne)Identifiant unique défini par le commerçant pour l'objet de données.V50Obligatoire
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 double.V50Obligatoire
terminalIdString (chaîne)ID du terminal de destination.F8Optionnel
actionString (chaîne)« print ».V50Obligatoire
printDataString (chaîne)Données à imprimer par le terminal.
Remarque : Les données doivent être encodées en ISO-8895-1.
V10000Obligatoire
progressStatusString (chaîne)Si la valeur est définie sur « True », le terminal renverra la progression vers le PDV.
Remarque : Cette fonctionnalité est uniquement disponible en intégration directe.
V5Optionnel
addHeaderString (chaîne)« true » ou « false » (Par défaut : false).V5Optionnel
addFooterString (chaîne)« true » ou « false » (Par défaut : false).V5Optionnel

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": "print",
        "printData": "example_printData"
      }
    ]
  }
}

Structure de la réponse

ÉlémentTypeDescriptionTailleObligatoire
apiVersionString (chaîne)Numéro de version de l'API.V20Obligatoire
statusCodeString (chaîne)Code d'état pour la requête de transaction globale.V4Obligatoire
statusString (chaîne)Description du code d'état (statusCode).V50Obligatoire
dataIdString (chaîne)Identifiant unique défini par le commerçant pour l'objet de données.V50Obligatoire
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 double.V50Obligatoire
actionString (chaîne)« print ».V50Obligatoire
statusCodeString (chaîne)Code d'état pour la requête individuelle.V4Obligatoire
statusString (chaîne)Description du code d'état (statusCode) individuel.V50Obligatoire
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":"print"
     }
  ]
}
}

Erreurs

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