PATCH /terminals/{terminalId}/terminalSettings

The unique identifier of the payment terminal.

Default value: "application/json"

Generic receipt settings.

The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.

Indicates whether a screen appears asking if you want to print the shopper receipt.

Data to print on the receipt as a QR code. This can include static text and the following variables:

• ${merchantreference}: the merchant reference of the transaction.
• ${pspreference}: the PSP reference of the transaction.

For example, http://www.example.com/order/${pspreference}/${merchantreference}.

Settings for refunds.

Settings for referenced refunds.

Indicates whether referenced refunds are enabled on the standalone terminal.

Settings for tipping with or without predefined options to choose from. The maximum number of predefined options is four, or three plus the option to enter a custom tip.

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.

Indicates whether the terminal shows a prompt to enter a tip (false), or predefined tipping options to choose from (true).

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 be a mix of:

• A percentage of the transaction amount. Example: 5%
• A tip amount in minor units. Example: 500 for a EUR 5 tip.

The currency that the tipping settings apply to.

Settings to define the behaviour of the payment terminal.

Indicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated.

Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.

General Wi-Fi settings.

The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.

Indicates whether roaming is enabled on the terminals.

The connection time-out in seconds. Minimum value: 0.

List of remote Wi-Fi profiles.

For eap tls. The password of the RSA key file, if that file is password-protected.

Indicates if the network doesn't broadcast its SSID. Mandatory for Android terminals, because these terminals rely on this setting to be able to connect to any network.

For eap tls. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY.

The certificate content converted to a Base64-encoded string.

The name of the certificate. Must be unique across Wi-Fi profiles.

For authType wpa-eap or wpa2-eap. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server.

The name of the wireless network.

For authType wpa-eap or wpa2-eap. Possible values: tls, peap, leap, fast

The type of Wi-Fi network. Possible values: wpa-psk, wpa2-psk, wpa-eap, wpa2-eap.

Use infra for infrastructure-based networks. This applies to most networks. Use adhoc only if the communication is p2p-based between base stations.

For eap tls. The EAP intermediate certificate.

The certificate content converted to a Base64-encoded string.

The name of the certificate. Must be unique across Wi-Fi profiles.

The channel number of the Wi-Fi network. The recommended setting is 0 for automatic channel selection.

Your name for the Wi-Fi profile.

For eap tls. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate.

The certificate content converted to a Base64-encoded string.

The name of the certificate. Must be unique across Wi-Fi profiles.

The type of encryption. Possible values: auto, ccmp (recommended), tkip

For eap peap. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server.

Indicates whether to automatically select the best authentication method available. Does not work on older terminal models.

For authType wpa-eap or wpa2-eap. The root certificate from the CA that signed the certificate of the RADIUS server that is part of your wireless network.

The certificate content converted to a Base64-encoded string.

The name of the certificate. Must be unique across Wi-Fi profiles.

For authType **wpa-psk or wpa2-psk. The password to the wireless network.

Indicates whether this is your preferred wireless network. If true, the terminal will try connecting to this network first.

Settings for offline payment features.

The maximum offline transaction amount for swiped cards, in the specified currency.

The three-character ISO currency code.

The transaction amount, in minor units.

The maximum offline transaction amount for chip cards, in the processing currency and specified in minor units.

Settings for payment features.

The default currency for contactless payments on the payment terminal, as the three-letter ISO 4217 currency code.

Hides the minor units for the listed ISO currency codes.

Settings for Tap to Pay.

The text shown on the screen during the Tap to Pay transaction.

Settings to define the header of the shopper receipt.

A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, header,header,filler

Settings for terminal hardware features.

The hour of the day when the terminal is set to reset the Totals report. By default, the reset hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.

The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.

The brightness of the display when the terminal is being used, expressed as a percentage.

Settings for terminal connectivity features.

The list of local and public URLs to send notifications to when using local integrations.

One or more public URLs to send event notifications to when using Terminal API.

The username for authentication of the notifications.

The URL in the format: http(s)://domain.com.

Indicates if the message sent to this URL should be encrypted.

The password for authentication of the notifications.

One or more local URLs to send event notifications to when using Terminal API.

The username for authentication of the notifications.

The URL in the format: http(s)://domain.com.

Indicates if the message sent to this URL should be encrypted.

The password for authentication of the notifications.

Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity.

Possible values:

• ACTIVATED: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the Network settings.
• INVENTORY: the SIM card is not activated. The terminal can't use cellular connectivity.

Possible values:

• "INVENTORY"
• "ACTIVATED"

Settings for a Terminal API integration.

The list of local and public URLs to send display notifications to when using Terminal API.

One or more public URLs to send notifications to when using Terminal API.

The username for authentication of the notifications.

The URL in the format: http(s)://domain.com.

Indicates if the message sent to this URL should be encrypted.

The password for authentication of the notifications.

