v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Terminal settings - company level

Get terminal settings

Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or 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/companies/{companyId}/terminalSettings

Path parameters

companyIdstring required

The unique identifier of the company account.

Response

OK - the request has succeeded.