TMS APIs
TMS parameters
| Settings Type | Key | Profile Name | API Name | Description |
|---|---|---|---|---|
| Terminal Settings | testParameter1 | TestParameter1 | ||
| TestParameter2 | TestParameter2 | |||
| NameTMSPar | NameTMSPar | |||
| NameTMSPar | NameTMSPar | |||
| NameTMSPar | NameTMSPar | |||
| NameTMSPar | NameTMSPar | |||
| 1 | Operation Type | operationType | Type of the terminal interaction with POS. Standalone – terminal is used as a standalone device and managed by the operator; Cloud - terminal connects to POS via the terminal cloud; Managed (deprecated) – terminal is managed by POS; Attached (deprecated) - terminal is managed by POS through the server. |
|
| 1 | Operation Types | operationType | Type of the terminal interaction with POS. Standalone – terminal is used as a standalone device and managed by the operator; Cloud - terminal connects to POS via the terminal cloud; Managed (deprecated) – terminal is managed by POS; Attached (deprecated) - terminal is managed by POS through the server. |
|
| 2 | Date Format | dateFormat | Date format of the terminal. Available formats: mmddyy; ddmmyy; yymmdd. | |
| 3 | Time Format | timeFormat | Time format of the terminal. Available formats: AM/PM or 24/24. | |
| 4 | Receipt Printing Order Type | receiptPrintingOrderType | Order, for whom - a customer or a merchant - a terminal is going to print a receipt first: Customer then Merchant - a receipt is printed out first for a customer and then for a merchant. If the customer has rejected the receipt to be received, only merchant receipt copy is printed by default. Merchant then Customer - a receipt is printed out first for a merchant and then for a customer. If the customer has rejected the receipt to be received, only merchant receipt copy is printed by default. Customer Only - a receipt is printed out for a customer only. If the customer has rejected the receipt to be received, merchant receipt copy is not printed. |
|
| 5 | IP Address | ipAddress | When POS is connected to a terminal via Ethernet, this is an IP address of the terminal. For cases, when terminal connection set through USB or Serial, connection path represents terminal`s port number. | |
| 6 | Theme Type | themeType | Color theme to be shown on a terminal screen. Can be the following: Blue (by default), Silver. | |
| 7 | Encryption Type | encryptionType | Approach that is used by the terminal for point-to-point encryption. N – encryption is not used; I - RSA encryption is handled internally by the gateway; T - encryption is handled externally using FirstData TransArmor. |
|
| n/a | Update | segment | Information about segment in the current version of the terminal | |
| Connectivity Settings | 1 | Gateway Host | gatewayHost | Host used for connection to the gateway. |
| 2 | Cloud Host | cloudHost | Host used for connection to the cloud. | |
| 3 | Cloud Port | cloudPort | Port of the cloud server. | |
| 4 | TMS Host | tmsHost | Host used for connection to the terminal management system. | |
| 5 | Read Timeout | readTimeout | Time period that defines maximum wait period for the response from a gateway to the terminal. Represented in seconds. | |
| 7 | Communication Protocol Type | communicationProtocolType | When POS is connected with a terminal via Ethernet, this is an encryption protocol used for communication between POS and terminal. Can be TLSv1_2 only. | |
| Terminal Profile | 1 | Amount Confirmation | isAmountConfirmationEnabled | Indicates whether transaction amount confirmation is enabled. |
| 10 | Debit Prioritization | isDebitPrioritizationEnabled | Indicates, whether prioritization of terminal application is enabled or not. If the configuration enabled, it means that a U.S. Common Debit AID is selected over a global AID with higher priority. | |
| 10 | Log Level | logLevel | Logging level on terminals. | |
| 11 | Terminal Mode | terminalMode | The classifier that indicates the stage of termianal parameters development: Integration ('I'), Demo('D'), Test('T'), Prod('P'). | |
| 12 | Update Version | updateVersion | Current update version. | |
| 13 | Version | version | Current version of the terminal parameters assigned when parameters get updated. | |
| 14 | Reward Number | isRewardNumberEnabled | Indicates whether reward number is enabled. | |
| 2 | Cashback | isCashbackEnabled | Indicates whether cashback is enabled. | |
| 3 | CSC | isCSCEnabled | Indicates whether CSC verification is enabled. | |
| 4 | Tip | isTipEnabled | Indicates whether tips addition is enabled. | |
| 5 | PIN Bypass | isPinBypassEnabled | Indicates whether PIN verification bypassing for EMV Contact (debit or credit) and Contactless (debit only) cards is enabled. Be advised that if a debit EMV card is used, the chip can ignore enabled PIN bypassing and still require a PIN to be entered. | |
| 6 | Convience Fee | isConvenienceFeeEnabled | Indicates whether convenience fee is enabled. | |
| 7 | Signature Confirmation | isSignatureConfirmationEnabled | Indicates whether reconciliation of a cardholder's signature on a card and on a receipt is enabled. | |
| 8 | Application Selection | isApplicationSelectionEnabled | Indicates whether a selection of a preferred application included in an EMV card is enabled. | |
| 9 | Advertising Profile | advertisingProfile | Contains the name of the archive with images that are going to be shown on a terminal screen. | |
| Processing Profile | 6 | Default Industry Type | defaultIndustryType | Type of the industry that the terminal is assigned to: Retail - a terminal is used in the retail industry, Restaurant - a terminal is used in the restaurant industry. |
| 7 | Entry Mode Policy | entryModePolicy | Controls which entry mode is used for the input of the transaction information in the terminal: Manual, Swipe, Proximity (using cards without chips), EMV and EMV Contactless. | |
| 8 | Payment Policy | paymentPolicy | Controls which card brands and types of payment are supported by the terminal (Visa, MasterCard, American Express, cash etc). | |
| 9 | Receipt Policy | receiptPolicy | Controls how a customer will receive a receipt after the transaction is processed: POS - the receipt is printed from POS, Terminal - the receipt is printed via terminal, Email - the receipt is sent to the customer via email, No receipt - the receipt isn’t required. |
|
| Inherited Settings | 1 | Account ID | accountId | Account code assigned to the terminal. |
| 2 | Terminal ID | terminalId | Terminal code assigned to the terminal. | |
| 3 | Country Code | countryCode | Country associated with the terminal. | |
| 4 | Currency Code | currencyCode | Currency used in the terminal. | |
| 5 | Time Zone | timeZone | Time zone of the terminal. | |
| 6 | Currency Sign | currencySign | Currency symbol used in the terminal. | |
| Processor Info | 1 | Profile Type | providerProfileType | Processor's profile assigned to the account that is associated with the terminal. |
| 2 | Merchant ID | providerMerchantId | MID assigned by a processor to the account that is associated with the terminal. | |
| 3 | Terminal ID | providerTerminalId | TID assigned by a processor to the account that is associated with the terminal. | |
| Offline Processing | 2 | MaxTransaction Amount | offlineAuthLimit | Transaction amount limit, available in the terminal for offline processing. |
| 3 | Gateway Synch Time | offlineAuthSyncTime | Time when offline transactions on the terminal are synchronized. | |
| 4 | Transaction Mode | offlineTransactionMode | Types of transactions - sale and/or credit - that are allowed for offline processing. Also, controls whether offline processing is enabled. Can be the following: No Offline Processing, Offline Sale Only, Offline Credit Only, Offline Sale And Credit. | |
| Merchant Info | 1 | Merchant Name | merchantName | Name of the merchant that the terminal is assigned to. |
| 2 | Merchant Address | merchantAddress | Address of the merchant that the terminal is assigned to. It includes the values of the following fields from the ''merchant-info'' response: ''street1, street2, zipCode, city, state, countryCode''. | |
| 3 | Working Hours | merchantWorkingHours | Working business hours of the merchant that the terminal is assigned to. | |
| 4 | Phone Number | merchantPhoneNumber | Phone number of the merchant that the terminal is assigned to. | |
| Terminal Data | 2 | Status | status | Indicates current status of the terminal. |
| n/a | Update | updateProfile | Information about the current system version of the terminal including its code, name, etc. | |
| Security Data | n/a | Admin PIN | adminPin | PIN code used by administrators to access terminal parameters and settings, such as connectivity settings, updates, rollbacks, etc. Admin PIN is changed every day according to the current date. PIN format: mmdd. |
| n/a | Manager PIN | managerPin | PIN code used by managers to access terminal basic parameters, for example, terminal profile. | |
| n/a | Last Password Changed Date | lastPasswordChangeDate | Date of the last password change. |
Copyright ©
Constellation Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.