Terminal - 011801

Cashback - 01180100918

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

CashbackConfig


Parameter Name	Data Type, Range	Description	Default
cashbackMinTotal	Double	Minimum sales for cashback. The receipt total must correspond to this amount at least; otherwise, cashback will not be possible.	10.00
cashbackMinAmount	Double	Minimum amount of cashback. Smaller amounts are not allowed as cashback.	10.00
cashbackMaxAmount	Double	Maximum amount of cashback. Higher amounts are not allowed as cashback.	200.00
cashbackDivider	Double	The desired cashback amount must divide wholly by this value.	0.01
amountInputMode	InputMode Add	InputMode: The amount can be entered with the numpad and fixed keys. Add: The amount can be entered by fixed buttons only. If more fixed buttons are used, the amount increases.	InputMode
cashbackNotesList	Double [ 0 .. * ]	List of amounts that are displayed in the cash back screen as note buttons.

EFT Selection - 01180100002

Not Supported: OPOS

SelectEFTConfig

Note:

extends ProcessConfig


Parameter Name	Data Type	Description	Default
alwaysShowEFTSelection	Boolean	Specifies if the EFT selection should be displayed in the online terminal payment even if an EFT is already selected	false

Payment Terminal - 01180100902

terminal.properties


Parameter Name	Data Type, Range	Description	Default
terminal.debug	String ON OFF	ON - The logging of basic information is activated. OFF - Nothing will be logged.	OFF
terminal.lowleveldebug	String ON OFF	ON - The log contains additional information. OFF - The log contains basic information only.	OFF
terminal.debug.out	String gklog, stdout, stderr, file.txt	Configuration of log output. Possible values: gklog – GKLog stdout – System.out stderr – System.err file.txt – as file	"gklog"
terminal.card_nr_mask	String	It defines the masking layout. (d = decimal place * = masked place .. = section of dynamic size)	dddddd..dddd
terminal.cardNumber Truncation.exclusionList	String	It specifies which card types are not concerned by masking. Payment Terminal Type Codes - 01180100027	23,24,25
terminal.wait_for_byte_sleep_time		How long the serial transport layer sleeps before it retries the reading if there is no data available on the COM port Default: 30ms Max: 500ms Min: 30ms	30
terminal.card_nr_hide.disable_printout_log	Boolean	It specifies if logging for printouts is disabled.	true
terminal.$NAME.cardnr_mask.default	String	It defines the masking format for the printout. (d = decimal place * = masked place .. = section of dynamic size) The parameter $NAME stands for the configured name of the terminal type (e.g. ThalesCOM).	dddddd..dddd
terminal.$NAME.cardnr_ mask_char.default	String	It defines the character masking of the card number for the printout.	*
terminal.$NAME.cardnr_printout_ replace_algorithm.default.$LFDNR	Integer 0, 1, 2	It defines the type of masking which is used for the printout: 0 - No masking 1 - The card number is searched in the context (defined by the parameters _mask_prefix, _previous, _following). 2 - The actual card number is searched and replaced in the print text (defined by _mask and _mask_char).	1
terminal.$NAME.cardnr_printout_ mask_prefix.default.$LFDNR	String	It defines the character string as a search string in front of the card number, on the same line (if there are several values in the parameter $LFDNR, a sequence number is added at the end for differentiation, e.g. 1). All entries are linked by an OR operation (including among each other on the same, previous, or next line).
terminal.$NAME.cardnr_printout_mask_ prefix_previous.default.$LFDNR	String	It defines the character string as a search string in front of the card number, on the previous line (if there are several values in the parameter $LFDNR, a consecutive number is added at the end for differentiation, e.g. 1). All entries are linked by an OR operation (including among each other on the same, previous, or next line).
terminal.$NAME.cardnr_printout_mask_ prefix_following.default.$LFDNR	String	It defines the character string as a search string in front of the card number, on the subsequent line (if there are several values in the parameter $LFDNR, a consecutive number is added at the end for differentiation, e.g. 1). All entries are linked by an OR operation (including among each other on the same, previous, or next line).
terminal.$NAME.direct_ debit_mask.default	String	It defines the masking layout for information regarding the bank account of the customer. (Used for IBAN and BIC) (d = decimal place * = masked place .. = section of dynamic size)	..dddd
terminal.$NAME.direct_debit_ mask_char.default	String	It defines the character masking the information regarding the bank account of the customer.	*

Functional Parameters

