<- Object

Object

All versions ->

TerminalCheckout

Link to section

Properties

Link to section

id

string

Read only A unique ID for this TerminalCheckout.

Link to section

amount_money

Required

The amount of money (including the tax amount) that the Square Terminal device should try to collect.

Link to section

reference_id

string

An optional user-defined reference ID that can be used to associate this TerminalCheckout to another entity in an external system. For example, an order ID generated by a third-party shopping cart. The ID is also associated with any payments used to complete the checkout.

Link to section

note

string

An optional note to associate with the checkout, as well as with any payments used to complete the checkout.

Link to section

device_options

Required

Options to control the display and behavior of the Square Terminal device.

Link to section

deadline_duration

string

An RFC 3339 duration, after which the checkout is automatically canceled. A TerminalCheckout that is PENDING is automatically CANCELED and has 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 TerminalCheckout. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED

Link to section

cancel_reason

string

Read only Present if the status is CANCELED.

Link to section

payment_ids

string [ ]

Read only A list of IDs for payments created by this TerminalCheckout.

Link to section

created_at

string

Read only The time when the TerminalCheckout 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 TerminalCheckout 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 checkout.

Link to section

location_id

string

Read only The location of the device where the TerminalCheckout was directed.

Link to section

payment_type

string

The type of payment the terminal should attempt to capture from. Defaults to CARD_PRESENT.