Terminal settings - terminal level

Get terminal settings

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

Path parameters

terminalIdstring required

The unique identifier of the payment terminal.

Response

OK - the request has succeeded.

Changes

Changed in 13 of the 50 revisions of this API.22215

    • added the optional property surcharge/disclosureOnPresentCard to the response with the 200 status

      response-optional-property-added

    • removed the optional property offlineProcessing/offlineSwipeLimits from the response with the 200 status

      response-optional-property-removed

    • added the optional property dcc to the response with the 200 status

      response-optional-property-added

    • added the optional property receiptOptions/headerLine1 to the response with the 200 status

      response-optional-property-added

    • added the optional property receiptOptions/headerLine2 to the response with the 200 status

      response-optional-property-added

    • added the optional property homeScreen to the response with the 200 status

      response-optional-property-added

    • added the optional property kioskMode to the response with the 200 status

      response-optional-property-added

    • removed the optional property moto/enableRefunds from the response with the 200 status

      response-optional-property-removed

    • added the optional property moto to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property refunds/unreferenced to the response with the 200 status

      response-optional-property-added

    • added the optional property standalone/enableGratuities to the response with the 200 status

      response-optional-property-added

    • added the optional property wifiProfiles/profiles/items/domainSuffix to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property surcharge/excludeGratuityFromSurcharge to the response with the 200 status

      response-optional-property-added

    • added the optional property surcharge/configurations/items/commercial to the response with the 200 status

      response-optional-property-added

    • added the optional property surcharge/configurations/items/currencies/items/maxAmount to the response with the 200 status

      response-optional-property-added