Terminal settings - merchant level

Update terminal settings

Changed on

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

In the live environment, requests to this endpoint are subject to rate limits.

patch/merchants/{merchantId}/terminalSettings

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/merchants/{merchantId}/terminalSettings
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

Request body

showCalculatedPercentageTippingAmountboolean nullable

Show the tipping amount calculated from the percentage next to each tipping percentage option on the terminal screen, for example 10 % | 10 EUR for a 100 EUR payment.

Response

OK - the request has succeeded.

showCalculatedPercentageTippingAmountboolean nullable

Show the tipping amount calculated from the percentage next to each tipping percentage option on the terminal screen, for example 10 % | 10 EUR for a 100 EUR payment.

Changes

    • info

      added the new optional request property

    • info

      request property / deprecated

    • info

      added the optional property to the response with the status

    • info

      response property surcharge/disclosureOnPresentCard deprecated

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status