Terminal settings - terminal level

Get terminal settings

Changed on

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.

get/terminals/{terminalId}/terminalSettings

Request

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

Path parameters

terminalIdstring required

The unique identifier of the payment terminal.

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 optional property to the response with the status

    • info

      response property surcharge/disclosureOnPresentCard deprecated

    • info

      added the optional property / to the response with the status