Gratuity is a JSON Structure definition published by Adyen, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-gratuity-structure.json",
"description": "Gratuity schema from Adyen API",
"type": "object",
"properties": {
"allowCustomAmount": {
"description": "Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown.",
"type": "boolean"
},
"currency": {
"description": "The currency that the tipping settings apply to.",
"type": "string"
},
"predefinedTipEntries": {
"description": "Tipping options the shopper can choose from if `usePredefinedTipEntries` is **true**. The maximum number of predefined options is four, or three plus the option to enter a custom tip.\nThe options can be a mix of:\n\n- A percentage of the transaction amount. Example: **5%**\n- A tip amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip.",
"items": {
"type": "string"
},
"type": "array"
},
"usePredefinedTipEntries": {
"description": "Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**).",
"type": "boolean"
}
},
"name": "Gratuity"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.