Adyen · Schema

ScheduleTerminalActionsResponse

PaymentsFinancial ServicesFintech

Properties

Name Type Description
actionDetails object Information about the action to take.
items array A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.
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.
terminalsWithErrors object The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.
totalErrors integer The number of terminals for which scheduling the action failed.
totalScheduled integer The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.
View JSON Schema on GitHub

JSON Schema

adyen-scheduleterminalactionsresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduleTerminalActionsResponse",
  "title": "ScheduleTerminalActionsResponse",
  "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.",
      "format": "int32",
      "type": "integer"
    },
    "totalScheduled": {
      "description": "The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.",
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}