Payment - 010301

Functional Parameters

Table 1. PaymentOperationConfig
Parameter Name Data Type, Range Description
amount Double(16,5) It defines the amount by which the TransactionTotal was rounded so that it matched the available denominations of the currency being tendered.
askForAmount Boolean It specifies whether the payment amount must be entered (in an additional view). This parameter is only taken into account if the amount input for the tender is "required" or "optional". It is only considered if InputAmountConstraint = 01/02.
  • InputAmountConstraint = "Required 01"
  • InputAmountConstraint = "Optional 02"
tenderClassCode String It defines a code to denote a group of tenders with common characteristics, e.g. credit/debit cards, certificates, etc.
currencyCode String(3) The currency code is designated by ISO to identify a national currency. This parameter overrides the currency selection.

e.g. EUR, USD, CHF, ...
confirmPartialPayment Boolean It specifies whether partial payments must be confirmed. It is only considered, if InputAmountConstraint = 04.
  • InputAmountConstraint = "Confirm 04"
inputAmountConstraint TENDER, REQUIRED, OPTIONAL, PROHIBITED, CONFIRM It defines the input amount constraint.

Allowed Tenders - 01030100997

AllowedTendersConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
checkReasonTender Boolean It controls whether the tender admissibility is checked based on pay-in/pay-out reasons. true
checkCustomerGroupTender Boolean It controls whether the customer group assignment to the receipt affects the admissibility of a tender (true), or does not affect it (false). true
checkNegativeTotal Boolean It defines whether the additional admissibility checks are required in the case of a negative receipt total.

Deprecated. Use returnTenderRule instead.

true → RETURN_TO_ANY_MAPPED

false → RETURN_TO_ANY

 true
returnTenderRule RETURN_TO_ANY

RETURN_TO_ANY_MAPPED

RETURN_ITEM_TOTAL_TO_MAPPED

 RETURN_TO_ANY: any tender that is returnable can be returned for the full transaction amount.

RETURN_TO_ANY_MAPPED: retrieves the TenderSaleReturnRules and the tenders used on the original sale transaction. Any return tender in any TenderSaleReturnRule that has a sale tender matching any of the original sale tenders is valid.

RETURN_ITEM_TOTAL_TO_MAPPED: retrieves the TenderSaleReturnRules and the tenders and their amounts used on the original sale transaction. It also uses the line items to determine if any "special" tender totals were saved. The return rules are used to determine which tenders are valid, using either the original sale amounts or the calculated "special" tender amounts as appropriate.

 RETURN_TO_ANY_MAPPED
useTenderFromMasterData Boolean It defines the flag to indicate whether tenders are used from the master data or taken from an existing collection for collection creation/updates. true
filterRulesChain String It defines the tender filter rules chain (filters are executed in order).
overrideAdmissibilityPossible Boolean It specifies whether it is possible to override the admissibility of the selected tender for a customer temporarily. false

Change Rounding - 01030100909

TransactionCalculationServiceConfig

Parameter Name Data Type, Range Description Default
changeRoundMethod NO_ROUNDING (00),

ROUND_HALF_UP (01),

ROUND_DOWN (02),

ROUND_UP (03),

ROUND_HALF_DOWN (04)

 Rounding method for change rounding:

NO_ROUNDING = No rounding

ROUND_HALF_UP = Round up if neighbors are equidistant (commercial)

ROUND_DOWN = Round down

ROUND_UP = Round up

ROUND_HALF_DOWN = Round down if neighbors are equidistant

 01

Currency Selection - 01030100906

Not Supported: MPOS Size M MPOS Size S

Process parameter

Table 2. CurrencySelectionConfig
Parameter Name Data Type, Range Description
isoCurrencyCode String ISO 4217 currency code
Note:
extends ProcessConfig

Interface Mobile Payment - 01030100996

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

Parameter Name Data Type, Range Description
externalSystemAdapterName String Name of the mobile payment adapter that should be used by default.

Payment - 01030100900

PaymentConfig

