Properties
| Name | Type | Description |
|---|---|---|
| allowCustomAmount | boolean | 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. |
| currency | string | The currency that the tipping settings apply to. |
| predefinedTipEntries | array | 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. The options can |
| usePredefinedTipEntries | boolean | Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**). |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Gratuity",
"title": "Gratuity",
"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"
}
},
"type": "object"
}