ADadyen
Terminal actions - terminal level

Create a terminal action

Changed on

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.

post/terminals/scheduleActions

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/terminals/scheduleActions
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

scheduledAtstring

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.

storeIdstring

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

terminalIdsstring[]

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

OK - the request has succeeded.

scheduledAtstring

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.

storeIdstring

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

terminalsWithErrorsobject

The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.

totalErrorsinteger

The number of terminals for which scheduling the action failed.

totalScheduledinteger

The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.

Changes

  • v3f634b6afa653Revision changes
    • info

      added discriminator to request property

    • info

      added discriminator to response property for the response status

  • v3509d18bb9de7Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added to the request property oneOf list