Adyen · Schema

ScheduleTerminalActionsRequest

PaymentsFinancial ServicesFintech

Properties

Name Type Description
actionDetails object Information about the action to take.
scheduledAt string The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** Th
storeId string The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.
terminalIds array A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response
View JSON Schema on GitHub

JSON Schema

adyen-scheduleterminalactionsrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduleTerminalActionsRequest",
  "title": "ScheduleTerminalActionsRequest",
  "properties": {
    "actionDetails": {
      "description": "Information about the action to take.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/InstallAndroidAppDetails"
        },
        {
          "$ref": "#/components/schemas/InstallAndroidCertificateDetails"
        },
        {
          "$ref": "#/components/schemas/ReleaseUpdateDetails"
        },
        {
          "$ref": "#/components/schemas/UninstallAndroidAppDetails"
        },
        {
          "$ref": "#/components/schemas/UninstallAndroidCertificateDetails"
        }
      ]
    },
    "scheduledAt": {
      "description": "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call.",
      "type": "string"
    },
    "storeId": {
      "description": "The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.",
      "type": "string"
    },
    "terminalIds": {
      "description": "A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}