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

Object Index

You are viewing an old version of the API
TerminalCheckout BETA

Properties

Name Description
id
string

Read only A unique ID for this TerminalCheckout

amount_money
Money

Required

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

reference_id
string

An optional user-defined reference ID which 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. Will also be associated with any payments used to complete the checkout.

Max Length 40
note
string

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

Max Length 250
device_options
DeviceCheckoutOptions

Required

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

deadline_duration
string

The duration as an RFC 3339 duration, after which the checkout will be automatically canceled. TerminalCheckouts 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 TerminalCheckout. Options: PENDING, IN_PROGRESS, CANCELED, COMPLETED

cancel_reason
string

Read only Present if the status is CANCELED.

payment_ids
string [ ]

Read only A list of payments created by this TerminalCheckout.

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

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

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?