Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 2 KB

TerminalCheckout.md

File metadata and controls

23 lines (17 loc) · 2 KB

SquareConnect.TerminalCheckout

Description

Note: This model is in beta.

Properties

Name Type Description Notes
id String A unique ID for this `TerminalCheckout` [optional]
amount_money Money 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. [optional]
note String An optional note to associate with the checkout, as well any payments used to complete the checkout. [optional]
device_options DeviceCheckoutOptions 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 [optional]
status String The status of the `TerminalCheckout`. Options: PENDING, IN\_PROGRESS, CANCELED, COMPLETED [optional]
cancel_reason String Present if the status is CANCELED. See TerminalCheckoutCancelReason for possible values [optional]
payment_ids [String] A list of payments created by this `TerminalCheckout`. [optional]
created_at String The time when the `TerminalCheckout` was created as an RFC 3339 timestamp. [optional]
updated_at String The time when the `TerminalCheckout` was last updated as an RFC 3339 timestamp. [optional]