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
Endpoint destination URL
https://management-test.adyen.com/v1/companies/{companyId}/terminalSettings
Click to copy

Path Parameters

companyIdstringRequired

The unique identifier of the company account.

Request Parameters

cardholderReceiptobject

Settings to define the header of the shopper receipt.

connectivityobject

Settings for terminal connectivity features.

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.

hardwareobject

Settings for terminal hardware features.

localizationobject

Settings for localization.

nexoobject

Settings for a Terminal API integration.

offlineProcessingobject

Settings for offline payment features.

opiobject

Settings for an Oracle Payment Interface (OPI) integration.

passcodesobject

Settings for passcodes features.

payAtTableobject

Settings for Pay-at-table features.

paymentobject

Settings for payment features.

receiptOptionsobject

Generic receipt settings.

receiptPrintingobject

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

refundsobject

Settings for refunds.

signatureobject

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

standaloneobject

Settings for standalone features.

surchargeobject

Settings for payment surcharge features.

tapToPayobject

Settings for Tap to Pay.

terminalInstructionsobject

Settings to define the behaviour of the payment terminal.

timeoutsobject

Settings for device time-outs.

wifiProfilesobject

Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.

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 less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less