APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminal actionsTerminal actions terminal level

Create a terminal action

POST
/terminals/scheduleActions

Schedules a terminal action 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:

  • 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

Request Body

application/json

actionDetails?|||||

Information about the action to take.

scheduledAt?string

The date and time when the action should happen. Format: RFC 3339, but without the Z before the time offset. For example, 2021-11-15T12:16:21+0100 The action is sent with the first maintenance call after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call.

storeId?string

The unique ID of the store. If present, all terminals in the terminalIds list must be assigned to this store.

terminalIds?array<string>

A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the GET /terminals response. Maximum length: 100 IDs.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/terminals/scheduleActions" \  -H "Content-Type: application/json" \  -d '{    "terminalIds": [      "S1E-000150183300032",      "S1E-000150183300033",      "S1F2-000150183300034"    ],    "storeId": "",    "scheduledAt": "2021-12-12T20:21:22-0100",    "actionDetails": {      "type": "InstallAndroidApp",      "appId": "ANDA422LZ223223K5F694GCCF732K8"    }  }'

Example response after scheduling the installation of an Android app

{  "actionDetails": {    "appId": "ANDA422LZ223223K5F694GCCF732K8",    "type": "InstallAndroidApp"  },  "scheduledAt": "2021-12-12T20:21:22-0100",  "storeId": "",  "items": [    {      "id": "TRAC422T2223223K5GFMQHM6WQ4KB6",      "terminalId": "S1E-000150183300032"    },    {      "id": "TRAC4224X22338VQ5GD4CQJCQT5PC2",      "terminalId": "S1E-000150183300033"    },    {      "id": "TRAC4224Z223223K5GD89RLBWQ6CWT",      "terminalId": "S1F2-000150183300034"    }  ],  "terminalsWithErrors": {},  "totalScheduled": 3,  "totalErrors": 0}

Get terminal action GET

Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path. 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).

Get a list of billing entities GET

Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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 ordering read * Management API—Terminal ordering 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).