Table of Contents
- Overview
- Adding a Fixed Tip Amount
- Allowing a Custom Tip
- Adding Multiple Tip Amounts
- Adding Percentage Tip Amounts
Overview
Customer-Present Cloud opens up avenues for integrators to enhance payment requests by incorporating additional prompts on the payment device. Tipping functionality is one such prompt, enabling integrations to seamlessly request tips from end customers through the API request.
This article delves into the functionality of POI Device Prompts within Customer-Present Cloud, specifically focusing on the versatile tipping feature. Integrations can leverage this capability to prompt customers for tips, whether it involves passing fixed tip amounts, requesting input for tip amounts, offering predefined tip options, or presenting percentage-based tipping options.
Adding a Fixed Tip Amount
One of the primary tipping methods facilitated by Customer-Present Cloud is the straightforward standard fixed tipping approach. In this method, the tip amount is predefined and transmitted within the API request before the customer engages with the payment device. This method seamlessly integrates the tip into the transaction, ensuring that customers encounter no tipping options during their interaction with the payment device. To illustrate, an API request employing this tipping method would include the variable (tip) along with its designated value (e.g., 1.00). This proactive inclusion of the tip amount within the payment request streamlines the process, creating a frictionless and transparent experience for both merchants and customers.
| Variable | Description |
| tip | Included in the transaction amount, Final tip amount. Format: x.xx |
Here is an example of the a Customer-Present Cloud API request, where the integration will pass a fixed tip amount:
POST: /api/transact.php
PARAMS:
[
security_key : your_security_key
poi_device_id : "POI Device ID Here"
type : sale
amount : 10.00
response_method : asynchronous
tip : 1.00
]
The above example will begin a Customer-Present Cloud transaction, where the customer will see that they will pay 11.00.
Allowing a Custom Tip
Customer-Present Cloud also has a dynamic tipping feature known as poi_prompt_tip. This method empowers merchants to engage their customers actively, allowing them to input a tip amount directly during the transaction. Unlike predefined tips, poi_prompt_tip provides a personalized experience, putting the customer in control of the gratuity they wish to leave. While this approach demands a bit more input from the customer compared to standard fixed tipping, it adds a layer of customization to the transaction process. Integrations leveraging Customer-Present Cloud can implement this interactive tipping method, providing merchants with a middle ground between simplicity and customer involvement.
| Variable | Description |
| poi_prompt_tip |
Setting to 'true' will allow the cardholder to type in a tip amount via the POI Device. Format: boolean (true/false) Default: false |
Here is an example of a Customer-Present Cloud API request, which will prompt the end customer to input a tip amount right on the payment device:
POST: /api/transact.php
PARAMS:
[
security_key : your_security_key
poi_device_id : "POI Device ID Here"
type : sale
amount : 10.00
response_method : asynchronous
poi_propmt_tip : true
]
The above request will show the customer a charge of 10.00, as the customer interacts with the payment device, the device will prompt the customer to include a tip. The customer will then need to input the tip amount they would like to pay via the payment device directly. Once complete the payment device will continue it's customer interaction until complete and finish the transaction upon approval/decline.
Adding Multiple Tip Amounts
Customer-Present Cloud goes beyond standard tipping methods by introducing the 'Quicktip' feature. Integrations can leverage this functionality to effortlessly pass a predefined list of tip amounts within the API request. For instance, when utilizing poi_prompt_quicktip_amounts, integrations need to include the values of all tip amounts they wish to present to the end customer (e.g., 1.50,2.00,2.50,3.00). This allows for a streamlined and convenient tipping experience, offering customers a range of predetermined tip options during the transaction.
| Variable | Description |
| poi_prompt_quicktip_amounts |
Show an on-screen list of quick tip amount options when tipping via the POI Device. If an empty value is submitted for this parameter it will automatically generate a list of values for the tip amounts. Format: X.XX, comma delimited up to 4 options. Example: 1.50,3.00,4.50 |
Here is an example of a Customer-Present Cloud API request, which will utilize the poi_prompt_quicktip_amounts and offer 3 different tip amounts to the end customer:
POST: /api/transact.php
PARAMS:
[
security_key : your_security_key
poi_device_id : "POI Device ID Here"
type : sale
amount : 10.00
response_method : asynchronous
poi_propmt_quicktip_amounts : 1.00,2.50,4.00
]
The above example will charge the end customer 10.00 and prompt the customer to select one of the three provided tip amounts. Once the customer selects the tip amount they would like to pay the final amount of the transaction will be updated to include the tip amount.
Adding Percentage Tip Amounts
In addition to predefined tip amounts, Customer-Present Cloud introduces the flexibility of 'Quicktip' percentages for integrations. By utilizing poi_prompt_quicktip_percentages , integrations can seamlessly include a list of percentage-based amounts on the payment device during a transaction. For instance, when implementing poi_prompt_quicktip_percentages , integrations should pass the percentage values of all tipping options they want to present to the end customer (e.g., 10.00,20.00,25.00,30.00). This feature provides a versatile and adaptable approach, allowing merchants to offer a range of tipping percentages tailored to customer preferences.
| Variable | Description |
| poi_prompt_quicktip_percentages |
Show an on-screen list of quick tip percentage options when tipping via the POI Device. If an empty value is submitted for this parameter it will automatically generate a list of values sent to the Payment Device. Format: XX.XX, comma delimited up to 4 options. Example: 10.00,15.00,25.00 |
Here is an example of a Customer-Present Cloud API request, which will utilize the poi_prompt_quicktip_percentages and offer 3 different tip percentages to the end customer:
POST: /api/transact.php
PARAMS:
[
security_key : your_security_key
poi_device_id : "POI Device ID Here"
type : sale
amount : 10.00
response_method : asynchronous
poi_propmt_quicktip_percentages : 10.00,15.00,30.00
]
The above example will charge the end customer 10.00 and prompt the customer to select one of the three provided tip percentages. Once the customer selects the tip percentage they would like to add to the final amount. Once selected the option will then be amended to the final amount.