Get terminal settings
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:
- 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
Path Parameters
The unique identifier of the company account.
Response parameters
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.
HTTP Responses
200 - OK
The request has succeeded.
Show moreShow lesscardholderReceiptobjectSettings to define the header of the shopper receipt.
headerForAuthorizedReceiptstringA 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
connectivityobjectSettings for terminal connectivity features.
simcardStatusstringIndicates 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.
terminalIPAddressURLobjectThe list of local and public URLs to send notifications to when using local integrations.
eventLocalUrlsarray[object]One or more local URLs to send event notifications to when using Terminal API.
encryptedbooleanIndicates if the message sent to this URL should be encrypted.
passwordstringThe password for authentication of the notifications.
urlstringThe URL in the format: http(s)://domain.com.
usernamestringThe username for authentication of the notifications.
eventPublicUrlsarray[object]One or more public URLs to send event notifications to when using Terminal API.
encryptedbooleanIndicates if the message sent to this URL should be encrypted.
passwordstringThe password for authentication of the notifications.
urlstringThe URL in the format: http(s)://domain.com.
usernamestringThe username for authentication of the notifications.
gratuitiesarray[object]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.
allowCustomAmountbooleanIndicates 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.currencystringThe currency that the tipping settings apply to.
predefinedTipEntriesarray[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. Example: 500 for a EUR 5 tip.
usePredefinedTipEntriesbooleanIndicates whether the terminal shows a prompt to enter a tip (false), or predefined tipping options to choose from (true).
hardwareobjectSettings for terminal hardware features.
displayMaximumBackLightintegerThe brightness of the display when the terminal is being used, expressed as a percentage.
resetTotalsHourintegerThe 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.
restartHourintegerThe 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.
localizationobjectSettings for localization.
languagestringLanguage of the terminal.
secondaryLanguagestringSecondary language of the terminal.
timezonestringThe time zone of the terminal.
nexoobjectSettings for a Terminal API integration.
displayUrlsobjectThe list of local and public URLs to send display notifications to when using Terminal API.
localUrlsarray[object]One or more local URLs to send notifications to when using Terminal API.
encryptedbooleanIndicates if the message sent to this URL should be encrypted.
passwordstringThe password for authentication of the notifications.
urlstringThe URL in the format: http(s)://domain.com.
usernamestringThe username for authentication of the notifications.
publicUrlsarray[object]One or more public URLs to send notifications to when using Terminal API.
encryptedbooleanIndicates if the message sent to this URL should be encrypted.
passwordstringThe password for authentication of the notifications.
urlstringThe URL in the format: http(s)://domain.com.
usernamestringThe username for authentication of the notifications.
encryptionKeyobjectThe key you share with Adyen to secure local communications when using Terminal API.
identifierstringThe unique identifier of the shared key.
passphrasestringThe secure passphrase to protect the shared key.
versionintegerThe version number of the shared key.
eventUrlsobjectThe list of local and public URLs to send event notifications to when using Terminal API.
eventLocalUrlsarray[object]One or more local URLs to send event notifications to when using Terminal API.
encryptedbooleanIndicates if the message sent to this URL should be encrypted.
passwordstringThe password for authentication of the notifications.
urlstringThe URL in the format: http(s)://domain.com.
usernamestringThe username for authentication of the notifications.
eventPublicUrlsarray[object]One or more public URLs to send event notifications to when using Terminal API.
encryptedbooleanIndicates if the message sent to this URL should be encrypted.
passwordstringThe password for authentication of the notifications.
urlstringThe URL in the format: http(s)://domain.com.
usernamestringThe username for authentication of the notifications.
nexoEventUrlsarray[string]Deprecated in version 1Use
eventUrls
instead.One or more URLs to send event messages to when using Terminal API.
notificationobjectConfigures sending event notifications by pressing a button on a terminal, for example used for pay-at-table.
categorystringThe type of event notification sent when you select the notification button.
detailsstringThe 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.
enabledbooleanEnables 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.
showButtonbooleanShows or hides the event notification button on the screen of terminal models that have a keypad.
titlestringThe name of the notification button on the terminal screen.
offlineProcessingobjectSettings for offline payment features.
chipFloorLimitintegerThe maximum offline transaction amount for chip cards, in the processing currency and specified in minor units.
offlineSwipeLimitsarray[object]The maximum offline transaction amount for swiped cards, in the specified currency.
amountintegerThe transaction amount, in minor units.
currencyCodestringThe three-character ISO currency code.
opiobjectSettings for an Oracle Payment Interface (OPI) integration.
enablePayAtTablebooleanIndicates if Pay at table is enabled.
payAtTableStoreNumberstringThe store number to use for Pay at Table.
payAtTableURLstringThe URL and port number used for Pay at Table communication.
passcodesobjectSettings for passcodes features.
adminMenuPinstringMax length: 6The passcode for the Admin menu and the Settings menu.
refundPinstringMax length: 6The passcode for referenced and unreferenced refunds on standalone terminals.
screenLockPinstringMin length: 4Max length: 6The passcode to unlock the terminal screen after a timeout.
txMenuPinstringMax length: 6The passcode for the Transactions menu.
payAtTableobjectSettings for Pay-at-table features.
authenticationMethodstringAllowed authentication methods: Magswipe, Manual Entry.
enablePayAtTablebooleanEnable Pay at table.
paymentInstrumentstringSets the allowed payment instrument for Pay at table transactions. Can be: cash or card. If not set, the terminal presents both options.
paymentobjectSettings for payment features.
contactlessCurrencystringMin length: 3Max length: 3The default currency for contactless payments on the payment terminal, as the three-letter ISO 4217 currency code.
hideMinorUnitsInCurrenciesarray[string]Hides the minor units for the listed ISO currency codes.
receiptOptionsobjectGeneric receipt settings.
logostringMax length: 350000The 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.
promptBeforePrintingbooleanIndicates whether a screen appears asking if you want to print the shopper receipt.
qrCodeDatastringData 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}.
receiptPrintingobjectTransaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.
merchantApprovedbooleanPrint a merchant receipt when the payment is approved.
merchantCancelledbooleanPrint a merchant receipt when the transaction is cancelled.
merchantCaptureApprovedbooleanPrint a merchant receipt when capturing the payment is approved.
merchantCaptureRefusedbooleanPrint a merchant receipt when capturing the payment is refused.
merchantRefundApprovedbooleanPrint a merchant receipt when the refund is approved.
merchantRefundRefusedbooleanPrint a merchant receipt when the refund is refused.
merchantRefusedbooleanPrint a merchant receipt when the payment is refused.
merchantVoidbooleanPrint a merchant receipt when a previous transaction is voided.
shopperApprovedbooleanPrint a shopper receipt when the payment is approved.
shopperCancelledbooleanPrint a shopper receipt when the transaction is cancelled.
shopperCaptureApprovedbooleanPrint a shopper receipt when capturing the payment is approved.
shopperCaptureRefusedbooleanPrint a shopper receipt when capturing the payment is refused.
shopperRefundApprovedbooleanPrint a shopper receipt when the refund is approved.
shopperRefundRefusedbooleanPrint a shopper receipt when the refund is refused.
shopperRefusedbooleanPrint a shopper receipt when the payment is refused.
shopperVoidbooleanPrint a shopper receipt when a previous transaction is voided.
refundsobjectSettings for refunds.
referencedobjectSettings for referenced refunds.
enableStandaloneRefundsbooleanIndicates whether referenced refunds are enabled on the standalone terminal.
signatureobjectSettings to skip signature, sign on display, or sign on receipt.
askSignatureOnScreenbooleanIf
skipSignature
is false, indicates whether the shopper should provide a signature on the display (true) or on the merchant receipt (false).deviceNamestringName that identifies the terminal.
deviceSloganstringMax length: 50Slogan shown on the start screen of the device.
skipSignaturebooleanSkip 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.
standaloneobjectSettings for standalone features.
currencyCodestringMin length: 3Max length: 3The default currency of the standalone payment terminal as an ISO 4217 currency code.
enableStandalonebooleanEnable standalone mode.
storeAndForwardobjectSettings for store-and-forward offline payments. The
maxAmount
,maxPayments
, andsupportedCardTypes
parameters must be configured, either in the request or inherited from a higher level in your account structure.maxAmountarray[object]The maximum amount that the terminal accepts for a single store-and-forward payment.
amountintegerThe transaction amount, in minor units.
currencyCodestringThe three-character ISO currency code.
maxPaymentsintegerThe maximum number of store-and-forward transactions per terminal that you can process while offline.
supportedCardTypesobjectThe type of card for which the terminal accepts store-and-forward payments. You can specify multiple card types.
creditbooleanSet to true to accept credit cards.
debitbooleanSet to true to accept debit cards.
deferredDebitbooleanSet to true to accept cards that allow deferred debit.
prepaidbooleanSet to true to accept prepaid cards.
unknownbooleanSet to true to accept card types for which the terminal can't determine the funding source while offline.
surchargeobjectSettings for payment surcharge features.
askConfirmationbooleanShow the surcharge details on the terminal, so the shopper can confirm.
configurationsarray[object]Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies.
brandstringPayment method, like eftpos_australia or mc. See the possible values.
countryarray[string]Countries, to filter different surcharge amounts for domestic or international cards.
currenciesarray[object]Currency, and surcharge percentage or amount.
amountintegerSurcharge amount per transaction, in minor units.
currencyCodestringThree-character ISO currency code. For example, AUD.
percentagenumberSurcharge percentage per transaction. The maximum number of decimal places is two. For example, 1% or 2.27%.
sourcesarray[string]Funding source. Possible values:
- Credit
- Debit
tapToPayobjectSettings for Tap to Pay.
merchantDisplayNamestringThe text shown on the screen during the Tap to Pay transaction.
terminalInstructionsobjectSettings to define the behaviour of the payment terminal.
adyenAppRestartbooleanIndicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated.
timeoutsobjectSettings for device time-outs.
fromActiveToSleepintegerIndicates the number of seconds of inactivity after which the terminal display goes into sleep mode.
wifiProfilesobjectRemote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.
profilesarray[object]List of remote Wi-Fi profiles.
authTypestringThe type of Wi-Fi network. Possible values: wpa-psk, wpa2-psk, wpa-eap, wpa2-eap.
autoWifibooleanIndicates whether to automatically select the best authentication method available. Does not work on older terminal models.
bssTypestringUse infra for infrastructure-based networks. This applies to most networks. Use adhoc only if the communication is p2p-based between base stations.
channelintegerThe channel number of the Wi-Fi network. The recommended setting is 0 for automatic channel selection.
defaultProfilebooleanIndicates whether this is your preferred wireless network. If true, the terminal will try connecting to this network first.
eapstringFor
authType
wpa-eap or wpa2-eap. Possible values: tls, peap, leap, fasteapCaCertobjectFor
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.datastringThe certificate content converted to a Base64-encoded string.
namestringThe name of the certificate. Must be unique across Wi-Fi profiles.
eapClientCertobjectFor
eap
tls. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate.datastringThe certificate content converted to a Base64-encoded string.
namestringThe name of the certificate. Must be unique across Wi-Fi profiles.
eapClientKeyobjectFor
eap
tls. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY.datastringThe certificate content converted to a Base64-encoded string.
namestringThe name of the certificate. Must be unique across Wi-Fi profiles.
eapClientPwdstringFor
eap
tls. The password of the RSA key file, if that file is password-protected.eapIdentitystringFor
authType
wpa-eap or wpa2-eap. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server.eapIntermediateCertobjectFor
eap
tls. The EAP intermediate certificate.datastringThe certificate content converted to a Base64-encoded string.
namestringThe name of the certificate. Must be unique across Wi-Fi profiles.
eapPwdstringFor
eap
peap. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server.hiddenSsidbooleanIndicates 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.
namestringYour name for the Wi-Fi profile.
pskstringFor
authType
**wpa-psk or wpa2-psk. The password to the wireless network.ssidstringThe name of the wireless network.
wsecstringThe type of encryption. Possible values: auto, ccmp (recommended), tkip
settingsobjectGeneral Wi-Fi settings.
bandstringThe preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.
roamingbooleanIndicates whether roaming is enabled on the terminals.
timeoutintegerThe connection time-out in seconds. Minimum value: 0.
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.