ManagementTerminal actionsTerminal actions company level

Get terminal action

GET
/companies/{companyId}/terminalActions/{actionId}

Returns the details of the terminal action identified in the path. To make this request, your API credential must have one of the following roles:

  • Management API—Terminal actions read
  • Management API—Terminal actions read and write

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

actionId*string

The unique identifier of the terminal action.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies/string/terminalActions/string"

Example response with the details of the specified terminal action

{  "actionType": "InstallAndroidCertificate",  "config": "{\"certificates\":\"5dff6b...\"}",  "confirmedAt": "2022-06-27T17:44:54+02:00",  "id": "TRAC4224Z223223K5GD89RLBWQ6CWT",  "result": "Ok",  "scheduledAt": "2022-06-27T15:44:07+02:00",  "status": "successful",  "terminalId": "S1F2-000150183300034"}

Get a list of terminal actions GET

Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).

Create a terminal action POST

Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).