v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

MERCHANTS

Get all tip suggestions for a merchant

Retrieves all tip suggestions for a merchant, for example: flat tip or percentage.

get/v3/merchants/{mId}/tip_suggestions

mIdstring required

Merchant identifier.

filterstring

Filter fields to display search results: [flatTip, percentage, name, id, enabled]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Successful response. Displays tip suggestions for the merchant.

idstring

Unique identifier of the tip.

namestring

Name of the tip.

percentageinteger

Suggested tip percentage.

amountinteger

Suggested tip amount.

isEnabledboolean

Indicates whether tipping is enabled.

flatTipinteger

Suggested flat tip amount.