Property Cloud SDK App Unique Type Constraint Description
{
"activationCode": "55555",RequiredPortfoliostringUnique activation code for the terminal. Combined with the portfolio's terminalActivationKey property to uniquely identify a device.
"sessionKey": "A723A2AEE4E392D523E5B9629290ACDB683C67290CC480931AA8EA76D2FF0B73",stringDEPRECATED
"sessionKeyExpiry": "2018-10-10T14:43:52.8080704-06:00",stringDEPRECATED
"sessionKeySalt": "u0i8306r586CD0TC",stringDEPRECATED
"secretKey": "secret1",RequiredstringUsed internally for terminal authentication to validate terminal communication to cloud.
"status": "ACTIVE",Optionalenum[ACTIVE, INACTIVE]Defaults to "ACTIVE" if not provided
"uuid": "dddbbeed-923b-429b-add4-803fdb367ddd",RequiredUniversalstringUUID formatUniversally unique identifier for this terminal.
"id": "cloudterm1",RequiredPortfoliostringalphanumericUser-defined ID. Must match the constant value for /terminals/id
"portfolio": "mycompany",RequiredstringMust be constant value that matches /{portfolio} path.
"dateCreated": "2018-10-09T22:44:01.3731053-06:00",daten/aSystem provided only. Cannot be edited.
"dateModified": "2018-10-10T14:33:52.8080704-06:00",daten/aSystem provided only. Cannot be edited.
"configuration": {RequiredRequiredRequiredobjectDefines the runtime configuration of the terminal.
"endpoint": {RequiredobjectDefines the endpoint that payment transactions will be sent to, along with required fields describing the endpoint's parameters
"provider": "pps",RequiredstringHardcoded to PPS
"flavor": "sandbox",OptionalOptionalOptionalstringUser-defined secondary identifier for this configuration
"debug": true,OptionalOptionalOptionalbooleanTrue 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/",RequiredRequiredRequiredstringURL formatDefines the target URL of transactions run on this terminal
"serverDateFormat": "dd-MM-yyyy HH:mm:ss:SSS",RequiredRequiredRequiredstringdate maskDefines the date format of date-related fields that are sent to the endpoint as part of the transaction.
"username": "anywherecommerce.sandbox",RequiredRequiredRequiredstringUsername for the merchant account to be used. (NOTE: Can be substituted with merchantID and secret as per MX docs)
"password": "B*U&+U2JTW8eq+ct"RequiredRequiredRequiredstringPassword 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",OptionalOptionalOptionalexpressionISO date formatDefines the date format to be used by the terminal. Defaults to yyyy-MM-dd HH:mm:ss if not provided.
"registerCardReaderWhenConnected": true,OptionalOptionalOptionalbooleanIf true, the card reader's essential details are posted to /devices/{serial} when connected. Recommned true.
"cloudSyncEnabled": true,RequiredOptionalOptionalbooleanDetermines whether settings are saved/restored from the cloud. Must be set to true if terminalMode = "Cloud"
"allowDynamicTerminalCreation": true,n/aOptionalOptionalbooleanIf provided, allows one to authenticate via another mechanism and dynamically create a cloud profile. Do not use with terminalMode = "Cloud"
"terminalMode": "Cloud",RequiredOptionalOptionalenum[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",OptionalOptionalOptionalbooleanTrue to enable digest-based authentication from the terminal for added security.
"allowAnonymousUsers": true,OptionalOptionalOptionalbooleanTrue to allow users to use the terminal without authenticating. False to require user authentication before terminal use.
"enableRealtimeDebugging": true,OptionalOptionalOptionalbooleanIf true, enables streaming of logs in realtime to /diagnostics?realtime=true
"allowClearTransactions": true,n/aOptionalbooleanAllows the user to clear trasnaction from the local cache (does NOT delete them)
"allowPartialAuthorizations": true,OptionalOptionalOptionalbooleanTrue to enable partial authorizations, false to disable them.
"allowPartialRefunds": true,OptionalOptionalOptionalbooleanTrue to allow the user to refund a transaction at less than or equal to the amount of the original transaction.
"allowReferencedRefunds": true,n/aOptionalOptionalbooleanTrue to allow refunds against existing transactions. False to disable refunds against existing transactions.
"allowUnreferencedRefunds": true,OptionalOptionalOptionalbooleanTrue to allow sale-less refunds (i.e. without an existing transaction), False to disable sale-less refunds.
"chequeColorFormat": "Color",n/an/aOptionalenum[Color, Grayscale, Mono]Color format of the check used by Remote Check Deposit
"chequeColorFormatEditable": true,n/an/aOptionalbooleanTrue if the user can edit the chequeColorFormat setting from within the app.
"chequeFileFormat": "PNG",n/an/aOptionalenum[PNG, JPG, TIFF]Format of the check used by Remote Check Deposit
"chequeFileFormatEditable": true,n/an/aOptionalbooleanTrue if the user can edit the File Format setting from within the app.
"customFieldsEnabled": false,n/an/aOptionalbooleanCertain implemenatations only
"customFieldsEnabledEditable": false,n/an/aOptionalbooleanCertain implemenatations only
"defaultCardReader": "Walker 2.0 BT",RequiredRequiredRequiredenum[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/aOptionalOptionalbooleanTrue to allow the user to alter the default card reader. False to disable modification.
"defaultCurrency": "USD",RequiredRequiredRequiredenum3-digit ISO4217 Currency formatThe default currency code for transaction processed on this terminal. Default USD
"driversLicenseRequired": false,n/an/aOptionalbooleanRequire drivers license authenitcation (Remote Check Deposit Only)
"driversLicenseRequiredEditable": false,n/an/aOptionalboolean
"driversLicenseStateRequired": false,n/an/aOptionalboolean
"driversLicenseStateRequiredEditable": false,n/an/aOptionalboolean
"enableAvs": true,OptionalOptionalOptionalbooleanDetermines whether to require address for keyed transactions
"enableCvv": true,OptionalOptionalOptionalbooleanDetermined whether to require CVV for keyed transactions
"enableFirmwareUpdate": false,n/an/aOptionalbooleanTrue to enable the possibility of firmware update within the app. False to disable firmware updates.
"enableForgotPasswordUrl": false,n/an/aOptionalbooleanTrue to show a "forgot password" link on login.
"enabledCurrency": "USD",OptionalOptionalOptionalenum3-digit ISO4217 Currency formatThe currently selected currency of the terminal. May be different than the default currency.
"enabledCurrencyEditable": false,n/an/aOptionalbooleanTrue if the user can edit the current currency. False if the currency cannot be modified by the end user.
"enabledEntryModes": "SWIPE INSERT TAP PINPAD",RequiredRequiredRequiredstringSWIPE INSERT TAP PINPADEnabled entry modes. Separated by spaces. To disable an entry mode, remove from the list.
"enabledEntryModesEditable": false,n/an/aOptionalbooleanTrue if the user can edit the enabled entry modes. False otherwise.
"enabledPaymentMethods": "CREDIT",OptionalOptionalOptionalstringCREDIT DEBIT CHEQUE CRYPTO LOYALTY GIFT BIOMETRICEnabled accepted payment methods modes. Separated by spaces. To disable a payment method, remove from the list. Default = CREDIT
"enabledPaymentMethodsEditable": true,n/an/aOptionalbooleanTrue to enable editing of payment methods.
"enabledReceiptOptions": "Default",n/an/aOptionalstringDefault, ApprovedOnlyDefault sends receipts on both approval and declines. ApprovedOnly sends receipts only on approval.
"enabledReceiptOptionsEditable": false,n/an/aOptionalboolean
"enforce": true,OptionalOptionalOptionalbooleanIf present, overwrites the user configuration with the provided values.
"enforceFirmwareCompliance": false,OptionalOptionalOptionalbooleanEnsures the attached devices matches the required firmware version and configuration.
"forgotPasswordUrl": "https://payments.anywherecommerce.com/merchant/selfcare",n/an/aOptionalstringURL formatif enableForgotPasswordUrl is set, this is the link that "Forgot Password" links to.
"geofencingEnabled": false,n/an/an/abooleanReserved for future use
"geofencingEnabledEditable": false,n/an/an/abooleanReserved for future use
"geolocationEnabled": true,OptionalOptionalOptionalbooleanEnables geolocation. Geolocation data will be sent with every transaction.
"geolocationEnabledEditable": false,n/an/aOptionalbooleanAllows the user to turn on/off geolocation
"id": "default",OptionalOptionalOptionalstringA user-defined unique identifier for this configuration
"requireAvs": false,OptionalOptionalOptionalbooleanIf true, requires AVS authentication for keyed transactions.
"requireCardPresentRefunds": false,OptionalOptionalOptionalbooleanIf true, only refunds that are card present are allowed
"requireCardPresentSales": false,OptionalOptionalOptionalbooleanIf true, only sales that are card present are allowed
"requireCvv": false,OptionalOptionalOptionalbooleanIf true, requires CVV authentication for keyed transactions.
"requireTermsAndConditions": false,n/an/aOptionalbooleanSpecific implementations only
"sessionTimeoutEnabled": false,n/an/aOptionalbooleanSpecific implementations only
"sessionTimeoutEnabledEditable": true,n/an/aOptionalbooleanSpecific implementations only
"sessionTimeoutInterval": "Never",n/an/aOptionalstringNever or # of minutesSpecific implementations only
"supportedCurrencies": "ALL",OptionalOptionalOptionalenum3-digit ISO4217 Currency format, or ALLThe supported currencies (will reject transactions not in one of these currencies). Leave blank for all currencies.
"supportedEntryModes": "SWIPE INSERT TAP PINPAD",OptionalOptionalOptionalstringSWIPE INSERT TAP PINPADThe supported payment methods (will reject transactions not presented in one of these payment methods). Separated by a space
"supportedPaymentMethods": "CREDIT DEBIT CHEQUE",OptionalOptionalOptionalstringCREDIT DEBIT CHEQUE CRYPTO LOYALTY GIFT BIOMETRICThe supported entry modes (will reject transactions not presented in one of these modes). Separated by a space
"supportedReceiptOptions": "Default",n/an/an/astring"Default"Reserved for future use
"surchargeEnabled": false,OptionalOptionalOptionalbooleanTrue to enable additional fee line items, such as Non-Cash Fee, Convenience Fees, etc..
"surchargeEnabledEditable": true,n/an/aOptionalbooleanTrue to allow the user to turn off/on surcharges
"surchargeOptions": [OptionalOptionalOptionalarray of objects*Required if surchargeEnabled is trueDescribes the supported surcharge options
{
"calculationMethod": "PERCENTAGE_SUBTOTAL",RequiredRequiredRequiredenumPERCENTAGE_TOTAL, PERCENTAGE_SUBTOTAL, FLAT_RATEPERCENTAGE_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",OptionalOptionalOptionalstringThe friendly name to display to the user
"rate": {RequiredRequiredRequiredobjectDescriptor of the rate associated with this fee
"decimalPlaces": 3,RequiredRequiredRequiredintpositive integerNumber of decimal places to use for calculation
"isCurrency": false,OptionalOptionalOptionalbooleanIf true, renders the amount as a dollar value.
"isPercentage": true,OptionalOptionalOptionalbooleanIf true, renders the amount as a percentage value
"value": 0RequiredRequiredRequireddoublepositive numberThe value of the surcharge (either $ or % depending on values above).
},
"name": "% of Subtotal",OptionalOptionalOptionalstringInternal name of fee type (may be different than displayName)
"type": "fee"RequiredRequiredRequiredstringMust be "fee"
}
],
"surchargeOptionsEditable": true,n/an/aOptionalbooleanTrue if user ius allowed to edit surcharge options
"suspendAndResumeEnabled": false,n/an/aOptionalbooleanTrue to enable offline store&forward functionality (app only)
"suspendAndResumeEnabledEditable": false,n/an/aOptionalbooleanTrue to enable users to turn off/on store&forward (app only)
"suspendAndResumeSupportedEntryModes": "SWIPE PINPAD",n/an/aOptionalstringSWIPE INSERT TAP PINPADThe supported payment methods (will reject transactions not presented in one of these payment methods). Separated by a space
"suspendAndResumeSupportedPaymentMethods": "CREDIT",n/an/aOptionalstringCREDIT DEBIT CHEQUE CRYPTO LOYALTY GIFT BIOMETRICThe supported entry modes (will reject transactions not presented in one of these modes). Separated by a space
"taxEnabled": true,OptionalOptionalOptionalboolean
"taxEnabledEditable": true,OptionalOptionalOptionalboolean
"taxRates": [array of objectThe tax rate(s) that apply to this transaction.
{
"calculationMethod": "PERCENTAGE_SUBTOTAL",RequiredRequiredRequiredenumPERCENTAGE_TOTAL, PERCENTAGE_SUBTOTAL, FLAT_RATETypically PERCENTAGE_SUBTOTAL
"displayName": "GST (5%)",OptionalOptionalOptionalstringThe friendly name to display to the user
"rate": {RequiredRequiredRequiredobjectDescriptor of the rate associated with this fee
"decimalPlaces": 2,RequiredRequiredRequiredintpositive integerNumber of decimal places to use for calculation
"isCurrency": false,OptionalOptionalOptionalbooleanIf true, renders the amount as a dollar value.
"isPercentage": true,OptionalOptionalOptionalbooleanIf true, renders the amount as a percentage value
"value": 5.00RequiredRequiredRequireddoublepositive numberThe value of the surcharge (either $ or % depending on values above).
},
"name": "GST",OptionalOptionalOptionalstringInternal name of fee type (may be different than displayName)
"type": "tax"RequiredRequiredRequiredstringMust be "tax"
}
],
"taxRatesEditable": true,n/an/aOptionalbooleanTrue if the user can edit the tax rates
"termsAndConditionsUrl": "",n/an/aOptionalstringURL formatSpecific Implemenations Only
"tipEnabled": true,OptionalOptionalOptionalbooleanTrue to enable tip, false to disable tip
"tipEnabledEditable": true,OptionalOptionalOptionalbooleanTrue to allow user to turn off/on tip
"tipOptions": [
{
"calculationMethod": "PERCENTAGE_SUBTOTAL",RequiredRequiredRequiredenumPERCENTAGE_TOTAL, PERCENTAGE_SUBTOTAL, FLAT_RATETypically PERCENTAGE_SUBTOTAL
"displayName": "15%",OptionalOptionalOptionalstringThe friendly name to display to the user
"rate": {RequiredRequiredRequiredobjectDescriptor of the rate associated with this fee
"decimalPlaces": 0,RequiredRequiredRequiredintpositive integerNumber of decimal places to use for calculation
"isCurrency": false,OptionalOptionalOptionalbooleanIf true, renders the amount as a dollar value.
"isPercentage": true,OptionalOptionalOptionalbooleanIf true, renders the amount as a percentage value
"value": 15RequiredRequiredRequireddoublepositive numberThe value of the surcharge (either $ or % depending on values above).
},
"name": "15%"OptionalOptionalOptionalstringInternal name of fee type (may be different than displayName)
"type": "tip"RequiredRequiredRequiredstringMust be "tip"
],
"tipOptionsEditable": true,OptionalbooleanTrue to allow user to edit tip options
"transactionReportingMode": "ALL_USERS",n/an/aOptionalenumALL_USERS, ACTIVE_ONLYSpecific implementations only
"transactionReportingModeEditable": true,n/an/aOptionalbooleanSpecific implementations only
"unreferencedRefundLimit": 99999,OptionalOptionalOptionaldoublepositive numberMaximum limit threshold for unreferenced refunds (in the selected currency)
"userAuthenticationMode": "DEFER_UNTIL_REQUIRED",n/an/aOptionalenumNONE, IMMEDIATE, DEFER_UNTIL_REQUIREDSpecific implementations only
"verifyCardPresentForKeyedTransactions": false,n/an/aOptionalbooleanTrue 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/an/aOptionaldateDate this configration was modified
"allowKeyedTransactions": truen/an/aOptionalbooleanTrue to allow keyed transactions. False to require card present only
}
}