Represents a checkout processed by the Square Terminal.
<- Object
Object
Represents a checkout processed by the Square Terminal.
The amount of money (including the tax amount) that the Square Terminal device should try to collect.
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.
An optional note to associate with the checkout, as well as with any payments used to complete the checkout. Note: maximum 500 characters
The reference to the Square order ID for the checkout request. Supported only in the US.
Payment-specific options for the checkout request. Supported only in the US.
Options to control the display and behavior of the Square Terminal device.
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
Read only The status of the TerminalCheckout. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED
Read only The reason why TerminalCheckout is canceled. Present if the status is CANCELED.
Read only A list of IDs for payments created by this TerminalCheckout.
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
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
Read only The location of the device where the TerminalCheckout was directed.
The type of payment the terminal should attempt to capture from. Defaults to CARD_PRESENT.
An optional ID of the team member associated with creating the checkout.
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.
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.