Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 4.03 KB

terminal-action.md

File metadata and controls

46 lines (37 loc) · 4.03 KB
Raw

Terminal Action

Represents an action processed by the Square Terminal.

Structure

TerminalAction

Fields

Name Type Tags Description Getter
Id String Optional A unique ID for this TerminalAction.
Constraints: Minimum Length: 10, Maximum Length: 255		 String getId()
DeviceId String Optional The unique Id of the device intended for this TerminalAction.
The Id can be retrieved from /v2/devices api.		 String getDeviceId()
DeadlineDuration String 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		 String getDeadlineDuration()
Status String Optional The status of the TerminalAction.
Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED		 String getStatus()
CancelReason String Optional - String getCancelReason()
CreatedAt String Optional The time when the TerminalAction was created as an RFC 3339 timestamp. String getCreatedAt()
UpdatedAt String Optional The time when the TerminalAction was last updated as an RFC 3339 timestamp. String getUpdatedAt()
AppId String Optional The ID of the application that created the action. String getAppId()
LocationId String Optional The location id the action is attached to, if a link can be made.
Constraints: Maximum Length: 64		 String getLocationId()
Type String Optional Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. String getType()
QrCodeOptions QrCodeOptions Optional Fields to describe the action that displays QR-Codes. QrCodeOptions getQrCodeOptions()
SaveCardOptions SaveCardOptions Optional Describes save-card action fields. SaveCardOptions getSaveCardOptions()
SignatureOptions SignatureOptions Optional - SignatureOptions getSignatureOptions()
ConfirmationOptions ConfirmationOptions Optional - ConfirmationOptions getConfirmationOptions()
ReceiptOptions ReceiptOptions Optional Describes receipt action fields. ReceiptOptions getReceiptOptions()
DataCollectionOptions DataCollectionOptions Optional - DataCollectionOptions getDataCollectionOptions()
SelectOptions SelectOptions Optional - SelectOptions getSelectOptions()
DeviceMetadata DeviceMetadata Optional - DeviceMetadata getDeviceMetadata()
AwaitNextAction Boolean Optional Indicates the action will be linked to another action and requires a waiting dialog to be
displayed instead of returning to the idle screen on completion of the action.

Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.		 Boolean getAwaitNextAction()
AwaitNextActionDuration String Optional The timeout duration of the waiting dialog as an RFC 3339 duration, after which the
waiting dialog will no longer be displayed and the Terminal will return to the idle screen.

Default: 5 minutes from when the waiting dialog is displayed

Maximum: 5 minutes		 String getAwaitNextActionDuration()

Example (as JSON)

{
  "id": "id8",
  "device_id": "device_id4",
  "deadline_duration": "deadline_duration0",
  "status": "status0",
  "cancel_reason": "TIMED_OUT"
}