Synchroniser
Vue d'ensemble
La commande sync (synchronisation) vous permet d’extraire les derniers paramètres du terminal, garantissant que votre appareil dispose de la configuration la plus à jour.Les paramètres incluent, sans s’y limiter, les cartes acceptées, les paramètres de remise en argent et les paramètres de reçu.
Le champ syncModifier (Modificateur de synchronisation) dans l’objet de requête détermine le type de synchronisation effectué.
- Sync All (synchroniser tout) : Ce modificateur télécharge la configuration du terminal à partir des hôtes de crédit (crédit), débit (débit) et cadeau (cadeau), ainsi que du système de gestion des terminaux.Il est généralement utilisé lorsqu’un appareil est neuf. Par défaut, si aucun autre modificateur n’est défini, cette option est utilisée.
- Sync TMS (synchroniser avec TMS) : Ce modificateur télécharge les paramètres du terminal, tels que les pourboires, les remises en argent et les frais supplémentaires, depuis le système de gestion des terminaux Moneris (TMS).
- Sync Host (synchroniser avec les hôtes) : Ce modificateur télécharge la configuration du terminal à partir des hôtes de crédit (crédit), débit (débit) et cadeau (cadeau). Il est couramment utilisé pour appliquer des frais aux plans de cartes, des limites de transaction et d’autres mises à jour similaires.
REMARQUE
Pour que votre appareil Moneris Go soit conforme à la norme PCI, il est réinitialisé quotidiennement, ce qui entraîne une synchronisation automatique avec le système de gestion des terminaux Moneris.
Liste des scénarios de codage qui utilisent cet endpoint (le point de terminaison) :
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 | V25 | 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 |
| merchantId | String (chaîne) | ID du commerçant effectuant la requête | V13 | Obligatoire |
| terminalId | String (chaîne) | ID du terminal de destination. Remarque : Une erreur sera renvoyée si terminalId dans la requête ne correspond pas à celui du terminal. | F8 | Facultatif |
| progressStatus | String (chaîne) | Si la valeur est définie sur « True », le terminal retournera la progression à le PDV. Remarque : Cette fonctionnalité est disponible uniquement avec l'intégration directe. | V5 | Facultatif |
| syncModifier | String (chaîne) | Identifie avec quel hôte synchroniser | V24 | Facultatif |
| action | String (chaîne) | « sync » (synchroniser) | V50 | Obligatoire |
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",
"merchantId": "example_merchantId",
"terminalId": "example_terminalId",
"action": "sync"
}
]
}
}| É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 de l'expéditeur de la requête | 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 | - | - |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter une requête en double | V50 | Obligatoire |
| action | String (chaîne) | « cancel » (annuler) | V50 | Obligatoire |
| merchantId | String (chaîne) | ID du commerçant effectuant la requête | F13 | Facultatif |
| terminalId | String (chaîne) | ID du terminal de destination. Remarque : Une erreur sera renvoyée si terminalId dans la requête ne correspond pas à celui du terminal. | F8 | Obligatoire |
| syncModifier | String (chaîne) | Identifie avec quel hôte synchroniser | V24 | 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",
"merchantId": "example_merchantId",
"terminalId": "example_terminalId",
"action": "sync"
}
]
}
}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 l'ensemble de la requête de transaction | V4 | Obligatoire |
| status | String (chaîne) | Description du code d'état (statusCode) | V4 | 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) | « cancel » (annuler) | 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 (statusCode) individuel | V50 | Obligatoire |
| settings | Object (objet) | Renvoie les paramètres TMS et de l'hôte | - | - |
| completed | String (chaîne) | « true » (valeur booléenne vraie) ou « false » (valeur booléenne fausse) | 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": "sync",
"settings": {
"tms": {
"parameters": {
"applicationSettings": {
"goDevice": true,
"receipt": {
"customerReceiptPrompt": {
"emailReceipt": true,
"noReceipt": true,
"printReceipt": true,
"receiptPrompt": true,
"smsReceipt": true
},
"footerCustomerCopy": [
"testö",
"testgbj.",
" chycb. hj"
],
"headerCustomerCopy": [
"ËlïOÔoïö"
],
"numberOfMerchantCopies": "0",
"printDelay": "1",
"printQRCode": true
},
"security": {
"autoSignout": false,
"signoutTime": "40"
},
"semiIntegrated": {
"commType": "IP",
"enable": true,
"port": "",
"printingOnEcr": true
},
"tip": {
"byAmount": false,
"byPercent": true,
"enableTip": false,
"onSubtotal": false,
"preset1": "10",
"preset2": "0",
"preset3": "20",
"presetByAmount": false,
"warningThreshold": "100"
},
"TMS": {
"TMSConnectInterval": "720",
"TMSConnectTime": "07:23",
"TMSHost": "tmsct.moneris.com",
"TMSPort": "1124"
},
"transactionSettings": {
"cashBack": {
"amount1": "0",
"amount2": "10",
"amount3": "05",
"customValueAllowed": true,
"enableCashBack": true,
"Interac": true,
"InteracLimit": "100",
"limit": "100",
"Mastercard": true,
"MastercardLimit": "100",
"Visa": true,
"VisaLimit": "100"
},
"completion": {
"limitMultiplier": "4",
"limitThreshold": "1500"
},
"MonerisGiftAndLoyaltyApp": {
"enableGiftAndLoyalty": true,
"giftandLoyaltyID": "163467",
"routingCode": "79"
},
"MOTO": true,
"passTerminalTimer": "2",
"surcharge": {
"enableSurcharge": false,
"surchargeAmount": "50"
},
"transactionIdLabel": "Custom",
"transactionIdPrompt": true
}
},
"general": {
"initialized": true,
"PCIRebootTime": "03:00"
},
"merchant": {
"merchantAddress": "1180 BOULEVARD SACR COEU",
"merchantCity": "SAINT-FLICIE",
"merchantName": "MONERIS GO DEV TEAM",
"merchantPhone": "4169557091",
"merchantPostalCode": "M5J 0B8",
"merchantProvince": "ON"
},
"reports": {
"reportResetTime": "23:00"
}
}
},
"host": {
"card": {
"Ctls": true,
"Cards": {
"P": "INTERAC",
"V": "VISA",
"M": "MASTERCARD",
"AX": "AMEX",
"C1": "JCB",
"UP": "UNIONPAY",
"NO": "DISCOVER",
"DC": "DINERS"
}
},
"term": {
"MerchantID": "0030128914802",
"MerchantName": "MONERIS GO DEV TEAM",
"TermAddr1": "3300 BLOOR ST WEST",
"TermAddr2": "TORONTO ON",
"defaultTxn": "00",
"purchase": 1,
"purchaseCashback": 1,
"preAuthorization": 1,
"completion": 1,
"forcePost": 1,
"refund": 1,
"purchaseCorrection": 1,
"refundCorrection": 0,
"cardVerification": 1,
"balanceInquiry": 1,
"payment": 1,
"paymentCorrection": 1,
"hostInitialization": 1,
"clerkIDMaintenace": 1,
"logon": 1,
"logoff": 1,
"clerkSubtotalsInquiry": 1,
"closeBatch": 0,
"merchantSubtotalsInquiry": 0,
"depositTotalsInquiry": 0,
"assistedUP": 1,
"currency": "124",
"timeoutPinInterchar": 15,
"timeoutPinEntry": 60,
"timeoutHostResponse": 60
}
}
}
}
]
}
}| Élément | Type | Description | Taille | Obligatoire |
|---|---|---|---|---|
| receipt | Object (objet) | Contient le message de données de réponse | - | - |
| apiVersion | String (chaîne) | Numéro de version de l'API | V20 | Obligatoire |
| statusCode | String (chaîne) | Code d'état pour l'ensemble de la requête de transaction | V4 | Obligatoire |
| status | String (chaîne) | Description du code d'état (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 une requête en double | V50 | Obligatoire |
| action | String (chaîne) | « cancel » (annuler) | 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 (statusCode) individuel | V50 | Obligatoire |
| cloudTicket | String (chaîne) | Identifiant de référence unique de la requête Cloud | V100 | Obligatoire |
| completed | String (chaîne) | « true » (valeur booléenne vraie) ou « false » (valeur booléenne fausse) | V5 | Obligatoire |
| settings | Object (objet) | Renvoie les paramètres TMS et de l'hôte | - | - |
| terminalId | String (chaîne) | ID de 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": [
{
"idempotencyKey": "example_idempotencyKey",
"cloudTicket": "example_cloudTicket",
"terminalId": "example_terminalId",
"statusCode": "example_statusCode",
"status": "example_status",
"completed": "true",
"action": "sync",
"settings": {
"tms": {
"parameters": {
"applicationSettings": {
"goDevice": true,
"receipt": {
"customerReceiptPrompt": {
"emailReceipt": true,
"noReceipt": true,
"printReceipt": true,
"receiptPrompt": true,
"smsReceipt": true
},
"footerCustomerCopy": [
"testö",
"testgbj.",
" chycb. hj"
],
"headerCustomerCopy": [
"ËlïOÔoïö"
],
"numberOfMerchantCopies": "0",
"printDelay": "1",
"printQRCode": true
},
"security": {
"autoSignout": false,
"signoutTime": "40"
},
"semiIntegrated": {
"commType": "IP",
"enable": true,
"port": "",
"printingOnEcr": true
},
"tip": {
"byAmount": false,
"byPercent": true,
"enableTip": false,
"onSubtotal": false,
"preset1": "10",
"preset2": "0",
"preset3": "20",
"presetByAmount": false,
"warningThreshold": "100"
},
"TMS": {
"TMSConnectInterval": "720",
"TMSConnectTime": "07:23",
"TMSHost": "tmsct.moneris.com",
"TMSPort": "1124"
},
"transactionSettings": {
"cashBack": {
"amount1": "0",
"amount2": "10",
"amount3": "05",
"customValueAllowed": true,
"enableCashBack": true,
"Interac": true,
"InteracLimit": "100",
"limit": "100",
"Mastercard": true,
"MastercardLimit": "100",
"Visa": true,
"VisaLimit": "100"
},
"completion": {
"limitMultiplier": "4",
"limitThreshold": "1500"
},
"MonerisGiftAndLoyaltyApp": {
"enableGiftAndLoyalty": true,
"giftandLoyaltyID": "163467",
"routingCode": "79"
},
"MOTO": true,
"passTerminalTimer": "2",
"surcharge": {
"enableSurcharge": false,
"surchargeAmount": "50"
},
"transactionIdLabel": "Custom",
"transactionIdPrompt": true
}
},
"general": {
"initialized": true,
"PCIRebootTime": "03:00"
},
"merchant": {
"merchantAddress": "1180 BOULEVARD SACR COEU",
"merchantCity": "SAINT-FLICIE",
"merchantName": "MONERIS GO DEV TEAM",
"merchantPhone": "4169557091",
"merchantPostalCode": "M5J 0B8",
"merchantProvince": "ON"
},
"reports": {
"reportResetTime": "23:00"
}
}
},
"host": {
"card": {
"Ctls": true,
"Cards": {
"P": "INTERAC",
"V": "VISA",
"M": "MASTERCARD",
"AX": "AMEX",
"C1": "JCB",
"UP": "UNIONPAY",
"NO": "DISCOVER",
"DC": "DINERS"
}
},
"term": {
"MerchantID": "0030128914802",
"MerchantName": "MONERIS GO DEV TEAM",
"TermAddr1": "3300 BLOOR ST WEST",
"TermAddr2": "TORONTO ON",
"defaultTxn": "00",
"purchase": 1,
"purchaseCashback": 1,
"preAuthorization": 1,
"completion": 1,
"forcePost": 1,
"refund": 1,
"purchaseCorrection": 1,
"refundCorrection": 0,
"cardVerification": 1,
"balanceInquiry": 1,
"payment": 1,
"paymentCorrection": 1,
"hostInitialization": 1,
"clerkIDMaintenace": 1,
"logon": 1,
"logoff": 1,
"clerkSubtotalsInquiry": 1,
"closeBatch": 0,
"merchantSubtotalsInquiry": 0,
"depositTotalsInquiry": 0,
"assistedUP": 1,
"currency": "124",
"timeoutPinInterchar": 15,
"timeoutPinEntry": 60,
"timeoutHostResponse": 60
}
}
}
}
]
}
}
}Erreurs
Si votre réponse contient des erreurs, visitez la page des erreurs pour une description détaillée de chacune d'elles.
Mise à jour il y a 3 jours
Cette page vous a-t-elle aidé ?