Table 1. TerminalPaymentConfig
Parameter Name	Data Type, Range	Description	Default
paymentOperationConfig	TerminalPaymentOperationConfig	It describes the payment operation config for the terminal payment action.
promptForAmountConfig	PromptUserDialogConfig	It describes the config for the prompt for the terminal payment amount dialog.
positionOperationConfig	PositionOperationConfig	It describes the position operation config for the terminal payment action.
securityAuthorizationConfig	AuthorizationConfig	It describes the authorization for the terminal event check security.
confirmSignatureMatchMessageConfig	MessageDialogConfig	It describes the configuration of the confirm signature match dialog.
checkEventConfirmMessageConfig	MessageDialogConfig	It describes the configuration of the check event confirm dialog.
confirmDialogOfflineTerminal	MessageDialogConfig	It describes the configuration of the terminal offline confirmation.
confirmationOfflineTerminalSkip	MessageDialogConfig	It describes the configuration of the terminal offline skip confirmation.
confirmDialogMerchantPrintoutConfig	MessageDialogConfig	It describes the configuration of the merchant receipt printed confirmation.
paymentFailedMessageKey	terminalPayment.failed.warning	This parameter defines a key for an error message to be displayed. It refers to the error message WarnDialog payment_impossible: Payment not possible!
paymentPleaseRetryKey	terminalPayment.failed.retryAgain	This parameter defines a key for an error message to be displayed. It refers to the error message WarnDialog payment_impossible: "Please repeat...".
confirmManualErrorHandlingMessageConfig	MessageDialogConfig	It describes the configuration of the confirm manual error handling dialog.
decideResultPaymentManuallyConfig	DecisionDialogConfig	It describes the configuration of the decision result payment manually dialog.
decideDCCConfig	DecisionDialogConfig	It describes the configuration of the decision DCC dialog.
eventCardInsertionMessageConfig	MessageDialogConfig	It describes the configuration of the event card insertion dialog.
eventCheckReprintQuestionConfig	MessageDialogConfig	It describes the configuration of the event check reprint question dialog.
promptForKeyboardRequestConfig	PromptUserDialogConfig	It describes the configuration of the keyboard request dialog.
promptForConfirmedStringRequestConfig	PromptUserDialogConfig	It describes the configuration of the confirmed string request dialog.
promptForConfirmedDatetimeRequestConfig	PromptUserDialogConfig	It describes the configuration of the confirmed date/time request dialog.
eventCheckContinueCancelConfig	MessageDialogConfig	It describes the configuration of the continue/cancel dialog.
decideControlKeyRequestConfig	DecisionDialogConfig	It describes the configuration of the decision key request dialog.
eventConfirmTerminalMessageConfig	MessageDialogConfig	It describes the configuration of the confirm terminal message dialog.
terminalRegistrationConfig	TerminalRegistrationConfig
trainingModeTerminalDeviceId	String	It describes the terminal device ID for training mode.
scoAuthOfflineTerminal	AuthorizationConfig	It describes the configuration of the terminal offline confirmation. It is only used for the self checkout.
scoAuthNotEnoughMoneyInTill	AuthorizationConfig	It describes the configuration of the not enough money in drawer confirmation. It is only used for the self checkout.
scoAuthCommunicationError	AuthorizationConfig	It describes the configuration of the communication error confirmation. It is only used for the self checkout.
scoAuthSignature	AuthorizationConfig	It describes the configuration of the authorization of signature confirmation. It is only used for the self checkout.
cashbackMode	Explicit Implicit None	Explicit: Cashback can explicitly be entered before starting the terminal transaction. Implicit: Cashback amount is calculated implicitly by the overpaid amount (= difference between open total amount and entered amount). None: No cashback is performed.	Implicit
checkForTip	Boolean	In case of an overpaid amount (= difference between open total amount and entered amount), the overpaid amount is used as the tip amount. No cashback or change amount will be given back in this case.	false

Note:

extends ProcessConfig

