Update terminal settings

patch /terminals/{terminalId}/terminalSettings

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:

  • 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

Click to copy

Path parameters

terminalId string Required

The unique identifier of the payment terminal.

Request parameters

cardholderReceipt object

Settings to define the header of the shopper receipt.

connectivity object

Settings for terminal connectivity features.

gratuities array [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.

hardware object

Settings for terminal hardware features.

nexo object

Settings for a Terminal API integration.

offlineProcessing object

Settings for offline payment features.

opi object

Settings for an Oracle Payment Interface (OPI) integration.

passcodes object

Settings for passcodes features.

payAtTable object

Settings for Pay-at-table features.

payment object

Settings for payment features.

receiptOptions object

Generic receipt settings.

receiptPrinting object

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

signature object

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

standalone object

Settings for standalone features.

surcharge object

Settings for payment surcharge features.

timeouts object

Settings for device time-outs.

wifiProfiles object

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

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy