{ |
|
|
|
|
|
|
|
"activationCode": "55555", | Required | | | Portfolio | string | | Unique activation code for the terminal. Combined with the portfolio's terminalActivationKey property to uniquely identify a device. |
"sessionKey": "A723A2AEE4E392D523E5B9629290ACDB683C67290CC480931AA8EA76D2FF0B73", | | | | | string | | DEPRECATED |
"sessionKeyExpiry": "2018-10-10T14:43:52.8080704-06:00", | | | | | string | | DEPRECATED |
"sessionKeySalt": "u0i8306r586CD0TC", | | | | | string | | DEPRECATED |
"secretKey": "secret1", | Required | | | | string | | Used internally for terminal authentication to validate terminal communication to cloud. |
"status": "ACTIVE", | Optional | | | | enum | [ACTIVE, INACTIVE] | Defaults to "ACTIVE" if not provided |
"uuid": "dddbbeed-923b-429b-add4-803fdb367ddd", | Required | | | Universal | string | UUID format | Universally unique identifier for this terminal. |
"id": "cloudterm1", | Required | | | Portfolio | string | alphanumeric | User-defined ID. Must match the constant value for /terminals/id |
"portfolio": "mycompany", | Required | | | | string | | Must be constant value that matches /{portfolio} path. |
"dateCreated": "2018-10-09T22:44:01.3731053-06:00", | | | | | date | n/a | System provided only. Cannot be edited. |
"dateModified": "2018-10-10T14:33:52.8080704-06:00", | | | | | date | n/a | System provided only. Cannot be edited. |
"configuration": { | Required | Required | Required | | object | | Defines the runtime configuration of the terminal. |
"endpoint": { | Required | | | | object | | Defines the endpoint that payment transactions will be sent to, along with required fields describing the endpoint's parameters |
"provider": "pps", | Required | | | | string | | Hardcoded to PPS |
"flavor": "sandbox", | Optional | Optional | Optional | | string | | User-defined secondary identifier for this configuration |
"debug": true, | Optional | Optional | Optional | | boolean | | True to enable debug-level logging. Note: Not recommended to use in production as will expose sensitive data. |
"gatewayUrl": "https://sandbox.api.mxmerchant.com/checkout/v3/", | Required | Required | Required | | string | URL format | Defines the target URL of transactions run on this terminal |
"serverDateFormat": "dd-MM-yyyy HH:mm:ss:SSS", | Required | Required | Required | | string | date mask | Defines the date format of date-related fields that are sent to the endpoint as part of the transaction. |
"username": "anywherecommerce.sandbox", | Required | Required | Required | | string | | Username for the merchant account to be used. (NOTE: Can be substituted with merchantID and secret as per MX docs) |
"password": "B*U&+U2JTW8eq+ct" | Required | Required | Required | | string | | Password for the merchant account to be used. (NOTE: Can be substituted with merchantID and secret as per MX docs) |
}, | | | | | | | |
"defaultDateFormat": "dd-MM-yyyy HH:mm:ss:SSS", | Optional | Optional | Optional | | expression | ISO date format | Defines the date format to be used by the terminal. Defaults to yyyy-MM-dd HH:mm:ss if not provided. |
"registerCardReaderWhenConnected": true, | Optional | Optional | Optional | | boolean | | If true, the card reader's essential details are posted to /devices/{serial} when connected. Recommned true. |
"cloudSyncEnabled": true, | Required | Optional | Optional | | boolean | | Determines whether settings are saved/restored from the cloud. Must be set to true if terminalMode = "Cloud" |
"allowDynamicTerminalCreation": true, | n/a | Optional | Optional | | boolean | | If provided, allows one to authenticate via another mechanism and dynamically create a cloud profile. Do not use with terminalMode = "Cloud" |
"terminalMode": "Cloud", | Required | Optional | Optional | | enum | [Cloud, App] | Detemines whether transactions originate from the cloud, or from the local user (i.e. initiating with a button press). Must be set to Cloud for cloud terminals. |
"requireDigestAuthentication": "false", | Optional | Optional | Optional | | boolean | | True to enable digest-based authentication from the terminal for added security. |
"allowAnonymousUsers": true, | Optional | Optional | Optional | | boolean | | True to allow users to use the terminal without authenticating. False to require user authentication before terminal use. |
"enableRealtimeDebugging": true, | Optional | Optional | Optional | | boolean | | If true, enables streaming of logs in realtime to /diagnostics?realtime=true |
"allowClearTransactions": true, | n/a | | Optional | | boolean | | Allows the user to clear trasnaction from the local cache (does NOT delete them) |
"allowPartialAuthorizations": true, | Optional | Optional | Optional | | boolean | | True to enable partial authorizations, false to disable them. |
"allowPartialRefunds": true, | Optional | Optional | Optional | | boolean | | True to allow the user to refund a transaction at less than or equal to the amount of the original transaction. |
"allowReferencedRefunds": true, | n/a | Optional | Optional | | boolean | | True to allow refunds against existing transactions. False to disable refunds against existing transactions. |
"allowUnreferencedRefunds": true, | Optional | Optional | Optional | | boolean | | True to allow sale-less refunds (i.e. without an existing transaction), False to disable sale-less refunds. |
"chequeColorFormat": "Color", | n/a | n/a | Optional | | enum | [Color, Grayscale, Mono] | Color format of the check used by Remote Check Deposit |
"chequeColorFormatEditable": true, | n/a | n/a | Optional | | boolean | | True if the user can edit the chequeColorFormat setting from within the app. |
"chequeFileFormat": "PNG", | n/a | n/a | Optional | | enum | [PNG, JPG, TIFF] | Format of the check used by Remote Check Deposit |
"chequeFileFormatEditable": true, | n/a | n/a | Optional | | boolean | | True if the user can edit the File Format setting from within the app. |
"customFieldsEnabled": false, | n/a | n/a | Optional | | boolean | | Certain implemenatations only |
"customFieldsEnabledEditable": false, | n/a | n/a | Optional | | boolean | | Certain implemenatations only |
"defaultCardReader": "Walker 2.0 BT", | Required | Required | Required | | enum | [Walker C2X, Walker C2X BT, Walker 2.0, Walker 2.0 BT, Sherpa] | Sets the default card reader for the application to search for. |
"defaultCardReaderEditable": true, | n/a | Optional | Optional | | boolean | | True to allow the user to alter the default card reader. False to disable modification. |
"defaultCurrency": "USD", | Required | Required | Required | | enum | 3-digit ISO4217 Currency format | The default currency code for transaction processed on this terminal. Default USD |
"driversLicenseRequired": false, | n/a | n/a | Optional | | boolean | | Require drivers license authenitcation (Remote Check Deposit Only) |
"driversLicenseRequiredEditable": false, | n/a | n/a | Optional | | boolean | | |
"driversLicenseStateRequired": false, | n/a | n/a | Optional | | boolean | | |
"driversLicenseStateRequiredEditable": false, | n/a | n/a | Optional | | boolean | | |
"enableAvs": true, | Optional | Optional | Optional | | boolean | | Determines whether to require address for keyed transactions |
"enableCvv": true, | Optional | Optional | Optional | | boolean | | Determined whether to require CVV for keyed transactions |
"enableFirmwareUpdate": false, | n/a | n/a | Optional | | boolean | | True to enable the possibility of firmware update within the app. False to disable firmware updates. |
"enableForgotPasswordUrl": false, | n/a | n/a | Optional | | boolean | | True to show a "forgot password" link on login. |
"enabledCurrency": "USD", | Optional | Optional | Optional | | enum | 3-digit ISO4217 Currency format | The currently selected currency of the terminal. May be different than the default currency. |
"enabledCurrencyEditable": false, | n/a | n/a | Optional | | boolean | | True if the user can edit the current currency. False if the currency cannot be modified by the end user. |
"enabledEntryModes": "SWIPE INSERT TAP PINPAD", | Required | Required | Required | | string | SWIPE INSERT TAP PINPAD | Enabled entry modes. Separated by spaces. To disable an entry mode, remove from the list. |
"enabledEntryModesEditable": false, | n/a | n/a | Optional | | boolean | | True if the user can edit the enabled entry modes. False otherwise. |
"enabledPaymentMethods": "CREDIT", | Optional | Optional | Optional | | string | CREDIT DEBIT CHEQUE CRYPTO LOYALTY GIFT BIOMETRIC | Enabled accepted payment methods modes. Separated by spaces. To disable a payment method, remove from the list. Default = CREDIT |
"enabledPaymentMethodsEditable": true, | n/a | n/a | Optional | | boolean | | True to enable editing of payment methods. |
"enabledReceiptOptions": "Default", | n/a | n/a | Optional | | string | Default, ApprovedOnly | Default sends receipts on both approval and declines. ApprovedOnly sends receipts only on approval. |
"enabledReceiptOptionsEditable": false, | n/a | n/a | Optional | | boolean | | |
"enforce": true, | Optional | Optional | Optional | | boolean | | If present, overwrites the user configuration with the provided values. |
"enforceFirmwareCompliance": false, | Optional | Optional | Optional | | boolean | | Ensures the attached devices matches the required firmware version and configuration. |
"forgotPasswordUrl": "https://payments.anywherecommerce.com/merchant/selfcare", | n/a | n/a | Optional | | string | URL format | if enableForgotPasswordUrl is set, this is the link that "Forgot Password" links to. |
"geofencingEnabled": false, | n/a | n/a | n/a | | boolean | | Reserved for future use |
"geofencingEnabledEditable": false, | n/a | n/a | n/a | | boolean | | Reserved for future use |
"geolocationEnabled": true, | Optional | Optional | Optional | | boolean | | Enables geolocation. Geolocation data will be sent with every transaction. |
"geolocationEnabledEditable": false, | n/a | n/a | Optional | | boolean | | Allows the user to turn on/off geolocation |
"id": "default", | Optional | Optional | Optional | | string | | A user-defined unique identifier for this configuration |
"requireAvs": false, | Optional | Optional | Optional | | boolean | | If true, requires AVS authentication for keyed transactions. |
"requireCardPresentRefunds": false, | Optional | Optional | Optional | | boolean | | If true, only refunds that are card present are allowed |
"requireCardPresentSales": false, | Optional | Optional | Optional | | boolean | | If true, only sales that are card present are allowed |
"requireCvv": false, | Optional | Optional | Optional | | boolean | | If true, requires CVV authentication for keyed transactions. |
"requireTermsAndConditions": false, | n/a | n/a | Optional | | boolean | | Specific implementations only |
"sessionTimeoutEnabled": false, | n/a | n/a | Optional | | boolean | | Specific implementations only |
"sessionTimeoutEnabledEditable": true, | n/a | n/a | Optional | | boolean | | Specific implementations only |
"sessionTimeoutInterval": "Never", | n/a | n/a | Optional | | string | Never or # of minutes | Specific implementations only |
"supportedCurrencies": "ALL", | Optional | Optional | Optional | | enum | 3-digit ISO4217 Currency format, or ALL | The supported currencies (will reject transactions not in one of these currencies). Leave blank for all currencies. |
"supportedEntryModes": "SWIPE INSERT TAP PINPAD", | Optional | Optional | Optional | | string | SWIPE INSERT TAP PINPAD | The supported payment methods (will reject transactions not presented in one of these payment methods). Separated by a space |
"supportedPaymentMethods": "CREDIT DEBIT CHEQUE", | Optional | Optional | Optional | | string | CREDIT DEBIT CHEQUE CRYPTO LOYALTY GIFT BIOMETRIC | The supported entry modes (will reject transactions not presented in one of these modes). Separated by a space |
"supportedReceiptOptions": "Default", | n/a | n/a | n/a | | string | "Default" | Reserved for future use |
"surchargeEnabled": false, | Optional | Optional | Optional | | boolean | | True to enable additional fee line items, such as Non-Cash Fee, Convenience Fees, etc.. |
"surchargeEnabledEditable": true, | n/a | n/a | Optional | | boolean | | True to allow the user to turn off/on surcharges |
"surchargeOptions": [ | Optional | Optional | Optional | | array of objects | *Required if surchargeEnabled is true | Describes the supported surcharge options |
{ | | | | | | | |
"calculationMethod": "PERCENTAGE_SUBTOTAL", | Required | Required | Required | | enum | PERCENTAGE_TOTAL, PERCENTAGE_SUBTOTAL, FLAT_RATE | PERCENTAGE_TOTAL calculates the fee on the total (after taxes and tips), PERCENTAGE_SUBTOTOAL calculates the fees on the subtotal (before taxes and tips), FLAT_RATE is a fixed rate. |
"displayName": "% of Subtotal", | Optional | Optional | Optional | | string | | The friendly name to display to the user |
"rate": { | Required | Required | Required | | object | | Descriptor of the rate associated with this fee |
"decimalPlaces": 3, | Required | Required | Required | | int | positive integer | Number of decimal places to use for calculation |
"isCurrency": false, | Optional | Optional | Optional | | boolean | | If true, renders the amount as a dollar value. |
"isPercentage": true, | Optional | Optional | Optional | | boolean | | If true, renders the amount as a percentage value |
"value": 0 | Required | Required | Required | | double | positive number | The value of the surcharge (either $ or % depending on values above). |
}, | | | | | | | |
"name": "% of Subtotal", | Optional | Optional | Optional | | string | | Internal name of fee type (may be different than displayName) |
"type": "fee" | Required | Required | Required | | string | | Must be "fee" |
} | | | | | | | |
], | | | | | | | |
"surchargeOptionsEditable": true, | n/a | n/a | Optional | | boolean | | True if user ius allowed to edit surcharge options |
"suspendAndResumeEnabled": false, | n/a | n/a | Optional | | boolean | | True to enable offline store&forward functionality (app only) |
"suspendAndResumeEnabledEditable": false, | n/a | n/a | Optional | | boolean | | True to enable users to turn off/on store&forward (app only) |
"suspendAndResumeSupportedEntryModes": "SWIPE PINPAD", | n/a | n/a | Optional | | string | SWIPE INSERT TAP PINPAD | The supported payment methods (will reject transactions not presented in one of these payment methods). Separated by a space |
"suspendAndResumeSupportedPaymentMethods": "CREDIT", | n/a | n/a | Optional | | string | CREDIT DEBIT CHEQUE CRYPTO LOYALTY GIFT BIOMETRIC | The supported entry modes (will reject transactions not presented in one of these modes). Separated by a space |
"taxEnabled": true, | Optional | Optional | Optional | | boolean | | |
"taxEnabledEditable": true, | Optional | Optional | Optional | | boolean | | |
"taxRates": [ | | | | | array of object | | The tax rate(s) that apply to this transaction. |
{ | | | | | | | |
"calculationMethod": "PERCENTAGE_SUBTOTAL", | Required | Required | Required | | enum | PERCENTAGE_TOTAL, PERCENTAGE_SUBTOTAL, FLAT_RATE | Typically PERCENTAGE_SUBTOTAL |
"displayName": "GST (5%)", | Optional | Optional | Optional | | string | | The friendly name to display to the user |
"rate": { | Required | Required | Required | | object | | Descriptor of the rate associated with this fee |
"decimalPlaces": 2, | Required | Required | Required | | int | positive integer | Number of decimal places to use for calculation |
"isCurrency": false, | Optional | Optional | Optional | | boolean | | If true, renders the amount as a dollar value. |
"isPercentage": true, | Optional | Optional | Optional | | boolean | | If true, renders the amount as a percentage value |
"value": 5.00 | Required | Required | Required | | double | positive number | The value of the surcharge (either $ or % depending on values above). |
}, | | | | | | | |
"name": "GST", | Optional | Optional | Optional | | string | | Internal name of fee type (may be different than displayName) |
"type": "tax" | Required | Required | Required | | string | | Must be "tax" |
} | | | | | | | |
], | | | | | | | |
"taxRatesEditable": true, | n/a | n/a | Optional | | boolean | | True if the user can edit the tax rates |
"termsAndConditionsUrl": "", | n/a | n/a | Optional | | string | URL format | Specific Implemenations Only |
"tipEnabled": true, | Optional | Optional | Optional | | boolean | | True to enable tip, false to disable tip |
"tipEnabledEditable": true, | Optional | Optional | Optional | | boolean | | True to allow user to turn off/on tip |
"tipOptions": [ | | | | | | | |
{ | | | | | | | |
"calculationMethod": "PERCENTAGE_SUBTOTAL", | Required | Required | Required | | enum | PERCENTAGE_TOTAL, PERCENTAGE_SUBTOTAL, FLAT_RATE | Typically PERCENTAGE_SUBTOTAL |
"displayName": "15%", | Optional | Optional | Optional | | string | | The friendly name to display to the user |
"rate": { | Required | Required | Required | | object | | Descriptor of the rate associated with this fee |
"decimalPlaces": 0, | Required | Required | Required | | int | positive integer | Number of decimal places to use for calculation |
"isCurrency": false, | Optional | Optional | Optional | | boolean | | If true, renders the amount as a dollar value. |
"isPercentage": true, | Optional | Optional | Optional | | boolean | | If true, renders the amount as a percentage value |
"value": 15 | Required | Required | Required | | double | positive number | The value of the surcharge (either $ or % depending on values above). |
}, | | | | | | | |
"name": "15%" | Optional | Optional | Optional | | string | | Internal name of fee type (may be different than displayName) |
"type": "tip" | Required | Required | Required | | string | | Must be "tip" |
], | | | | | | | |
"tipOptionsEditable": true, | Optional | | | | boolean | | True to allow user to edit tip options |
"transactionReportingMode": "ALL_USERS", | n/a | n/a | Optional | | enum | ALL_USERS, ACTIVE_ONLY | Specific implementations only |
"transactionReportingModeEditable": true, | n/a | n/a | Optional | | boolean | | Specific implementations only |
"unreferencedRefundLimit": 99999, | Optional | Optional | Optional | | double | positive number | Maximum limit threshold for unreferenced refunds (in the selected currency) |
"userAuthenticationMode": "DEFER_UNTIL_REQUIRED", | n/a | n/a | Optional | | enum | NONE, IMMEDIATE, DEFER_UNTIL_REQUIRED | Specific implementations only |
"verifyCardPresentForKeyedTransactions": false, | n/a | n/a | Optional | | boolean | | True to require CVV to be entered for keyed transactions (but does not send to server like enableCVV) |
"dateModified": "08-10-2018 23:55:08:467", | n/a | n/a | Optional | | date | | Date this configration was modified |
"allowKeyedTransactions": true | n/a | n/a | Optional | | boolean | | True to allow keyed transactions. False to require card present only |
} | | | | | | | |
} | | | | | | | |