--- title: "Update terminal settings" method: PATCH path: "/merchants/{merchantId}/stores/{reference}/terminalSettings" tags: ["Terminal settings - store level"] --- # Update terminal settings `PATCH /merchants/{merchantId}/stores/{reference}/terminalSettings` 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 change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment). ## Path parameters - `merchantId` string, required - `reference` string, required ## Request body - TerminalSettings - `cardholderReceipt` CardholderReceipt - `headerForAuthorizedReceipt` string — The structure of the header to show on the shopper receipt. You can define the order of one or two header lines and blank lines. For example, **header1,header2,filler**. The text of the header lines is defined in the Customer Area under **In-person payments** > **Terminal settings** > **Receipts** in the **Receipt lines** block. - `connectivity` Connectivity - `simcardStatus` 'ACTIVATED' | 'INVENTORY' — 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. - `terminalIPAddressURL` EventUrl - `eventLocalUrls` Url[] — One or more local URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `eventPublicUrls` Url[] — One or more public URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `dcc` Dcc - `enableDcc` boolean — Enable Dynamic Currency Conversion (DCC). When you enable DCC, you are responsible for complying with [DCC receipt requirements and terms of use](https://help.adyen.com/en_US/knowledge/in-person-payments/terminal-features/dynamic-currency-conversion-dcc-rules-regulations). - `gratuities` Gratuity[], nullable — 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. - `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` string[] — 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](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip. - `usePredefinedTipEntries` boolean — Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**). - `hardware` Hardware - `displayMaximumBackLight` integer — The brightness of the display when the terminal is being used, expressed as a percentage. - `resetTotalsHour` integer — 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. - `restartHour` integer — 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. - `homeScreen` HomeScreenSettings - `hideNavigationBar` boolean — Hide/show the navigation bar. - `showPaymentsMenu` boolean — Show/hide the payments menu. - `showSettingsMenu` boolean — Show/hide the settings menu. - `kioskMode` KioskModeSettings - `allowedAppsInKioskMode` string[] — List of package names for apps allowed to run in kiosk mode. - `kioskAppOnStartup` string — The package name of the app to launch on startup. This must be one of the apps included in `allowedAppsInKioskMode`. - `localization` Localization - `language` string — Language of the terminal. - `secondaryLanguage` string — Secondary language of the terminal. - `timezone` string — The time zone of the terminal. - `moto` Moto - `enableMoto` boolean — Enable MOTO transactions. - `maxAmount` integer — The maximum amount for MOTO transactions. You need to set the currency for this amount using the [`standalone.currencyCode`](https://docs.adyen.com/api-explorer/Management/1/patch/companies/(companyId)/terminalSettings#request-standalone-currencyCode) parameter. Do not enable standalone, unless you are using a standalone solution. - `nexo` Nexo - `displayUrls` NotificationUrl - `localUrls` Url[] — One or more local URLs to send notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `publicUrls` Url[] — One or more public URLs to send notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `encryptionKey` Key - `identifier` string — The unique identifier of the shared key. - `passphrase` string — The secure passphrase to protect the shared key. Must consist of: * At least 12 characters. * At least 1 uppercase letter: `[A-Z]`. * At least 1 lowercase letter: `[a-z]`. * At least 1 digit: `[0-9]`. * At least 1 special character. Limited to the following: `~`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `_`, `+`, `=`, `}`, `{`, `]`, `[`, `;`, `:`, `?`, `.`, `,`, `>`, `<`. - `version` integer — The version number of the shared key. - `eventUrls` EventUrl - `eventLocalUrls` Url[] — One or more local URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `eventPublicUrls` Url[] — One or more public URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `nexoEventUrls` string[] — One or more URLs to send event messages to when using Terminal API. - `notification` Notification - `category` 'SaleWakeUp' | 'KeyPressed' | '' — The type of event notification sent when you select the notification button. - `details` string — 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. - `enabled` boolean — 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. - `showButton` boolean — Shows or hides the event notification button on the screen of terminal models that have a keypad. - `title` string — The name of the notification button on the terminal screen. - `offlineProcessing` OfflineProcessing - `chipFloorLimit` integer — The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `opi` Opi - `enablePayAtTable` boolean — Indicates if Pay at table is enabled. - `payAtTableStoreNumber` string — The store number to use for Pay at Table. - `payAtTableURL` string — The URL and port number used for Pay at Table communication. - `passcodes` Passcodes - `adminMenuPin` string — The passcode for the Admin menu and the Settings menu. - `refundPin` string — The passcode for referenced and unreferenced refunds on standalone terminals. - `screenLockPin` string — The passcode to unlock the terminal screen after a timeout. - `txMenuPin` string — The passcode for the Transactions menu. - `payAtTable` PayAtTable - `authenticationMethod` 'MAGSWIPE' | 'MKE' — Allowed authentication methods: Magswipe, Manual Entry. - `enablePayAtTable` boolean — Enable Pay at table. - `paymentInstrument` 'Cash' | 'Card', nullable — Sets the allowed payment instrument for Pay at table transactions. Can be: **cash** or **card**. If not set, the terminal presents both options. - `payment` Payment - `contactlessCurrency` string — The default currency for contactless payments on the payment terminal, in three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code format. Contact Adyen before you update this setting for the first time. To enable you to change the contactless currency, we first need to check if you meet the compliance requirements. - `hideMinorUnitsInCurrencies` string[] — Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217). - `receiptOptions` ReceiptOptions - `headerLine1` string — The text of the first header line to be shown on the receipt. - `headerLine2` string — The text of the second header line to be shown on the receipt. - `logo` string — 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. - `promptBeforePrinting` boolean — Indicates whether a screen appears asking if you want to print the shopper receipt. - `qrCodeData` string — 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}**. - `receiptPrinting` ReceiptPrinting - `merchantApproved` boolean — Print a merchant receipt when the payment is approved. - `merchantCancelled` boolean — Print a merchant receipt when the transaction is cancelled. - `merchantCaptureApproved` boolean — Print a merchant receipt when capturing the payment is approved. - `merchantCaptureRefused` boolean — Print a merchant receipt when capturing the payment is refused. - `merchantRefundApproved` boolean — Print a merchant receipt when the refund is approved. - `merchantRefundRefused` boolean — Print a merchant receipt when the refund is refused. - `merchantRefused` boolean — Print a merchant receipt when the payment is refused. - `merchantVoid` boolean — Print a merchant receipt when a previous transaction is voided. - `shopperApproved` boolean — Print a shopper receipt when the payment is approved. - `shopperCancelled` boolean — Print a shopper receipt when the transaction is cancelled. - `shopperCaptureApproved` boolean — Print a shopper receipt when capturing the payment is approved. - `shopperCaptureRefused` boolean — Print a shopper receipt when capturing the payment is refused. - `shopperRefundApproved` boolean — Print a shopper receipt when the refund is approved. - `shopperRefundRefused` boolean — Print a shopper receipt when the refund is refused. - `shopperRefused` boolean — Print a shopper receipt when the payment is refused. - `shopperVoid` boolean — Print a shopper receipt when a previous transaction is voided. - `refunds` Refunds - `referenced` Referenced - `enableStandaloneRefunds` boolean — Indicates whether referenced refunds are enabled on the standalone terminal. - `unreferenced` Unreferenced - `enableUnreferencedRefunds` boolean — Indicates whether unreferenced refunds are enabled on the terminal. > You're fully liable for losses resulting from fraudulent or duplicate unreferenced refunds. We recommend that you [set an unreferenced refund limit and a refund delay](https://docs.adyen.com/point-of-sale/basic-tapi-integration/refund-payment/unreferenced/#risk-with-unreferenced-refunds) to reduce this risk. - `signature` Signature - `askSignatureOnScreen` boolean — If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**). - `deviceName` string — Name that identifies the terminal. - `deviceSlogan` string — Slogan shown on the start screen of the device. - `skipSignature` boolean — 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. - `standalone` Standalone - `currencyCode` string — The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `enableGratuities` boolean — Indicates whether the tipping options specified in `gratuities` are enabled on the standalone terminal. - `enableStandalone` boolean — Enable standalone mode. - `storeAndForward` StoreAndForward - `maxAmount` MinorUnitsMonetaryValue[] — The maximum amount that the terminal accepts for a single store-and-forward payment. - `amount` integer — The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `currencyCode` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `maxPayments` integer — The maximum number of store-and-forward transactions per terminal that you can process while offline. - `supportedCardTypes` SupportedCardTypes - `credit` boolean — Set to **true** to accept credit cards. - `debit` boolean — Set to **true** to accept debit cards. - `deferredDebit` boolean — Set to **true** to accept cards that allow deferred debit. - `prepaid` boolean — Set to **true** to accept prepaid cards. - `unknown` boolean — Set to **true** to accept card types for which the terminal can't determine the funding source while offline. - `surcharge` Surcharge - `askConfirmation` boolean — Show the surcharge details on the terminal, so the shopper can confirm. - `configurations` Configuration[] — Surcharge fees or percentages for specific cards, funding sources (credit or debit), and currencies. - `brand` string, required — Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). - `commercial` boolean — Set to **true** to apply surcharges only to commercial/business cards. - `country` string[] — The country/region of the card issuer. If used, the surcharge settings only apply to the card issued in that country/region. - `currencies` Currency[], required — Currency and percentage or amount of the surcharge. - `amount` integer — Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `currencyCode` string, required — Three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **AUD**. - `maxAmount` integer — The maximum surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `percentage` number, double — Surcharge percentage per transaction. The maximum number of decimal places is two. For example, **1%** or **2.27%**. - `sources` string[] — Funding source. Possible values: * **Credit** * **Debit** - `disclosureOnPresentCard` boolean — Show the maximum surcharge rate to the shopper on the present card screen before they tap. - `excludeGratuityFromSurcharge` boolean — Exclude the tip amount from the surcharge calculation. - `tapToPay` TapToPay - `merchantDisplayName` string — The text shown on the screen during the Tap to Pay transaction. - `terminalInstructions` TerminalInstructions - `adyenAppRestart` boolean — Indicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated. - `timeouts` Timeouts - `fromActiveToSleep` integer — Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode. - `wifiProfiles` WifiProfiles - `profiles` Profile[] — List of remote Wi-Fi profiles. - `authType` string, required — The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**. - `autoWifi` boolean — Indicates whether to automatically select the best authentication method available. Does not work on older terminal models. - `bssType` string, required — Use **infra** for infrastructure-based networks. This applies to most networks. Use **adhoc** only if the communication is p2p-based between base stations. - `channel` integer — The channel number of the Wi-Fi network. The recommended setting is **0** for automatic channel selection. - `defaultProfile` boolean — Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first. - `domainSuffix` string — Specifies the server domain name for EAP-TLS and EAP-PEAP WiFi profiles on Android 11 and above. - `eap` string — For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast** - `eapCaCert` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapClientCert` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapClientKey` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapClientPwd` string — For `eap` **tls**. The password of the RSA key file, if that file is password-protected. - `eapIdentity` string — For `authType` **wpa-eap** or **wpa2-eap**. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server. - `eapIntermediateCert` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapPwd` string — For `eap` **peap**. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server. - `hiddenSsid` boolean — 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. - `name` string — Your name for the Wi-Fi profile. - `psk` string — For `authType` **wpa-psk or **wpa2-psk**. The password to the wireless network. - `ssid` string, required — The name of the wireless network. - `wsec` string, required — The type of encryption. Possible values: **auto**, **ccmp** (recommended), **tkip** - `settings` Settings - `band` string — The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz. - `roaming` boolean — Indicates whether roaming is enabled on the terminals. - `timeout` integer — The connection time-out in seconds. Minimum value: 0. ## Response `200` OK - the request has succeeded. - TerminalSettings - `cardholderReceipt` CardholderReceipt - `headerForAuthorizedReceipt` string — The structure of the header to show on the shopper receipt. You can define the order of one or two header lines and blank lines. For example, **header1,header2,filler**. The text of the header lines is defined in the Customer Area under **In-person payments** > **Terminal settings** > **Receipts** in the **Receipt lines** block. - `connectivity` Connectivity - `simcardStatus` 'ACTIVATED' | 'INVENTORY' — 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. - `terminalIPAddressURL` EventUrl - `eventLocalUrls` Url[] — One or more local URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `eventPublicUrls` Url[] — One or more public URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `dcc` Dcc - `enableDcc` boolean — Enable Dynamic Currency Conversion (DCC). When you enable DCC, you are responsible for complying with [DCC receipt requirements and terms of use](https://help.adyen.com/en_US/knowledge/in-person-payments/terminal-features/dynamic-currency-conversion-dcc-rules-regulations). - `gratuities` Gratuity[], nullable — 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. - `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` string[] — 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](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip. - `usePredefinedTipEntries` boolean — Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**). - `hardware` Hardware - `displayMaximumBackLight` integer — The brightness of the display when the terminal is being used, expressed as a percentage. - `resetTotalsHour` integer — 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. - `restartHour` integer — 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. - `homeScreen` HomeScreenSettings - `hideNavigationBar` boolean — Hide/show the navigation bar. - `showPaymentsMenu` boolean — Show/hide the payments menu. - `showSettingsMenu` boolean — Show/hide the settings menu. - `kioskMode` KioskModeSettings - `allowedAppsInKioskMode` string[] — List of package names for apps allowed to run in kiosk mode. - `kioskAppOnStartup` string — The package name of the app to launch on startup. This must be one of the apps included in `allowedAppsInKioskMode`. - `localization` Localization - `language` string — Language of the terminal. - `secondaryLanguage` string — Secondary language of the terminal. - `timezone` string — The time zone of the terminal. - `moto` Moto - `enableMoto` boolean — Enable MOTO transactions. - `maxAmount` integer — The maximum amount for MOTO transactions. You need to set the currency for this amount using the [`standalone.currencyCode`](https://docs.adyen.com/api-explorer/Management/1/patch/companies/(companyId)/terminalSettings#request-standalone-currencyCode) parameter. Do not enable standalone, unless you are using a standalone solution. - `nexo` Nexo - `displayUrls` NotificationUrl - `localUrls` Url[] — One or more local URLs to send notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `publicUrls` Url[] — One or more public URLs to send notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `encryptionKey` Key - `identifier` string — The unique identifier of the shared key. - `passphrase` string — The secure passphrase to protect the shared key. Must consist of: * At least 12 characters. * At least 1 uppercase letter: `[A-Z]`. * At least 1 lowercase letter: `[a-z]`. * At least 1 digit: `[0-9]`. * At least 1 special character. Limited to the following: `~`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `_`, `+`, `=`, `}`, `{`, `]`, `[`, `;`, `:`, `?`, `.`, `,`, `>`, `<`. - `version` integer — The version number of the shared key. - `eventUrls` EventUrl - `eventLocalUrls` Url[] — One or more local URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `eventPublicUrls` Url[] — One or more public URLs to send event notifications to when using Terminal API. - `encrypted` boolean — Indicates if the message sent to this URL should be encrypted. - `password` string — The password for authentication of the notifications. - `url` string — The URL in the format: http(s)://domain.com. - `username` string — The username for authentication of the notifications. - `nexoEventUrls` string[] — One or more URLs to send event messages to when using Terminal API. - `notification` Notification - `category` 'SaleWakeUp' | 'KeyPressed' | '' — The type of event notification sent when you select the notification button. - `details` string — 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. - `enabled` boolean — 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. - `showButton` boolean — Shows or hides the event notification button on the screen of terminal models that have a keypad. - `title` string — The name of the notification button on the terminal screen. - `offlineProcessing` OfflineProcessing - `chipFloorLimit` integer — The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `opi` Opi - `enablePayAtTable` boolean — Indicates if Pay at table is enabled. - `payAtTableStoreNumber` string — The store number to use for Pay at Table. - `payAtTableURL` string — The URL and port number used for Pay at Table communication. - `passcodes` Passcodes - `adminMenuPin` string — The passcode for the Admin menu and the Settings menu. - `refundPin` string — The passcode for referenced and unreferenced refunds on standalone terminals. - `screenLockPin` string — The passcode to unlock the terminal screen after a timeout. - `txMenuPin` string — The passcode for the Transactions menu. - `payAtTable` PayAtTable - `authenticationMethod` 'MAGSWIPE' | 'MKE' — Allowed authentication methods: Magswipe, Manual Entry. - `enablePayAtTable` boolean — Enable Pay at table. - `paymentInstrument` 'Cash' | 'Card', nullable — Sets the allowed payment instrument for Pay at table transactions. Can be: **cash** or **card**. If not set, the terminal presents both options. - `payment` Payment - `contactlessCurrency` string — The default currency for contactless payments on the payment terminal, in three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code format. Contact Adyen before you update this setting for the first time. To enable you to change the contactless currency, we first need to check if you meet the compliance requirements. - `hideMinorUnitsInCurrencies` string[] — Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217). - `receiptOptions` ReceiptOptions - `headerLine1` string — The text of the first header line to be shown on the receipt. - `headerLine2` string — The text of the second header line to be shown on the receipt. - `logo` string — 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. - `promptBeforePrinting` boolean — Indicates whether a screen appears asking if you want to print the shopper receipt. - `qrCodeData` string — 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}**. - `receiptPrinting` ReceiptPrinting - `merchantApproved` boolean — Print a merchant receipt when the payment is approved. - `merchantCancelled` boolean — Print a merchant receipt when the transaction is cancelled. - `merchantCaptureApproved` boolean — Print a merchant receipt when capturing the payment is approved. - `merchantCaptureRefused` boolean — Print a merchant receipt when capturing the payment is refused. - `merchantRefundApproved` boolean — Print a merchant receipt when the refund is approved. - `merchantRefundRefused` boolean — Print a merchant receipt when the refund is refused. - `merchantRefused` boolean — Print a merchant receipt when the payment is refused. - `merchantVoid` boolean — Print a merchant receipt when a previous transaction is voided. - `shopperApproved` boolean — Print a shopper receipt when the payment is approved. - `shopperCancelled` boolean — Print a shopper receipt when the transaction is cancelled. - `shopperCaptureApproved` boolean — Print a shopper receipt when capturing the payment is approved. - `shopperCaptureRefused` boolean — Print a shopper receipt when capturing the payment is refused. - `shopperRefundApproved` boolean — Print a shopper receipt when the refund is approved. - `shopperRefundRefused` boolean — Print a shopper receipt when the refund is refused. - `shopperRefused` boolean — Print a shopper receipt when the payment is refused. - `shopperVoid` boolean — Print a shopper receipt when a previous transaction is voided. - `refunds` Refunds - `referenced` Referenced - `enableStandaloneRefunds` boolean — Indicates whether referenced refunds are enabled on the standalone terminal. - `unreferenced` Unreferenced - `enableUnreferencedRefunds` boolean — Indicates whether unreferenced refunds are enabled on the terminal. > You're fully liable for losses resulting from fraudulent or duplicate unreferenced refunds. We recommend that you [set an unreferenced refund limit and a refund delay](https://docs.adyen.com/point-of-sale/basic-tapi-integration/refund-payment/unreferenced/#risk-with-unreferenced-refunds) to reduce this risk. - `signature` Signature - `askSignatureOnScreen` boolean — If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**). - `deviceName` string — Name that identifies the terminal. - `deviceSlogan` string — Slogan shown on the start screen of the device. - `skipSignature` boolean — 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. - `standalone` Standalone - `currencyCode` string — The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `enableGratuities` boolean — Indicates whether the tipping options specified in `gratuities` are enabled on the standalone terminal. - `enableStandalone` boolean — Enable standalone mode. - `storeAndForward` StoreAndForward - `maxAmount` MinorUnitsMonetaryValue[] — The maximum amount that the terminal accepts for a single store-and-forward payment. - `amount` integer — The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `currencyCode` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - `maxPayments` integer — The maximum number of store-and-forward transactions per terminal that you can process while offline. - `supportedCardTypes` SupportedCardTypes - `credit` boolean — Set to **true** to accept credit cards. - `debit` boolean — Set to **true** to accept debit cards. - `deferredDebit` boolean — Set to **true** to accept cards that allow deferred debit. - `prepaid` boolean — Set to **true** to accept prepaid cards. - `unknown` boolean — Set to **true** to accept card types for which the terminal can't determine the funding source while offline. - `surcharge` Surcharge - `askConfirmation` boolean — Show the surcharge details on the terminal, so the shopper can confirm. - `configurations` Configuration[] — Surcharge fees or percentages for specific cards, funding sources (credit or debit), and currencies. - `brand` string, required — Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). - `commercial` boolean — Set to **true** to apply surcharges only to commercial/business cards. - `country` string[] — The country/region of the card issuer. If used, the surcharge settings only apply to the card issued in that country/region. - `currencies` Currency[], required — Currency and percentage or amount of the surcharge. - `amount` integer — Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `currencyCode` string, required — Three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **AUD**. - `maxAmount` integer — The maximum surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `percentage` number, double — Surcharge percentage per transaction. The maximum number of decimal places is two. For example, **1%** or **2.27%**. - `sources` string[] — Funding source. Possible values: * **Credit** * **Debit** - `disclosureOnPresentCard` boolean — Show the maximum surcharge rate to the shopper on the present card screen before they tap. - `excludeGratuityFromSurcharge` boolean — Exclude the tip amount from the surcharge calculation. - `tapToPay` TapToPay - `merchantDisplayName` string — The text shown on the screen during the Tap to Pay transaction. - `terminalInstructions` TerminalInstructions - `adyenAppRestart` boolean — Indicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated. - `timeouts` Timeouts - `fromActiveToSleep` integer — Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode. - `wifiProfiles` WifiProfiles - `profiles` Profile[] — List of remote Wi-Fi profiles. - `authType` string, required — The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**. - `autoWifi` boolean — Indicates whether to automatically select the best authentication method available. Does not work on older terminal models. - `bssType` string, required — Use **infra** for infrastructure-based networks. This applies to most networks. Use **adhoc** only if the communication is p2p-based between base stations. - `channel` integer — The channel number of the Wi-Fi network. The recommended setting is **0** for automatic channel selection. - `defaultProfile` boolean — Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first. - `domainSuffix` string — Specifies the server domain name for EAP-TLS and EAP-PEAP WiFi profiles on Android 11 and above. - `eap` string — For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast** - `eapCaCert` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapClientCert` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapClientKey` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapClientPwd` string — For `eap` **tls**. The password of the RSA key file, if that file is password-protected. - `eapIdentity` string — For `authType` **wpa-eap** or **wpa2-eap**. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server. - `eapIntermediateCert` File - `data` string, required — The certificate content converted to a Base64-encoded string. - `name` string, required — The name of the certificate. Must be unique across Wi-Fi profiles. - `eapPwd` string — For `eap` **peap**. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server. - `hiddenSsid` boolean — 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. - `name` string — Your name for the Wi-Fi profile. - `psk` string — For `authType` **wpa-psk or **wpa2-psk**. The password to the wireless network. - `ssid` string, required — The name of the wireless network. - `wsec` string, required — The type of encryption. Possible values: **auto**, **ccmp** (recommended), **tkip** - `settings` Settings - `band` string — The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz. - `roaming` boolean — Indicates whether roaming is enabled on the terminals. - `timeout` integer — The connection time-out in seconds. Minimum value: 0. ## Other responses - `204` — No Content - the request has been successfully processed, but there is no additional content. - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `500` — Internal Server Error - the server could not process the request. --- [API](https://skmtc.net/adyen/apis/management-api.md) · [All operations](https://skmtc.net/adyen/apis/management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/management-api/versions/1089ade06e17/schema)