• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
TerminalAction BETA

Represents an action processed by the Square Terminal.

Properties

Name Description
id
string

Read only A unique ID for this TerminalAction.

Min Length 10 Max Length 255
device_id
string

The unique Id of the device intended for this TerminalAction. The Id can be retrieved from /v2/devices api.

deadline_duration
string

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

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

status
string

Read only The status of the TerminalAction. Options: PENDING, IN_PROGRESS, CANCELED, COMPLETED

cancel_reason
string

Read only The reason why TerminalAction is canceled. Present if the status is CANCELED.

created_at
string

Read only The time when the TerminalAction was created as an RFC 3339 timestamp.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

updated_at
string

Read only The time when the TerminalAction was last updated as an RFC 3339 timestamp.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

app_id
string

Read only The ID of the application that created the action.

type
string

Represents the type of the action.

save_card_options
SaveCardOptions

Describes configuration for the save-card action. Requires SAVE_CARD type.

device_metadata
DeviceMetadata

Details about the Terminal that received the action request (such as battery level, operating system version, and network connection settings).

Only available for PING action type.