<- Object

Object

TerminalCheckout

Represents a checkout processed by the Square Terminal.

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. Note: maximum 500 characters

Link to section

order_id

string

The reference to the Square order ID for the checkout request. Supported only in the US.

Link to section

payment_options

Payment-specific options for the checkout request. Supported only in the US.

Link to section

device_options

Required

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

Link to section

deadline_duration

string

Deprecated

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 The reason why TerminalCheckout is canceled. 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.

Link to section

team_member_id

string

Beta

An optional ID of the team member associated with creating the checkout.

Link to section

customer_id

string

An optional ID of the customer associated with the checkout.

Link to section

app_fee_money

The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.

The amount cannot be more than 90% of the total amount of the payment.

The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts.

The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller.

For more information about the application fee scenario, see Take Payments and Collect Fees.

To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see Permissions.

Supported only in the US.

Link to section

statement_description_identifier

string

Beta

Optional additional payment information to include on the customer's card statement as part of the statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Supported only in the US.

Link to section

tip_money

Beta

The amount designated as a tip, in addition to amount_money. This may only be set for a checkout that has tipping disabled (tip_settings.allow_tipping is false). Supported only in the US.