<- Object

Object

All versions ->

TerminalActionBeta

Represents an action processed by the Square Terminal.

Link to section

Properties

Link to section

id

string

Read only A unique ID for this TerminalAction.

Min Length
10
Max Length
255
Link to section

device_id

string

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

Link to section

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

Link to section

status

string

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

Link to section

cancel_reason

string

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

Link to section

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

Link to section

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

Link to section

app_id

string

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

Link to section

location_id

string

Read only The location id the action is attached to, if a link can be made.

Max Length
64
Link to section

type

string

Represents the type of the action.

Link to section

qr_code_options

Describes configuration for the QR code action. Requires QR_CODE type.

Link to section

save_card_options

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

Link to section

signature_options

Describes configuration for the signature capture action. Requires SIGNATURE type.

Link to section

confirmation_options

Describes configuration for the confirmation action. Requires CONFIRMATION type.

Link to section

receipt_options

Describes configuration for the receipt action. Requires RECEIPT type.

Link to section

data_collection_options

Describes configuration for the data collection action. Requires DATA_COLLECTION type.

Link to section

select_options

Describes configuration for the select action. Requires SELECT type.

Link to section

device_metadata

Read only 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.

Link to section

await_next_action

boolean

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.

Link to section

await_next_action_duration

string

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

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