Tips Settings API: Sample Use Cases and Flows

This article shares basic flows your app could support. You're certainly not limited to these use cases, but they can be a helpful jumping-off point for your planning.

Create location-specific tip settings

Your app could create tip settings tailored to a specific location.

To create location-specific tip settings:

1. Use List Locations to retrieve a list of all locations associated with the site.
2. Display the list of locations to the business owners and allow them select the location for which they want to configure specific tip settings.
3. Check if tip settings already exist for the chosen location using Query Tip Settings. Filter the query by the relevant location ID.
4. If location-specific tip settings exist, display them to the business owners for review and editing. If no settings exist, display default values and allow customization.
5. Save the tip settings using either Create Tip Settings, (for new settings) or Update Tip Settings (for existing settings).

Create payment-terminal-specific tip settings

Your app could create tip settings tailored to a specific device used for processing payments.

To create payment-terminal-specific tip settings:

1. Check if tip settings already exist for the relevant payment terminal using Query Tip Settings. Provide paymentTerminalId as filter.
2. If payment-terminal-specific tip settings exist, display them to the business owners for review and editing. If no settings exist, display default values and allow customization.
3. Save the tip settings using either Create Tip Settings, (for new settings) or Update Tip Settings (for existing settings).