Sync
Overview
The sync command allows you to pull the latest terminal settings, ensuring your devices has the most up-to-date configuration. Settings include, but are not limited to, accepted cards, cashback and receipt settings.
The "syncModifier" field in the request object dictates what kind of sync is performed.
- "Sync All": This modifier downloads the terminal configuration from the credit, debit and gift hosts, as well as the terminal management system. It is typically used when a device is brand new. By default, if no other modifier is defined, this is the default setting.
- "Sync TMS": This modifier downloads terminal settings, such as tips, cashback, and surcharges from the Moneris Terminal Management System (TMS).
- "Sync Host": This modifier downloads terminal configuration from the credit, debit and gift hosts. It is commonly used to apply charges to card plans, transaction limits and other similar updates
NOTE:
In order for your Moneris Go device to be PCI compliant, your device is reset daily in which case the sync to the Moneris Terminal Management System is run automatically.
List of coding scenarios that use this endpoint:
Request Structure
| Element | Type | Description | Size | Required |
|---|---|---|---|---|
| apiVersion | String | API version number | V20 | Required |
| istConfigCode | String | Moneris provided integration configuration code | V25 | Required |
| dataId | String | Merchant defined unique identifier for the data object | V50 | Required |
| dataTimestamp | String | Date and time of the request (YYYY-MM-DD HH:MM:SS) | F19 | Required |
| data | Object | Object that contains all transaction requests | — | — |
| request | Array | Contains data applicable to transaction request | — | — |
| idempotencyKey | String | Unique transaction identifier to avoid duplicate request | V50 | Required |
| merchantId | String | Merchant ID of requestor | V13 | Required |
| terminalId | String | Destination Terminal ID. Note: An error will be returned if terminalId in the request does not match with the Terminal. | F8 | Optional |
| progressStatus | String | If value is set to "True", terminal will return progress to POS. Note: This feature is only available on Direct Integration. | V5 | Optional |
| syncModifier | String | Identifies which host to synchronize with | V24 | Optional |
| action | String | "sync" | V50 | Required |
Request example
{
"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"
}
]
}
}Response Structure
| Element | Type | Description | Size | Required |
|---|---|---|---|---|
| apiVersion | String | API version number | V20 | Required |
| statusCode | String | Status code for the overall transaction request | V4 | Required |
| status | String | Description of the statusCode | V4 | Required |
| dataId | String | Merchant defined unique identifier for the data object | V50 | Required |
| dataTimestamp | String | Date and time of the request (YYYY-MM-DD HH:MM:SS) | F19 | Required |
| data | Object | Object that contains all transaction requests | — | — |
| response | Array | Contains data applicable to transaction request | — | — |
| idempotencyKey | String | Unique transaction identifier to avoid duplicate request | V50 | Required |
| action | String | "cancel" | V50 | Required |
| statusCode | String | Status code for individual request | V4 | Required |
| status | String | Description of the individual statusCode | V50 | Required |
| settings | Object | returns TMS and Host settings | — | — |
| completed | String | "true" or "false" | V5 | Required |
Response example
{
"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
}
}
}
}
]
}
}Errors
If your response contains errors, visit the Errors page for a detailed description of each one.