TerminalCheckout
April 22, 2020 · View on GitHub
Description
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| id | getId() | setId($value) | string | A unique ID for this `TerminalCheckout` | [optional] |
| amount_money | getAmountMoney() | setAmountMoney($value) | \SquareConnect\Model\Money | The amount of money (including tax amount) that the Square Terminal device should try to collect. | |
| reference_id | getReferenceId() | setReferenceId($value) | 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 | getNote() | setNote($value) | string | An optional note to associate with the checkout, as well any payments used to complete the checkout. | [optional] |
| device_options | getDeviceOptions() | setDeviceOptions($value) | \SquareConnect\Model\DeviceCheckoutOptions | Options to control the display and behavior of the Square Terminal device. | |
| deadline_duration | getDeadlineDuration() | setDeadlineDuration($value) | 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 | getStatus() | setStatus($value) | string | The status of the `TerminalCheckout`. Options: PENDING, IN\_PROGRESS, CANCELED, COMPLETED | [optional] |
| cancel_reason | getCancelReason() | setCancelReason($value) | string | Present if the status is CANCELED. See TerminalCheckoutCancelReason for possible values | [optional] |
| payment_ids | getPaymentIds() | setPaymentIds($value) | string[] | A list of payments created by this `TerminalCheckout`. | [optional] |
| created_at | getCreatedAt() | setCreatedAt($value) | string | The time when the `TerminalCheckout` was created as an RFC 3339 timestamp. | [optional] |
| updated_at | getUpdatedAt() | setUpdatedAt($value) | string | The time when the `TerminalCheckout` was last updated as an RFC 3339 timestamp. | [optional] |
Note: All properties are protected and only accessed via getters and setters.