Note:
extends ProcessConfig
Parameter Name Migration Data Type, Range Description
changePayoutAction BACK_MONEY_ACTION ChangePayoutAction [CASH, CHOICE] It describes how to proceed in the case of overpayment.
completePayoutInputAmountConstraint COMPLETE_PAYOUT_INPUT_AMOUNT_CONSTRAINT InputAmountConstraint [PROHIBITED, CONFIRM]

The input amount constraint that is used in the case of a complete payout payment state.

Prohibited=03, Confirm=04

FoodStampsTotalConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
considerDiscountsForFoodStampsTotal Boolean It specifies whether discounts (line item and transaction discounts) are considered for the food stamp total calculation. true

Payment Cash - 01030100901

Not Supported: MPOS Size M MPOS Size S

CashPaymentConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
paymentOperationConfig CashPaymentOperationConfig It defines the payment operation config for the cash payment action.
promptForAmountConfig PromptUserDialogConfig It defines the config for the prompt for the cash payment amount dialog.
positionOperationConfig PositionOperationConfig It defines the position operation config for the cash payment action.
moneyLaunderingVerificationMode None

All

ResidentAndNonResident

 It defines the verification mode for prevention of money laundering.
  • None - Cash payment limits are not checked and cash payments are not limited.
  • All - The same limit (moneyLaunderingLimitResident) is checked for all customers.
  • ResidentAndNonResident - Two limits are checked. One for residents (moneyLaunderingLimitResident) and one for non-residents (moneyLaunderingLimitNonResident).
 None
moneyLaunderingLimitResident Double It defines the cash payment limit for residents to prevent money laundering. 0
moneyLaunderingLimitNonResident Double It defines the cash payment limit for non-residents to prevent money laundering. 0
moneyLaunderingLimitExceededAction Forbid

Confirm

 It defines the action that is performed when the money laundering limit is exceeded.
  • Forbid - Payment is forbidden.
  • Confirm - Payment must be confirmed by the operator. The operator is responsible for verifying the customer. The verification is an organizational task and must be defined by the retailer (e.g. copy of customer ID card, fill out a special form, etc.).
 Forbid
askForTip Boolean In the case of an overpaid amount (= difference between open total amount and entered amount), a tip amount can be entered manually. false

CashPaymentOperationConfig

Note:
extends PaymentOperationConfig
Parameter Name Data Type, Range Description Default
checkMaxDenominationDifference Boolean This parameter specifies whether the max denomination difference is checked.

true - The difference between the current receipt total and the payment amount must not be greater than the highest denomination value.

false - The difference with respect to the highest denomination value is not verified.

 false

Payment Check - 01030100904

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

CheckPaymentConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
paymentOperationConfig CheckPaymentOperationConfig It defines the payment operation config for the check payment action.
manualLimitRequired Boolean It defines whether a check limit must be entered by the operator. This limit is printed on the check and will be validated against the payment amount. false
useMICR Boolean It defines whether an MICR should be used to read the check data. false
printCheck Boolean It defines whether the check data is printed on the check. false
onlineVerificationMode
  • None
  • Verify
 It defines the mode for online verification.
  • None - No verification is done.
  • Verify - Verification is done without funds on the customer account.
 None
checkInsideTestTimeout Integer Timeout in ms for checking if the check is inserted in the printer. 500
maxCheckTransactionLimit Double It defines the maximum amount of check payments for one transaction. 0
driverLicenseNumberRequired Boolean It defines whether the driver's license number must be entered. true
driverLicenseStateRequired Boolean It defines whether the driver's license state must be entered. true
phoneNumberRequired Boolean It defines whether the phone number must be entered. true
birthdayRequired Boolean It defines whether the date of birth must be entered. true

CheckPaymentOperationConfig

Note:
extends PaymentOperationConfig

Payment Credit - 01030100910

CreditPaymentConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
paymentOperationConfig CreditPaymentOperationConfig It defines the payment operation config for the credit payment action.
promptForAmountConfig PromptUserDialogConfig It defines the config for the prompt for the credit payment amount dialog.
positionOperationConfig PositionOperationConfig It defines the position operation config for the credit payment action.

CreditPaymentOperationConfig

Note:
extends PaymentOperationConfig
Parameter Name Data Type, Range Description Default
checkCreditLimit Boolean It specifies whether the customer's credit limit is checked. false
documentNumberRequired Boolean It specifies whether a document number must be entered. true
documentNumber String It defines the document number.
documentNumberDescription String It optionally contains the text of the entry field label.
overrideCreditLimitPossible Boolean It specifies whether it is possible to override the credit limit for the current transaction only. false

Payment End - 01030100998

PaymentEndConfigs

Parameter Name Data Type, Range Description Default
confirmChangeAmount Boolean Defines whether the change needs to be confirmed. true

Payment Process - 01030100999

PaymentConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
totalNegativeAction TotalNegativeAction [CASH, FORBID, CHOICESINGLE, CHOICEMULTIPLE] It describes the action for a negative receipt total.
changePayoutAction ChangePayoutAction [CASH, CHOICE] It describes how to proceed in the case of overpayment.
customerExclusive TenderUsage Flag [CUSTOMER_EXCLUSIVE_

TENDER_USAGE]

 It is taken into account only if CHECK_CUSTOMER_GROUP_TENDER = true.

True: The exclusive tender which is assigned to this customer will be automatically used.

False: The exclusive tender which is assigned to the customer is not taken into account.

 true
tenderTypeCode ConfigMappings TenderTypeCodeConfigMapping [0..*] It defines the default configuration instances for each tenderTypeCode. It is needed for customer exclusive tender usage.
allowedTenderConfig AllowedTendersConfig It controls the tender admissibility.
updateAllowed TenderConfig AllowedTendersConfig It controls the tender admissibility while updating the tender collection.
zeroSumWithCash Flag

[ZEROSUM_WITH_CASH]

 It specifies whether the cash key must be activated before closing a payment with the receipt total = 0. false
confirmCancel

Flag

[CONFIRM_PAYMENT_BREAK]

 It specifies whether a confirmation prompt is displayed when a payment is canceled.
transactionPreview ContextConfig TransactionPreview

ContextConfig

 It specifies the transaction preview context configuration.
confirmCancel MessageConfig Message

DialogConfig

 If confirmCancel=true, it configures the confirm cancel message dialog.
completePayout InputAmount Constraint InputAmountConstraint,

values: TENDER, REQUIRED, OPTIONAL, PROHIBITED, CONFIRM

 The input amount constraint is displayed in the case of a complete payout payment state.

Tender="", Required=01, Optional=02, Prohibited=03, Confirm=04
paymentMode PaymentMode

[TRANSACTIONPAYMENT, TENDEREXCHANGE]

 It defines the payment mode.

TransactionPayment=TRANSACTION_PAYMENT, TenderExchange=TENDER_EXCHANGE
skipPostValidation Flag It specifies whether the post validation is skipped or not.
customer IdentificationConfig Customer

IdentificationConfig

 It defines whether and how the customer is identified.
removeDiscounts ForTransaction Boolean It specifies whether manual receipt discounts are deleted when a payment is canceled (back to registration). false
displayCoupons ConfigId String Configuration for the Display Coupons process:

DisplayCouponsConfig

TenderTypeCodeConfigMapping

Parameter Name Data Type, Range Description
tenderTypeCode String It defines the tender typecode.
defaultConfigId String It specifies the default configuration instance ID for this tenderTypeCode.

AllowedTendersConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
checkReasonTender Boolean It controls whether the tender admissibility is checked based on pay-in/pay-out reasons. true
checkCustomerGroupTender Boolean It controls whether the customer group assignment to the receipt affects the admissibility of a tender (true), or does not affect it (false). true
checkNegativeTotal Boolean It defines whether the additional admissibility checks are required in the case of a negative receipt total. true
useTenderFromMasterData Boolean It defines the flag to indicate whether tenders are used from the master data or taken from an existing collection for collection creation/updates.
filterRulesChain String It defines the tender filter rules chain (filters are executed in order).

