GET

Get terminal settings

https://management-test.adyen.com/v1/companies/{companyId}/terminalSettings

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

Access Token Required: API Key

Path Parameters

companyIdstringrequired

The unique identifier of the company account.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://management-test.adyen.com/v1/companies/{companyId}/terminalSettings' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}