TerminalCheckout (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.TerminalCheckout

```
public class TerminalCheckout
extends Object
```
This is a model class for TerminalCheckout type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TerminalCheckout.Builder
Class to build instances of TerminalCheckout.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TerminalCheckout.Builder` Class to build instances of `TerminalCheckout`.

Constructor Summary

Constructors
Constructor and Description
`TerminalCheckout(Money amountMoney, DeviceCheckoutOptions deviceOptions, String id, String referenceId, String note, String orderId, PaymentOptions paymentOptions, String deadlineDuration, String status, String cancelReason, List<String> paymentIds, String createdAt, String updatedAt, String appId, String locationId, String paymentType, String customerId, Money appFeeMoney)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Money`	`getAmountMoney()` Getter for AmountMoney.
`Money`	`getAppFeeMoney()` Getter for AppFeeMoney.
`String`	`getAppId()` Getter for AppId.
`String`	`getCancelReason()` Getter for CancelReason.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCustomerId()` Getter for CustomerId.
`String`	`getDeadlineDuration()` Getter for DeadlineDuration.
`DeviceCheckoutOptions`	`getDeviceOptions()` Getter for DeviceOptions.
`String`	`getId()` Getter for Id.
`String`	`getLocationId()` Getter for LocationId.
`String`	`getNote()` Getter for Note.
`String`	`getOrderId()` Getter for OrderId.
`List<String>`	`getPaymentIds()` Getter for PaymentIds.
`PaymentOptions`	`getPaymentOptions()` Getter for PaymentOptions.
`String`	`getPaymentType()` Getter for PaymentType.
`String`	`getReferenceId()` Getter for ReferenceId.
`String`	`getStatus()` Getter for Status.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`int`	`hashCode()`
`TerminalCheckout.Builder`	`toBuilder()` Builds a new `TerminalCheckout.Builder` object.
`String`	`toString()` Converts this TerminalCheckout into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TerminalCheckout
```
public TerminalCheckout(Money amountMoney,
                        DeviceCheckoutOptions deviceOptions,
                        String id,
                        String referenceId,
                        String note,
                        String orderId,
                        PaymentOptions paymentOptions,
                        String deadlineDuration,
                        String status,
                        String cancelReason,
                        List<String> paymentIds,
                        String createdAt,
                        String updatedAt,
                        String appId,
                        String locationId,
                        String paymentType,
                        String customerId,
                        Money appFeeMoney)
```
    Initialization constructor.
    
    Parameters:
    
    amountMoney - Money value for amountMoney.
    
    deviceOptions - DeviceCheckoutOptions value for deviceOptions.
    
    id - String value for id.
    
    referenceId - String value for referenceId.
    
    note - String value for note.
    
    orderId - String value for orderId.
    
    paymentOptions - PaymentOptions value for paymentOptions.
    
    deadlineDuration - String value for deadlineDuration.
    
    status - String value for status.
    
    cancelReason - String value for cancelReason.
    
    paymentIds - List of String value for paymentIds.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    appId - String value for appId.
    
    locationId - String value for locationId.
    
    paymentType - String value for paymentType.
    
    customerId - String value for customerId.
    
    appFeeMoney - Money value for appFeeMoney.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. A unique ID for this `TerminalCheckout`.
    
    Returns:
    
    Returns the String
  - getAmountMoney
```
public Money getAmountMoney()
```
    Getter for AmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. 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.
    
    Returns:
    
    Returns the String
  - getNote
```
public String getNote()
```
    Getter for Note. An optional note to associate with the checkout, as well as with any payments used to complete the checkout. Note: maximum 500 characters
    
    Returns:
    
    Returns the String
  - getOrderId
```
public String getOrderId()
```
    Getter for OrderId. The reference to the Square order ID for the checkout request.
    
    Returns:
    
    Returns the String
  - getPaymentOptions
```
public PaymentOptions getPaymentOptions()
```
    Getter for PaymentOptions.
    
    Returns:
    
    Returns the PaymentOptions
  - getDeviceOptions
```
public DeviceCheckoutOptions getDeviceOptions()
```
    Getter for DeviceOptions.
    
    Returns:
    
    Returns the DeviceCheckoutOptions
  - getDeadlineDuration
```
public String getDeadlineDuration()
```
    Getter for DeadlineDuration. 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
    
    Returns:
    
    Returns the String
  - getStatus
```
public String getStatus()
```
    Getter for Status. The status of the `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
    
    Returns:
    
    Returns the String
  - getCancelReason
```
public String getCancelReason()
```
    Getter for CancelReason.
    
    Returns:
    
    Returns the String
  - getPaymentIds
```
public List<String> getPaymentIds()
```
    Getter for PaymentIds. A list of IDs for payments created by this `TerminalCheckout`.
    
    Returns:
    
    Returns the List of String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp.
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp.
    
    Returns:
    
    Returns the String
  - getAppId
```
public String getAppId()
```
    Getter for AppId. The ID of the application that created the checkout.
    
    Returns:
    
    Returns the String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The location of the device where the `TerminalCheckout` was directed.
    
    Returns:
    
    Returns the String
  - getPaymentType
```
public String getPaymentType()
```
    Getter for PaymentType.
    
    Returns:
    
    Returns the String
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. An optional ID of the customer associated with the checkout.
    
    Returns:
    
    Returns the String
  - getAppFeeMoney
```
public Money getAppFeeMoney()
```
    Getter for AppFeeMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this TerminalCheckout into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public TerminalCheckout.Builder toBuilder()
```
    Builds a new TerminalCheckout.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new TerminalCheckout.Builder object

Class TerminalCheckout

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TerminalCheckout

Method Detail

getId

getAmountMoney

getReferenceId

getNote

getOrderId

getPaymentOptions

getDeviceOptions

getDeadlineDuration

getStatus

getCancelReason

getPaymentIds

getCreatedAt

getUpdatedAt

getAppId

getLocationId

getPaymentType

getCustomerId

getAppFeeMoney

hashCode

equals

toString

toBuilder