Table 2. TerminalPaymentOperationConfig
Parameter Name	Data Type, Range	Description	Default
deviceName	String	It defines the device name for that payment operation.
isOfflineTerminalPayment	Boolean	It specifies whether the payment is performed without an EFT terminal. true - The offline terminal payment will be triggered according to the offlineTerminalPaymentType parameter value false - The payment will be processed on the EFT terminal	false
offlineTerminalPaymentType	OFFLINE_TERMINALOFFLINE_SKIP	It specifies how the payment is performed without an EFT terminal if isOfflineTerminalPayment is set to true and if offline payment was triggered by the employee via the corresponding button in the EFT offline payment section. OFFLINE_TERMINAL - Terminal is not connected to the POS. OFFLINE_SKIP - Terminal is not able to process the payment because of offline status. Payment will be marked as "Offline" and will be repeated later when the terminal returns online.	OFFLINE_TERMINAL
printMerchantReceipt	Boolean	true - The merchant receipt is always printed before the sales receipt. false - The merchant receipt is printed after the sales receipt unless otherwise defined by the POS settings or terminal settings.	true
reprintMerchantReceipt	Boolean	The parameter defines whether the merchant receipt is reprinted: true - The merchant receipt is reprinted during Printout Repetition - 01130100605 false - The merchant receipt is not reprinted during Printout Repetition - 01130100605 The parameter is only considered if a terminal listed in the internal parameter "terminalWhiteList" is used. In that case, the merchant receipt is taken from the original transaction. If a terminal not listed there was used, the terminal device settings for (re)printing are checked. The merchant receipt is then taken from the terminal and can only be reprinted if it is still available there.	false
terminalAuthorizationType	String	It specifies the combination of card type and payment type (terminal authorization type); may be empty.
authorizationByVoice	Boolean	It specifies whether an authorization by phone is required by the terminal.	false
contractingCompanyNumber	String	It defines the contracting company number.
damageMode	OfflineForbid	It defines the behavior whether the cash register loses connection to the configured terminal. OFFLINE - The payment is carried out by the operator directly on the terminal and the transaction result is communicated to the cash register by an offline dialog. FORBID - The payment cannot be carried out.	FORBID
useChipCard	Boolean	true - CHIP_CARD false - MAGNET_CARD	false
terminalPaymentRulesId	String	ID of the ruleset in the file terminal_payment.xml	DEFAULT_TERMINAL_ ONLINE_TENDER_MAPPING
terminalAuthorizationRulesId	String	ID of the ruleset in the file terminal_authorization.xml.	DEFAULT_TERMINAL_ ONLINE_TENDER_MAPPING
directCurrencyConversionMode	Boolean	true - A DCC transaction (Direct Currency Conversion) can be called on the terminal. false - Usual terminal payment is carried out.	false
saveCcardNumber	Boolean	It specifies whether the card numbers of credit cards are saved.
cardValidationCodeRequired	Boolean	It controls whether the input field for the card validation code (CVC2) is displayed.	false
readCardByPOS	Boolean	true - The card data is entered on the cash register (MSR) and transferred to the terminal (if the terminal allows this). false - The card data is read by the terminal.	false
manualInputAllowed	Boolean	true - The card data is read by the terminal. false - The card data cannot be entered manually.	false
refundStartTime	String	It defines from which time on refunds can be credited to cards.
refundEndTime	String	It defines until which time refunds can be credited to cards.
maxRefundAmount	Double	It defines the maximum refund amount which can be credited.
checkSignatureActivated	Boolean	The parameter defines whether the signature check is activated on the POS at all: false - There is no signature check even if it is defined on the terminal device itself. true - The signature check is activated but only appears if it is defined on the terminal device or in TerminalCardPaymentConfig for the card.	true

Note:

extends PaymentOperationConfig

Table 3. TerminalRegistrationConfig
Parameter Name	Migration	Data Type, Range	Description	Default
enableTerminalPayment	TERMINAL_SIGN_OFF	Boolean	It specifies whether the terminal registration is enabled or not.	true
silentMode		Boolean	It specifies whether terminal registration errors must be shown and confirmed or not.
activeDeviceNames		String [ 0 .. * ]	It defines the active terminal device names.

Terminal Display Lines - 01180100001

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

TerminalDisplayLinesConfig


Parameter Name	Data Type, Range	Description	Default
TerminalDisplayLinesConfigs.displayLineItemsOnTerminal	Boolean	It defines whether any line items are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displaySaleReturnLineItemsOnTerminal	Boolean	It defines whether sale/return line items are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displaySaleReturnLineVoidedItemsOnTerminal	Boolean	It defines whether sale/return voided line items are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displaySaleReturnLineItemsDiscountsOnTerminal	Boolean	It defines whether item discounts are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displaySaleReturnItemNumbersOnTerminal	Boolean	It defines whether item numbers are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displayTransactionDiscountsItemsOnTerminal	Boolean	It defines whether transaction discount items are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displayTaxLineItemsOnTerminal	Boolean	It defines whether tax line items are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.displayTenderLineItemsOnTerminal	Boolean	It defines whether tender line items are displayed on the terminal display.	false
TerminalDisplayLinesConfigs.descriptionLengthOnTerminal	Number	The length that the description part needs to be padded to.	35
TerminalDisplayLinesConfigs.descriptionItemNumberLengthOnTerminal	Number	The length of the item number part of the description part.	12
TerminalDisplayLinesConfigs.amountLengthOnTerminal	Number	The length that the money part needs to be padded to.	12

Terminal Diagnostic - 01180101411

TerminalAdminDiagnosticConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID. The device ID of an active device as configured in hal.properties is used (for instance, by using the virtual emulator: "VIRTUAL" or by using the real device: "Thales_ZVT"). If there is no value defined, the value of the terminal default is used automatically.
silentMode	Boolean	It defines whether error dialogs are displayed to the operator.	false
confirmEnabled	Boolean	It controls whether a confirmation prompt is displayed before the terminal end-of-day.	true
confirmStart	MessageDialogConfig	Configuration of the confirm init dialog.

Terminal EMV Data Printout - 01180101474

TerminalAdminMCEmvReprintConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID.	ID_TERM
silentMode	Boolean	It defines whether error dialogs are displayed to the operator.	false
confirmEnabled	Boolean	It controls whether a confirmation prompt is displayed before the terminal performs emv data print out.	true
confirmStart	MessageDialogConfig	It defines the configuration of the confirm emv data print dialog.

Terminal End-of-Day - 01180101412

TerminalAdminEndOfDayConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID.	ID_TERM
silentMode	Boolean	It defines whether error dialogs are displayed to the operator.	false
confirmEnabled	Boolean	It controls whether a confirmation prompt is displayed before the terminal end-of-day.	false
confirmStart	MessageDialogConfig	It defines the configuration of the confirm end of day dialog.
terminalStateBeforeOperation	TerminalStateChange, LOGIN LOGOUT NONE	It specifies the operation to be performed by the terminal before the function starts: LOGIN – The terminal is logged in. LOGOUT – The terminal is logged out. NONE – No operation.	LOGIN
terminalStateAfterOperation	TerminalStateChange, LOGIN LOGOUT NONE	It specifies the operation to be performed by the terminal after the function ends: LOGIN – The terminal is logged in. LOGOUT – The terminal is logged out. NONE – The terminal status changes back to the status as it was before the function started.	NONE

Terminal Initialization - 01180101410

TerminalAdminInitConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal ID.	ID_TERM
silentMode	Boolean	It specifies whether error dialogs are displayed to the operator.	false
confirmEnabled	Boolean	It controls whether a confirmation prompt is displayed before initialization.	true
confirmStart	MessageDialogConfig	It defines the configuration of the confirm init dialog.

Terminal Key Exchange - 01180101475

TerminalAdminKeyExchangeConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID.	ID_TERM
silentMode	Boolean	It defines whether the error dialog is displayed to the operator.	false
confirmEnabled	Boolean	It controls whether a confirmation prompt is displayed before the terminal performs key exchange.	true
confirmStart	MessageDialogConfig	It defines the configuration of the confirm key exchange dialog.

Terminal Login - 01180101420

TerminalAdminLoginConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID.	ID_TERM
silentMode	Boolean	It defines whether error dialogs are displayed to the operator.	false
terminalErrorCodeForAlreadyLoggedIn	Integer	It defines the error code of terminal for "already logged in" when trying to log in. It is necessary to not report this situation as an error but as success for the login operation.

Terminal Logout - 01180101421

TerminalAdminLogoutConfig

Note:

extends ProcessConfig


Parameter Name	Migration	Data Type, Range	Description	Default
terminalDeviceId	TERMINAL_DEVICE_ID	String	It defines the terminal device ID.	ID_TERM
silentMode	SILENT_MODE	Boolean	It defines whether error dialogs are displayed to the operator.	false

Terminal Reprint - 01180101417

TerminalAdminReprintConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID. The device ID of an active device as configured in hal.properties is used (for instance, by using the virtual emulator: "VIRTUAL" or by using the real device: "Thales_ZVT"). If there is no value defined, the value of the terminal default is used automatically.
silentMode	Boolean	It defines whether error dialogs are displayed to the operator.	false
confirmEnabled	Boolean	It controls whether a confirmation prompt is displayed before the terminal end-of-day.	true
promptForReceiptNumber	Boolean	Allows the terminal receipt number input dialog to be suppressed. For instance, THALES_ZVT always prints the last executed terminal transaction receipt which means a particular receipt number is not used.	true
promptUserDialogConfig	PromptUserDialogConfig	It defines the configuration for the prompt user dialog for amount input.
confirmStart	MessageDialogConfig	It defines the configuration of the confirm init dialog.

Terminal Restart - 01180101422

TerminalAdminRestartConfig

Note:

extends ProcessConfig


Parameter Name	Data Type, Range	Description	Default
terminalDeviceId	String	It defines the terminal device ID. The device ID of an active device as configured in hal.properties is used (for instance, by using the virtual emulator: "VIRTUAL" or by using the real device: "Thales_ZVT"). If there is no value defined, the value of the terminal default is used automatically.
silentMode	Boolean	It defines whether error dialogs are displayed to the operator.	false