terminal-action.md

Terminal Action

Represents an action processed by the Square Terminal.

Structure

TerminalAction

Fields

Name	Type	Tags	Description
id	string | undefined	Optional	A unique ID for this TerminalAction. Constraints: Minimum Length: 10, Maximum Length: 255
deviceId	string | undefined	Optional	The unique Id of the device intended for this TerminalAction. The Id can be retrieved from /v2/devices api.
deadlineDuration	string | undefined	Optional	The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are PENDING will be automatically CANCELED and have a cancellation reason of TIMED_OUT Default: 5 minutes from creation Maximum: 5 minutes
status	string | undefined	Optional	The status of the TerminalAction. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED
cancelReason	string | undefined	Optional	-
createdAt	string | undefined	Optional	The time when the TerminalAction was created as an RFC 3339 timestamp.
updatedAt	string | undefined	Optional	The time when the TerminalAction was last updated as an RFC 3339 timestamp.
appId	string | undefined	Optional	The ID of the application that created the action.
type	string | undefined	Optional	Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.
saveCardOptions	SaveCardOptions | undefined	Optional	Describes save-card action fields.
deviceMetadata	DeviceMetadata | undefined	Optional	-

Example (as JSON)

{
  "device_id": null,
  "deadline_duration": null,
  "cancel_reason": null,
  "type": null,
  "save_card_options": null,
  "device_metadata": null
}