Adyen · JSON Structure

Management Schedule Terminal Actions Response Structure

ScheduleTerminalActionsResponse schema from Adyen API

Type: object Properties: 7
PaymentsFinancial ServicesFintech

ScheduleTerminalActionsResponse is a JSON Structure definition published by Adyen, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

actionDetails items scheduledAt storeId terminalsWithErrors totalErrors totalScheduled

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-schedule-terminal-actions-response-structure.json",
  "description": "ScheduleTerminalActionsResponse schema from Adyen API",
  "type": "object",
  "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"
        }
      ]
    },
    "items": {
      "x-addedInVersion": "1",
      "description": "A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.",
      "items": {
        "$ref": "#/components/schemas/TerminalActionScheduleDetail"
      },
      "type": "array"
    },
    "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"
    },
    "terminalsWithErrors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.",
      "type": "object"
    },
    "totalErrors": {
      "description": "The number of terminals for which scheduling the action failed.",
      "type": "int32"
    },
    "totalScheduled": {
      "description": "The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.",
      "type": "int32"
    }
  },
  "name": "ScheduleTerminalActionsResponse"
}