{"title":"Override configured tipping options","category":"default","creationDate":1729773780,"content":"

If you have defined default tipping options in your Customer Area, you may want to present different tipping options depending on the type of goods or services that a shopper buys. For example, if a shopper buys a cup of coffee, percentage-based tipping results in a lower tip for your staff than predefined fixed amounts.<\/p>\n

You can override the settings defined in your Customer Area by specifying the tipping options in the payment request. This shows the new tipping options on the terminal screen during the payment flow. However, you need to implement logic in your system when to trigger the override, such as logic to offer fixed amount options instead of percentages if the total amount is low.<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements and preparations.<\/p>\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nA Terminal API<\/a> integration with payment terminals on software version 1.97 or later.<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\nBefore you begin, you need to implement logic in your system when to trigger the override.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Tipping options<\/h2>\n

You can present your customer with either three percentage options or three tipping amount options. Additionally, you can enable the flag to present a Custom<\/strong> tip option. The No tip<\/strong> option is always included.<\/p>\n

Specify tipping options in the payment request<\/h2>\n

To override the configured tipping options, in the payment request you need to include the AskGratuity<\/strong><\/span> tender option<\/a> and a Base64-encoded Operation<\/code> object with the new tipping options.<\/p>\n

\n

Software versions 1.97 to 1.100 use an outdated Operation<\/code> object format. Choose the correct version tab in Step 1.<\/p>\n<\/div>\n

    \n
  1. \n

    Create an Operation<\/code> JSON object. Select the tab for the software version that your terminal is using.<\/p>\n\n

    \n
    \n \n <\/tabs>\n <\/div>\n<\/div>\n\n<\/li>\n
  2. \n

    Encode the Operation<\/code> JSON object to Base64. You will pass the resulting string in SaleData.SaleToPOIData<\/code>. The example below shows a Base64-encoded string of the Operation<\/code> object for software version V1.101 and later.<\/p>\n

    \n<\/code-sample>\n<\/div>\n<\/li>\n
  3. \n

    Make a payment request<\/a>, specifying:<\/p>\n