Get the percentage withheld for credit card tips

Returns a TipWithholding object containing information about the way tip withholding is configured for a restaurant. Tip withholding is a percentage of employees' credit card tips that is kept by a restaurant to cover credit card processing fees.

Securityoauth2
Request
header Parameters
Toast-Restaurant-External-ID
required
string

The Toast POS GUID of the restaurant that the configuration applies to.

Responses
200

Returns a TipWithholding object.

get/tipWithholding
Request samples
curl -i -X GET \
  https://toast-api-server/config/v2/tipWithholding \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "enabled": true,
  • "percentage": 0
}