APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminal settingsTerminal settings company level

Update terminal settings

PATCH
/companies/{companyId}/terminalSettings

Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or 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 the Adyen PSP 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:

  • Management API—Terminal settings read and write

For 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.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

Request Body

application/json

cardholderReceipt?

Settings to define the header of the shopper receipt.

connectivity?

Settings for terminal connectivity features.

gratuities?array<>

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.

hardware?

Settings for terminal hardware features.

homeScreen?

Settings for the home screen.

kioskMode?

Settings for kiosk mode.

localization?
moto?
nexo?

Settings for a Terminal API integration.

offlineProcessing?

Settings for offline payment features.

opi?

Settings for an Oracle Payment Interface (OPI) integration.

passcodes?

Settings for passcodes features.

payAtTable?

Settings for Pay-at-table features.

payment?

Settings for payment features.

receiptOptions?

Generic receipt settings.

receiptPrinting?

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

refunds?

Settings for refunds.

signature?

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

standalone?

Settings for standalone features.

storeAndForward?

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.

surcharge?

Settings for payment surcharge features.

tapToPay?

Settings for Tap to Pay.

terminalInstructions?
timeouts?

Settings for device time-outs.

wifiProfiles?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/companies/string/terminalSettings" \  -H "Content-Type: application/json" \  -d '{    "wifiProfiles": {      "profiles": [        {          "authType": "wpa-eap",          "autoWifi": false,          "bssType": "infra",          "channel": 0,          "defaultProfile": true,          "eap": "peap",          "eapCaCert": {            "data": "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",            "name": "eap-peap-ca.pem"          },          "eapIdentity": "admin",          "eapIntermediateCert": {            "data": "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",            "name": "eap-peap-client.pem"          },          "eapPwd": "EAP_PEAP_PASSWORD",          "hiddenSsid": false,          "name": "Profile-eap-peap-1",          "ssid": "your-network",          "wsec": "ccmp"        },        {          "authType": "wpa-psk",          "autoWifi": false,          "bssType": "infra",          "channel": 0,          "defaultProfile": false,          "hiddenSsid": false,          "name": "Profile-guest-wifi",          "psk": "WIFI_PASSWORD",          "ssid": "your-network",          "wsec": "ccmp"        }      ],      "settings": {        "band": "2.4GHz",        "roaming": true,        "timeout": 5      }    }  }'

Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal

{  "cardholderReceipt": {    "headerForAuthorizedReceipt": "header1,header2,filler"  },  "gratuities": [    {      "currency": "EUR",      "usePredefinedTipEntries": true,      "predefinedTipEntries": [        "100",        "1%",        "5%"      ],      "allowCustomAmount": true    }  ],  "nexo": {    "displayUrls": {      "localUrls": [        {          "password": "BASIC_AUTH_PASSWORD",          "url": "https://your-display-notifications-endpoint.com",          "username": "BASIC_AUTH_USERNAME"        }      ]    },    "encryptionKey": {      "identifier": "KEY_IDENTIFIER",      "passphrase": "KEY_PASSPHRASE",      "version": 1    },    "eventUrls": {      "eventPublicUrls": [        {          "password": "BASIC_AUTH_PASSWORD",          "url": "https://your-event-notifications-endpoint.com",          "username": "BASIC_AUTH_USERNAME"        }      ]    }  },  "opi": {    "enablePayAtTable": true,    "payAtTableStoreNumber": "1",    "payAtTableURL": "https:/your-pay-at-table-endpoint.com"  },  "offlineProcessing": {    "chipFloorLimit": 0  },  "receiptOptions": {    "qrCodeData": "http://www.example.com/order/${pspreference}/${merchantreference}"  },  "receiptPrinting": {    "shopperApproved": true,    "shopperRefused": true,    "shopperCancelled": true,    "shopperRefundApproved": true,    "shopperRefundRefused": true,    "shopperVoid": true  },  "signature": {    "askSignatureOnScreen": true,    "skipSignature": false,    "deviceName": "Amsterdam-236203386"  },  "wifiProfiles": {    "profiles": [      {        "authType": "wpa-eap",        "autoWifi": false,        "bssType": "infra",        "channel": 0,        "defaultProfile": true,        "eap": "peap",        "eapCaCert": {          "data": "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",          "name": "eap-peap-ca.pem"        },        "eapIdentity": "admin",        "eapIntermediateCert": {          "data": "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",          "name": "eap-peap-client.pem"        },        "eapPwd": "EAP_PEAP_PASSWORD",        "hiddenSsid": false,        "name": "Profile-eap-peap-1",        "ssid": "your-network",        "wsec": "ccmp"      },      {        "authType": "wpa-psk",        "autoWifi": false,        "bssType": "infra",        "channel": 0,        "defaultProfile": false,        "hiddenSsid": false,        "name": "Profile-guest-wifi",        "psk": "WIFI_PASSWORD",        "ssid": "your-network",        "wsec": "ccmp"      }    ],    "settings": {      "band": "2.4GHz",      "roaming": true,      "timeout": 5    }  },  "timeouts": {    "fromActiveToSleep": 30  },  "hardware": {    "displayMaximumBackLight": 75  }}

Get terminal settings GET

Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * 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).

Get the terminal logo GET

Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings 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).