One or more local URLs to send notifications to when using Terminal API.

The username for authentication of the notifications.

The URL in the format: http(s)://domain.com.

Indicates if the message sent to this URL should be encrypted.

The password for authentication of the notifications.

One or more URLs to send event messages to when using Terminal API.

The key you share with Adyen to secure local communications when using Terminal API.

The unique identifier of the shared key.

The version number of the shared key.

The secure passphrase to protect the shared key.

Configures sending event notifications by pressing a button on a terminal, for example used for pay-at-table.

The type of event notification sent when you select the notification button.

Possible values:

• ""
• "SaleWakeUp"
• "KeyPressed"

Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.

The name of the notification button on the terminal screen.

Shows or hides the event notification button on the screen of terminal models that have a keypad.

The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.

The list of local and public URLs to send event notifications to when using Terminal API.

One or more public URLs to send event notifications to when using Terminal API.

The username for authentication of the notifications.

The URL in the format: http(s)://domain.com.

Indicates if the message sent to this URL should be encrypted.

The password for authentication of the notifications.

One or more local URLs to send event notifications to when using Terminal API.

The username for authentication of the notifications.

The URL in the format: http(s)://domain.com.

Indicates if the message sent to this URL should be encrypted.

The password for authentication of the notifications.

Settings to skip signature, sign on display, or sign on receipt.

Skip asking for a signature. This is possible because all global card schemes (American Express, Diners, Discover, JCB, MasterCard, VISA, and UnionPay) regard a signature as optional.

Slogan shown on the start screen of the device.

Name that identifies the terminal.

If skipSignature is false, indicates whether the shopper should provide a signature on the display (true) or on the merchant receipt (false).

Settings for store-and-forward offline payments. The maxAmount, maxPayments, and supportedCardTypes parameters must be configured, either in the request or inherited from a higher level in your account structure.

The maximum amount that the terminal accepts for a single store-and-forward payment.

The three-character ISO currency code.

The transaction amount, in minor units.

The type of card for which the terminal accepts store-and-forward payments. You can specify multiple card types.

Set to true to accept debit cards.

Set to true to accept prepaid cards.

Set to true to accept cards that allow deferred debit.

Set to true to accept card types for which the terminal can't determine the funding source while offline.

Set to true to accept credit cards.

The maximum number of store-and-forward transactions per terminal that you can process while offline.

Settings for localization.

The time zone of the terminal.

Secondary language of the terminal.

Language of the terminal.

Settings for standalone features.

The default currency of the standalone payment terminal as an ISO 4217 currency code.

Enable standalone mode.

Settings for passcodes features.

The passcode for the Admin menu and the Settings menu.

The passcode to unlock the terminal screen after a timeout.

The passcode for the Transactions menu.

The passcode for referenced and unreferenced refunds on standalone terminals.

Settings for Pay-at-table features.

Allowed authentication methods: Magswipe, Manual Entry.

Possible values:

• "MAGSWIPE"
• "MKE"

Sets the allowed payment instrument for Pay at table transactions. Can be: cash or card. If not set, the terminal presents both options.

Possible values:

• "Card"
• "Cash"

Enable Pay at table.

Settings for an Oracle Payment Interface (OPI) integration.

The store number to use for Pay at Table.

Indicates if Pay at table is enabled.

The URL and port number used for Pay at Table communication.

Transaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.

Print a merchant receipt when capturing the payment is approved.

Print a merchant receipt when the refund is approved.

Print a shopper receipt when the payment is approved.

Print a shopper receipt when the refund is approved.

Print a merchant receipt when the payment is approved.

Print a merchant receipt when the payment is refused.

Print a shopper receipt when the refund is refused.

Print a shopper receipt when capturing the payment is approved.

Print a merchant receipt when a previous transaction is voided.

Print a shopper receipt when a previous transaction is voided.

Print a merchant receipt when the transaction is cancelled.

Print a shopper receipt when capturing the payment is refused.

Print a merchant receipt when capturing the payment is refused.

Print a shopper receipt when the transaction is cancelled.

Print a shopper receipt when the payment is refused.

Print a merchant receipt when the refund is refused.

Settings for payment surcharge features.

Show the surcharge details on the terminal, so the shopper can confirm.

Surcharge fees or percentages for specific cards, funding sources (credit or debit), and currencies.

Funding source. Possible values:

• Credit
• Debit

Currency and percentage or amount of the surcharge.

Three-character ISO currency code. For example, AUD.

The maximum surcharge amount per transaction, in minor units.

Surcharge percentage per transaction. The maximum number of decimal places is two. For example, 1% or 2.27%.

Surcharge amount per transaction, in minor units.

Payment method, like eftpos_australia or mc. See the possible values.

Set to true to apply surcharges only to commercial/business cards.

The country/region of the card issuer. If used, the surcharge settings only apply to the card issued in that country/region.

Settings for device time-outs.

Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode.