Gift Certificate - 010701
Adapter GK/Retail Stored Value Server - 01070100262
StoredValueServerConfig
| Parameter Name | Data Type, Range |
|---|---|
| gkrAdapterConfig | GkrAdapterConfig |
| prepaidGkrAdapterConfig | PrepaidGkrAdapterConfig |
GkrAdapterConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| url | String | It defines the URL. | |
| timeout | Integer | It defines the maximum time period over which the cash register waits for a response from the Stored Value Server. | 3000 |
| autoCancelRetryTime | Integer | It defines the time after which the attempt to connect is canceled. | 500 |
| autoCancelRetryCount | Integer | It defines the number of attempts at retrying to connect. | 2 |
| company | String | It defines the company. | GKR |
| readCardBefore | Boolean | It defines whether the gift card is read by the terminal before processing the terminal transaction. | true |
| cardPrefix | String | Required Prefix of the gift card number. | |
| terminalID | String | It defines the terminal ID. |
PrepaidGkrAdapterConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| url | String | It defines the URL. | |
| timeout | Integer | It defines the maximum time period over which the cash register waits for a response from the Stored Value Server. | 3000 |
Adapter Terminal Stored Value Server - 01070100263
StoredValueServerConfig
| Parameter Name | Data Type, Range |
|---|---|
| gkrAdapterConfig | GkrAdapterConfig |
| prepaidGkrAdapterConfig | PrepaidGkrAdapterConfig |
GkrAdapterConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| url | String | It defines the URL. | |
| timeout | Integer | It defines the maximum time period over which the cash register waits for a response from the Stored Value Server. | 3000 |
| autoCancelRetryTime | Integer | It defines the time after which the attempt to connect is canceled. | 500 |
| autoCancelRetryCount | Integer | It defines the number of attempts at retrying to connect. | 2 |
| company | String | It defines the company. | GKR |
| readCardBefore | Boolean | It defines whether the gift card is read by the terminal before processing the terminal transaction. | true |
| cardPrefix | String | Required prefix of the gift card number. | |
| terminalID | String | It defines the Terminal ID. |
PrepaidGkrAdapterConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| url | String | It defines the URL. | |
| timeout | Integer | It defines the maximum time period over which the cash register waits for a response from the Stored Value Server. | 3000 |
Gift Certificate Info - 01070100715
Functional Parameters
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| externalSystemAdapterName | String | It defines the Stored Value Server instance to be used and contains the logical name of the adapter. | |
| gcNumber | String | It defines the gift certificate number. | |
| promptUserConfig | PromptUserDialogConfig | It defines the configuration for prompting the user. | |
| registerGiftCertNumber | Boolean | It defines whether the gift certificate number is entered on the POS | true |
Note:
extends ProcessConfig
Gift Certificate Return - 01070100203
GiftCertificateReturnConfig
Note:
extends ProcessConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gcNumberRequired | Boolean | It specifies whether a gift certificate number must be entered. | true |
| gcItemRequired | Boolean | It specifies whether a gift certificate item must be entered. | false |
| gcsUsage | Boolean | It specifies whether the Stored Value Server is used. | true |
| useGcsAmount | Boolean | It specifies whether the amount stored in the Stored Value Server is used. | false |
| giftCertType | 01,02,04 | It specifies the gift certificate type. 01: Gift certificate 02: Gift Card 03: Third-party gift certificate (cannot be returned) 04: Gift certificate issued by the POS |
04 |
| checkCurrentReceipt | Boolean | It specifies whether a check is made against the current receipt. | true |
| giftCertClass | String | It defines the gift certificate class. | |
| checkGiftCertState | Boolean | It defines whether a gift certificate status query is addressed to the server before return. This setting is only valid if gcsUsage = true. |
true |
| externalSystemAdapterName | String | It defines the Stored Value Server instance to be used and contains the logical name of the adapter. | |
| gcNumber | String | It defines the gift certificate number. | |
| gcAmount | Double | It defines the gift certificate amount. | |
| gcItem | String | It defines the gift certificate item. | |
| taxGroupID | String | It defines the tax group. | |
| positionOperationConfig | PositionOperationConfig | It defines the configuration for line item-related operations. | |
| createReturnReceipt | Boolean | It defines whether a return receipt should be created for the gift certificate return operation. | false |
Gift Certificate Sale - 01070100202
GiftCertificateSaleConfig
Note:
extends ProcessConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| positionOperationConfig | PositionOperationConfig | ||
| promptUserConfig | PromptUserDialogConfig | ||
| gcNumberRequired | Boolean | It specifies whether a gift certificate number must be entered. | true |
| gcItemRequired | Boolean | It specifies whether a gift certificate item must be entered. | false |
| validationTime | Integer | It defines the validity period of the gift certificate in days. If the value is -1, the validity period is unlimited. This parameter will not be considered if the parameter expiryDate is filled. |
-1 |
| changeExpiryDateAllowed | Boolean | It specifies whether it is possible to change the expiration date. | |
| gcsUsage | Boolean | It specifies whether the Stored Value Server is used. | true |
| offlineAllowed | Boolean | It specifies whether gift certificate sale is allowed even in cases where online posting was not possible. | true |
| giftCertType | 01,02,04 | It specifies the gift certificate type. 01: Gift certificate 02: Gift Card 03: Third-party gift certificate (cannot be sold) 04: Gift certificate issued by the POS |
04 |
| minAmount | Double | It defines the minimum gift certificate amount. | |
| maxAmount | Double | It defines the maximum gift certificate amount. | |
| checkCurrentReceipt | Boolean | It specifies whether a check is made against the current receipt. | true |
| giftCertClass | String | It defines the gift certificate class. | |
| checkGiftCertState | Boolean | It specifies whether a status query is addressed to the Stored Value Server before gift certificate sale. This setting is only valid if gcsUsage = true. |
false |
| createGcNumber | Boolean | It automatically creates a number for gift certificates issued by the POS. | false |
| prefix | String | It defines the prefix for the generation of the gift certificate number. | |
| externalSystemAdapterName | String | It defines the Stored Value Server instance to be used and contains the logical name of the adapter. | |
| gcNumber | String | It defines the gift certificate number. | |
| gcAmount | Double | It defines the gift certificate amount. | |
| gcItem | String | It defines the gift certificate item. | |
| taxGroupID | String | It defines the tax group. | |
| expiryDate | Date | It defines the expiration date. | |
| scoTooManyGC | AuthorizationConfig | Authorization for too many gift certificates | |
| scoCreateOfflineGC | AuthorizationConfig | Authorization for an attempt to create a gift certificate while offline |
Payment Gift Certificate - 01070100908
PaymentConfig
Note:
extends ProcessConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| changePayoutAction | CASH CHOICE |
It specifies how to proceed in the case of overpayment: CASH – Change is always returned in cash. CHOICE – If the change due is greater than the amount of the used "Cash" tender, the tender to be used for change has to be selected. |
CASH |
GiftCertificatePaymentConfig
Note:
extends ProcessConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| positionOperationConfig | PositionOperationConfig | It defines the configuration for line item-related operations. | |
| openDrawer | NEVER TENDER |
NEVER - The drawer never opens. TENDER - The drawer opens if the tender setting (Tender.OpenCashDrawerRequiredFlag = true) requires it. |
TENDER |
| askForAmount | Boolean | It specifies whether the payment amount must be entered and is only considered if InputAmountConstraint = 01/02. | false |
| gcNumberRequired | Boolean | It specifies whether a gift certificate number must be entered. | true |
| tenderClassCode | String | It describes the assignment to a tender stored in the master data. | |
| giftCertType | 01,02,03,04 | It specifies the gift certificate type. 01: Gift certificate 02: Gift Card 03: Third-party gift certificate 04: Gift certificate issued by the POS |
04 |
| gcsUsage | Boolean | It specifies whether the Stored Value Server is used. | true |
| useGcsAmount | Boolean | It controls whether the gift certificate amount is provided by the Stored Value Server. | false |
| checkGiftCertState | Boolean | It specifies whether a gift certificate status query is addressed to the server before redemption. This setting is only valid if gcsUsage == true. |
true |
| inputAmountConstraint | 01,02,03,04 | 01: The amount is entered before function call. 02: The amount is entered optionally. 03: The amount entry is not allowed (matching payment). 04: The amount must be confirmed. Empty: The setting stored with the tender (Tender.InputAmountConstraint) is used. |
|
| paymentDescription | String | It defines the optional tender description; overrides the description stored in the table "Tender". | |
| externalSystemAdapterName | String | It defines the Stored Value Server instance to be used and contains the logical name of the adapter. | |
| confirmPartialPayment | Boolean |
It specifies whether partial payments must be confirmed. Only considered if InputAmountConstraint = 04. |
false |
| quantityAllowed | Boolean | It specifies whether it is allowed to enter the number of gift certificates. | false |
| nominalAmount | Double | It specifies a single unit amount of a gift certificate if a quantity of gift certificates is used. | |
| quantity | Integer | It specifies the number of gift certificates (count). | |
| maxManualAmount | Double | It specifies the maximum gift certificate amount for manually entered gift certificates. | |
| authorizeMaxManualAmount | Boolean | It specifies whether the maximum allowed manual gift certificate amount can be exceeded upon authorization. | false |
| gcNumber | String | It defines the gift certificate number. | |
| gcAmount | Double | It defines the gift certificate amount. | |
| authorizeMaxManualAmountExceeded | AuthorizationConfig | It defines the authorization configuration for authorization of Max Manual Amount Exceeded. | |
| promptForAmountConfig | PromptUserDialogConfig | It defines the config for a prompt for the gift certificate payment amount dialog. | |
| enableGiftCertificateChange | Boolean | It defines whether a paper gift certificate should be printed if the conditions match. | false |
| giftCertificateChangePrefix | String | This configuration defines the prefix of the number of paper gift certificate change, if gift certificate change is enabled. | 99 |
| validationTime | Integer | It defines the validity period of the gift certificate in days. If the value is -1, the validity period is unlimited. The parameter will only be considered if a gift certificate is issued. |
-1 |
| gcItem | String | It defines the gift certificate item (e.g. for Single Purpose Vouchers). If filled, then it will be used for sale return line item creation. |
|
| 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. | false |