Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.
To make this request, your API credential must have the following role:
For sensitive terminal settings, your API credential must have the following role:
Settings to define the header of the shopper receipt.
Settings for terminal connectivity features.
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:
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.
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:
Settings for terminal hardware features.
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 local URLs to send notifications to when using Terminal API.
One or more public URLs to send notifications to when using Terminal API.
The key you share with Adyen to secure local communications when using Terminal API.
The list of local and public URLs to send event notifications to when using Terminal API.
One or more local URLs to send event notifications to when using Terminal API.
One or more public URLs to send event notifications to when using Terminal API.
One or more URLs to send event messages to when using Terminal API.
Setting to manage the notification configuration.
Settings for offline payment features.
The maximum offline transaction amount for chip cards, in the processing currency and specified in minor units.
The maximum offline transaction amount for swiped cards, in the specified currency.
The transaction amount, in minor units.
The three-character ISO currency code.
Settings for an Oracle Payment Interface (OPI) integration.
Settings for passcodes features.
The passcode to unlock the terminal screen after a timeout.
Settings for Pay-at-table features.
Settings for payment features.
Hides the minor units for the listed ISO currency codes.
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.
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}.
Transaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.
Settings to skip signature, sign on display, or sign on receipt.
If skipSignature is false, indicates whether the shopper should provide a signature on the display (true) or on the merchant receipt (false).
Settings for standalone features.
The default currency of the standalone payment terminal as an ISO 4217 currency code.
Settings for payment surcharge features.
Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies.
Payment method, like eftpos_australia or mc. See the possible values.
Currency, and surcharge percentage or amount.
Surcharge amount per transaction, in minor units.
Three-character ISO currency code. For example, AUD.
Settings for device time-outs.
Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.
List of remote Wi-Fi profiles.
The type of Wi-Fi network. Possible values: wpa-psk, wpa2-psk, wpa-eap, wpa2-eap.
Indicates whether to automatically select the best authentication method available. Does not work on older terminal models.
Use infra for infrastructure-based networks. This applies to most networks. Use adhoc only if the communication is p2p-based between base stations.
The channel number of the Wi-Fi network. The recommended setting is 0 for automatic channel selection.
Indicates whether this is your preferred wireless network. If true, the terminal will try connecting to this network first.
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.
For eap tls. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate.
For eap tls. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY.
For eap tls. The password of the RSA key file, if that file is password-protected.
For authType wpa-eap or wpa2-eap. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server.
For eap tls. The EAP intermediate certificate.
For eap peap. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server.
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.
General Wi-Fi settings.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
The request has succeeded.
Show more Show lessSettings to define the header of the shopper receipt.
Settings for terminal connectivity features.
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:
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.
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:
Settings for terminal hardware features.
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 local URLs to send notifications to when using Terminal API.
One or more public URLs to send notifications to when using Terminal API.
The key you share with Adyen to secure local communications when using Terminal API.
The list of local and public URLs to send event notifications to when using Terminal API.
One or more local URLs to send event notifications to when using Terminal API.
One or more public URLs to send event notifications to when using Terminal API.
One or more URLs to send event messages to when using Terminal API.
Setting to manage the notification configuration.
Settings for offline payment features.
The maximum offline transaction amount for chip cards, in the processing currency and specified in minor units.
The maximum offline transaction amount for swiped cards, in the specified currency.
The transaction amount, in minor units.
The three-character ISO currency code.
Settings for an Oracle Payment Interface (OPI) integration.
Settings for passcodes features.
The passcode to unlock the terminal screen after a timeout.
Settings for Pay-at-table features.
Settings for payment features.
Hides the minor units for the listed ISO currency codes.
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.
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}.
Transaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.
Settings to skip signature, sign on display, or sign on receipt.
If skipSignature is false, indicates whether the shopper should provide a signature on the display (true) or on the merchant receipt (false).
Settings for standalone features.
The default currency of the standalone payment terminal as an ISO 4217 currency code.
Settings for payment surcharge features.
Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies.
Payment method, like eftpos_australia or mc. See the possible values.
Currency, and surcharge percentage or amount.
Surcharge amount per transaction, in minor units.
Three-character ISO currency code. For example, AUD.
Settings for device time-outs.
Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.
List of remote Wi-Fi profiles.
Indicates whether to automatically select the best authentication method available. Does not work on older terminal models.
Use infra for infrastructure-based networks. This applies to most networks. Use adhoc only if the communication is p2p-based between base stations.
The channel number of the Wi-Fi network. The recommended setting is 0 for automatic channel selection.
Indicates whether this is your preferred wireless network. If true, the terminal will try connecting to this network first.
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.
For eap tls. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate.
For eap tls. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY.
For eap tls. The password of the RSA key file, if that file is password-protected.
For authType wpa-eap or wpa2-eap. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server.
For eap tls. The EAP intermediate certificate.
For eap peap. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server.
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.
General Wi-Fi settings.