Tips Settings API: Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping off point as you plan your implementation.

Create location-specific tip settings

You could create tip settings tailored to a specific location.

To create location-specific tip settings:

1. Call List Locations to retrieve a list of all locations associated with a site.
2. Select the location for which you want to configure specific tip settings.
3. Call Query Tip Settings and check if tip settings already exist for the chosen location. Filter the query by the relevant location ID.
4. If location-specific tip settings exist, call Update Tip Settings to make changes. If no settings exist, call Create Tip Settings to set the tip settings for that location.

Create payment-terminal-specific tip settings

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

To create payment-terminal-specific tip settings:

1. Call Query Tip Settings and check if tip settings already exist for the relevant payment terminal. Provide paymentTerminalId as filter.
2. If payment-terminal-specific tip settings exist, call Update Tip Settings to make changes. If no settings exist, call Create Tip Settings to set the settings for that payment terminal.