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

Get terminal settings

GET
/terminals/{terminalId}/terminalSettings

Returns the settings that are configured for the payment terminal identified in the path.

To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • 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

terminalId*string

The unique identifier of the payment terminal.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/terminals/string/terminalSettings"

Example response when getting the settings of a payment 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"        }      ]    },    "notification": {      "showButton": true    }  },  "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-psk",        "autoWifi": false,        "bssType": "infra",        "channel": 0,        "defaultProfile": true,        "hiddenSsid": false,        "name": "Guest Wi-Fi",        "psk": "4R8R2R3V456X",        "ssid": "G470P37660D4G",        "wsec": "ccmp"      }    ],    "settings": {      "band": "All",      "roaming": true    }  },  "timeouts": {    "fromActiveToSleep": 30  },  "hardware": {    "displayMaximumBackLight": 75,    "restartHour": 5  },  "passcodes": {    "adminMenuPin": "1234",    "txMenuPin": "1234",    "refundPin": "123456",    "screenLockPin": "1234"  },  "connectivity": {    "simcardStatus": "INVENTORY"  },  "storeAndForward": {    "maxAmount": [      {        "amount": 10000,        "currencyCode": "EUR"      }    ],    "maxPayments": 10,    "supportedCardTypes": {      "credit": true,      "debit": true,      "deferredDebit": true,      "prepaid": true,      "unknown": false    }  },  "terminalInstructions": {    "adyenAppRestart": true  }}

Update the logo PATCH

Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. 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 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).

Update terminal settings PATCH

Updates the settings that are configured for the payment terminal identified in the path. * 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).