Terminal settings - store level

Update terminal settings

Updates payment terminal settings 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 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}/stores/{reference}/terminalSettings

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

referencestring required

The reference that identifies the store.

Request body

Response

OK - the request has succeeded.

Changes

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

    • added the new optional request property surcharge/disclosureOnPresentCard

      new-optional-request-property

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

      response-optional-property-added

    • removed the request property offlineProcessing/offlineSwipeLimits

      request-property-removed

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

      response-optional-property-removed

    • added the new optional request property dcc

      new-optional-request-property

    • added the new optional request property receiptOptions/headerLine1

      new-optional-request-property

    • added the new optional request property receiptOptions/headerLine2

      new-optional-request-property

    • 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 new optional request property homeScreen

      new-optional-request-property

    • added the new optional request property kioskMode

      new-optional-request-property

    • 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 request property moto/enableRefunds

      request-property-removed

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

      response-optional-property-removed

    • added the new optional request property moto

      new-optional-request-property

    • 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 new optional request property refunds/unreferenced

      new-optional-request-property

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

      response-optional-property-added

    • added the new optional request property standalone/enableGratuities

      new-optional-request-property

    • added the new optional request property wifiProfiles/profiles/items/domainSuffix

      new-optional-request-property

    • 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 new optional request property surcharge/excludeGratuityFromSurcharge

      new-optional-request-property

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

      response-optional-property-added

    • added the new optional request property surcharge/configurations/items/commercial

      new-optional-request-property

    • added the new optional request property surcharge/configurations/items/currencies/items/maxAmount

      new-optional-request-property

    • 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