ADadyen
Terminal settings - store level

Get terminal settings

Changed on

Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an 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

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

get/merchants/{merchantId}/stores/{reference}/terminalSettings

Request

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

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

referencestring required

The reference that identifies the store.

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

  • v355cb8143ce0eRevision changes
    • info

      added the optional property to the response with the status

    • info

      response property surcharge/disclosureOnPresentCard deprecated

  • v3f634b6afa653Revision changes
    • info

      added the optional property / to the response with the status