TransactionPreviewContextConfig

Parameter Name Data Type, Range Description Default
templateName String This parameter defines the name of the report template.
horizontalPositioningType HorizontalPositioningType [

Char as "1",

Pixel as "2"]

 It specifies the unit for the "posX" and "width" values in the report template:
  • Char as "1": The positioning unit depends on character width
  • Pixel as "2": The positioning unit depends on pixel width
 Pixel
verticalLinePadding Integer It specifies additional vertical line padding. This value will be added to the calculated line height, based on the font metrics. If you define any background colors (bgColor) in your report template, you should define an additional vertical line padding.
verticalLineSpacing Integer This value will be subtracted from the height of an entry rectangle, which will cause an additional vertical line spacing between the painted entries.

The value must be smaller or equal to verticalLinePadding. Otherwise, the text will be cut. If you define any background colors (bgColor) in your report template, you can define a vertical line spacing between the lines.
considerScopeTransactions Boolean It sets whether scope transactions should be considered or not.

If true, the active main or scoped transaction will be processed and displayed; otherwise, only the mainTransaction.
showHeader Boolean It specifies whether the header should be displayed or not.
showTotals String[0..*] It specifies whether the total should be displayed or not.
rowSelectionAllowed Boolean It specifies whether row selection is allowed in general.
cellEditAllowed Boolean It specifies whether inline cell editing is allowed in general.
showReturnableQuantity Boolean It specifies whether the returnable quantity for a line item should be displayed or not.
showLastChangedRow Boolean It specifies whether the last changed row should be made visible.
editLastChangedRow Boolean It specifies whether the last changed row should be edited.
showSubtotalRounding Boolean It sets whether the subtotal rounding should be displayed or not.
showChangeRounding Boolean It sets whether the change rounding should be displayed or not.
showLineItems String It specifies whether the line items for the given type codes should be displayed or not.
selectableLineItems String It specifies whether line items for the given type codes are selectable or not.
editableLineItems String It specifies whether line items for the given type codes are editable inline (cell editors) or not.

CustomerIdentificationConfig

Parameter Name Data Type, Range Description Default
customerCardType String It defines the required customer card type. CO
customerIdentificationFunction CustomerRegistration

CustomerSearch

CustomerDataEntry

 It defines the customer registration function. CustomerRegistration
customerRequired Boolean It controls whether it is necessary to enter a customer. If a customer is required, only receipts of this customer can be retrieved. false
customerRequiredAudibleAlert Boolean It specifies whether an acoustic signal is triggered before the customer identification function is called. false
customerRequiredMessage String It defines the message that is displayed if the customer is missing.
retrieveCustomerId Boolean
customerRegistrationConfigId String It defines the configuration for the customer registration process.
customerSearchConfigId String It defines the configuration for the customer search process.
customerDataEntryConfigId String It defines the configuration for the CustomerDataEntry process. It is only in use if customerIdentificationFunction is set to CustomerDataEntry.

Tender Exchange - 01030100610

Not Supported: MPOS Size M MPOS Size S

TenderExchangeConfig

Parameter Name Data Type, Range Description Default
openDrawer ALWAYS

NEVER

TENDER

 It specifies whether the cash drawer should be opened after the transaction was successfully finished.

ALWAYS: The drawer always opens.

NEVER: The drawer never opens.

TENDER: The drawer opens if the tender setting (Tender.OpenCashDrawerRequiredFlag = true) requires it.

 ALWAYS
tenderTypeCodeConfigMapping TenderTypeCodeConfigMapping[0..*] It specifies the mapping from the selected tender to the corresponding payment process configuration.

TenderTypeCodeConfigMapping

Parameter Name Data Type, Range Description
tenderTypeCode String It specifies the tender typecode of tender from.
defaultConfigId String It specifies the defaultConfigId of tender from.