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

Get a list of terminal actions

GET
/companies/{companyId}/terminalActions

Returns the terminal actions 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:

  • 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.

Query Parameters

pageNumber?integer

The number of the page to fetch.

Formatint32
pageSize?integer

The number of items to have on a page, maximum 100. The default is 20 items on a page.

Formatint32
status?string

Returns terminal actions with the specified status. Allowed values: pending, successful, failed, cancelled, tryLater.

type?string

Returns terminal actions of the specified type. Allowed values: InstallAndroidApp, UninstallAndroidApp, InstallAndroidCertificate, UninstallAndroidCertificate.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

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

Example response when getting a list of scheduled terminal actions

{  "data": [    {      "actionType": "InstallAndroidApp",      "config": "{\"apps\":\"com.adyen.android.calculator:103\"}",      "confirmedAt": "2021-11-10T00:00:00+01:00",      "id": "TRAC422T2223223K5GFMQHM6WQ4KB6",      "result": "Cancelled manually by user USER@Psp.AdyenPspService",      "scheduledAt": "2021-11-10T14:53:05+01:00",      "status": "cancelled",      "terminalId": "S1E-000150183300032"    }  ]}

Reassign a terminal POST

Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Assign Terminal 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 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).