Numériser
Vue d'ensemble
La commande Scan (numérisation) est utilisée pour initier une transaction de lecture de code-barres entre une caisse enregistreuse électronique (ECR/PDV) et un terminal Moneris. Cette commande permet à l’ECR de demander au terminal de numériser un ou plusieurs codes-barres et de renvoyer les données numérisées dans une réponse structurée.
Remarque
Pour les transactions idempotentes, seul le dernier élément numérisé est renvoyé en raison des limites de stockage.
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 les requêtes en double | V50 | Obligatoire |
| linkId | String (chaîne) | ID utilisé pour regrouper les transactions liées | V50 | Facultatif |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Facultatif |
| userName | String (chaîne) | Identifiant unique pour le caissier / l'utilisateur | V30 | Facultatif |
| customIdData | String (chaîne) | Champ personnalisé | V50 | Facultatif |
| action | String (chaîne) | "scan" | V50 | Obligatoire |
| progressStatus | String (chaîne) | Si la valeur est définie sur "True" (vrai), le terminal renverra la progression à le PDV. Remarque : Cette fonctionnalité est uniquement disponible en intégration directe. |
V5 | Facultatif |
| barcodeType | String (chaîne) | Liste des formats de codes-barres pris en charge à scanner | V50 | 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": "scan"
}
]
}
}| É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 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 les requêtes en double | V50 | Obligatoire |
| linkId | String (chaîne) | ID utilisé pour regrouper les transactions liées | V50 | Facultatif |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Obligatoire |
| userName | String (chaîne) | Identifiant unique pour le caissier / l'utilisateur | V30 | Facultatif |
| customIdData | String (chaîne) | Champ personnalisé | V50 | Facultatif |
| action | String (chaîne) | "scan" | V50 | Obligatoire |
| barcodeType | String (chaîne) | Liste des formats de codes-barres pris en charge à scanner | V50 | 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": "scan"
}
]
}
}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 statusCode | 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 les requêtes en double | V50 | Obligatoire |
| linkId | String (chaîne) | ID utilisé pour regrouper les transactions liées | V50 | Facultatif |
| action | String (chaîne) | "scan" | V50 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour la requête individuelle | V4 | Obligatoire |
| status | String (chaîne) | Description du statusCode individuel | V50 | Obligatoire |
| completed | String (chaîne) | "true" ou "false" | V5 | Obligatoire |
| barcode | Array (tableau) | - | - | - |
| data | String (chaîne) | Données scannées du code-barres | V200 | Conditionnel |
| format | String (chaîne) | Liste des formats de codes-barres pris en charge à scanner | V50 | Facultatif |
| sessionCounter | String (chaîne) | Suivi de la séquence dans laquelle le code-barres a été scanné | V3 | 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": "scan",
"barcode": [
{
"data": "example_barcode_data",
"format": "example_barcode_format",
"sessionCounter": "example_sessionCounter"
},
{
"data": "example_barcode_data",
"format": "example_barcode_format",
"sessionCounter": "example_sessionCounter"
}
]
}
]
}
}| É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 statusCode | 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 les requêtes en double | V50 | Obligatoire |
| linkId | String (chaîne) | ID utilisé pour regrouper les transactions liées | V50 | Facultatif |
| action | String (chaîne) | "scan" | V50 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour la requête individuelle | V4 | Obligatoire |
| status | String (chaîne) | Description du statusCode individuel | V50 | Obligatoire |
| completed | String (chaîne) | "true" ou "false" | V5 | Obligatoire |
| cloudTicket | String (chaîne) | Identifiant de référence unique de la requête cloud | V100 | Obligatoire |
| barcode | Array (tableau) | - | - | - |
| data | String (chaîne) | Données scannées du code-barres | V200 | Conditionnel |
| format | String (chaîne) | Liste des formats de codes-barres pris en charge à scanner | V50 | Facultatif |
| sessionCounter | String (chaîne) | Suivi de la séquence dans laquelle le code-barres a été scanné | V3 | 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": [
{
"cloudTicket": "example_cloudTicket",
"idempotencyKey": "example_idempotencyKey",
"statusCode": "example_statusCode",
"status": "example_status",
"completed": "true",
"action": "scan",
"barcode": [
{
"data": "example_barcode_data",
"format": "example_barcode_format",
"sessionCounter": "example_sessionCounter"
},
{
"data": "example_barcode_data",
"format": "example_barcode_format",
"sessionCounter": "example_sessionCounter"
}
]
}
]
}
}
}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é ?