com.squareup.square.models

Class TerminalCheckout

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TerminalCheckout(Money amountMoney, DeviceCheckoutOptions deviceOptions, String id, io.apimatic.core.types.OptionalNullable<String> referenceId, io.apimatic.core.types.OptionalNullable<String> note, io.apimatic.core.types.OptionalNullable<String> orderId, PaymentOptions paymentOptions, io.apimatic.core.types.OptionalNullable<String> deadlineDuration, String status, String cancelReason, List<String> paymentIds, String createdAt, String updatedAt, String appId, String locationId, String paymentType, io.apimatic.core.types.OptionalNullable<String> teamMemberId, io.apimatic.core.types.OptionalNullable<String> customerId, Money appFeeMoney, io.apimatic.core.types.OptionalNullable<String> statementDescriptionIdentifier, Money tipMoney) Initialization constructor.
	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 teamMemberId, String customerId, Money appFeeMoney, String statementDescriptionIdentifier, Money tipMoney) Initialization constructor.

Method Summary

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	getStatementDescriptionIdentifier() Getter for StatementDescriptionIdentifier.
String	getStatus() Getter for Status.
String	getTeamMemberId() Getter for TeamMemberId.
Money	getTipMoney() Getter for TipMoney.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCustomerId() Internal Getter for CustomerId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDeadlineDuration() Internal Getter for DeadlineDuration.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetNote() Internal Getter for Note.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOrderId() Internal Getter for OrderId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetStatementDescriptionIdentifier() Internal Getter for StatementDescriptionIdentifier.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetTeamMemberId() Internal Getter for TeamMemberId.
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 teamMemberId,
                        String customerId,
                        Money appFeeMoney,
                        String statementDescriptionIdentifier,
                        Money tipMoney)

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.

teamMemberId - String value for teamMemberId.

customerId - String value for customerId.

appFeeMoney - Money value for appFeeMoney.

statementDescriptionIdentifier - String value for statementDescriptionIdentifier.

tipMoney - Money value for tipMoney.

TerminalCheckout

protected TerminalCheckout(Money amountMoney,
                           DeviceCheckoutOptions deviceOptions,
                           String id,
                           io.apimatic.core.types.OptionalNullable<String> referenceId,
                           io.apimatic.core.types.OptionalNullable<String> note,
                           io.apimatic.core.types.OptionalNullable<String> orderId,
                           PaymentOptions paymentOptions,
                           io.apimatic.core.types.OptionalNullable<String> deadlineDuration,
                           String status,
                           String cancelReason,
                           List<String> paymentIds,
                           String createdAt,
                           String updatedAt,
                           String appId,
                           String locationId,
                           String paymentType,
                           io.apimatic.core.types.OptionalNullable<String> teamMemberId,
                           io.apimatic.core.types.OptionalNullable<String> customerId,
                           Money appFeeMoney,
                           io.apimatic.core.types.OptionalNullable<String> statementDescriptionIdentifier,
                           Money tipMoney)

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.

teamMemberId - String value for teamMemberId.

customerId - String value for customerId.

appFeeMoney - Money value for appFeeMoney.

statementDescriptionIdentifier - String value for statementDescriptionIdentifier.

tipMoney - Money value for tipMoney.

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

internalGetReferenceId

protected io.apimatic.core.types.OptionalNullable<String> internalGetReferenceId()

Internal 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 Internal String

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

internalGetNote

protected io.apimatic.core.types.OptionalNullable<String> internalGetNote()

Internal 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 Internal 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

internalGetOrderId

protected io.apimatic.core.types.OptionalNullable<String> internalGetOrderId()

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

Returns:

Returns the Internal String

getOrderId

public String getOrderId()

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

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

internalGetDeadlineDuration

protected io.apimatic.core.types.OptionalNullable<String> internalGetDeadlineDuration()

Internal 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 Internal String

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

internalGetTeamMemberId

protected io.apimatic.core.types.OptionalNullable<String> internalGetTeamMemberId()

Internal Getter for TeamMemberId. An optional ID of the team member associated with creating the checkout.

Returns:

Returns the Internal String

getTeamMemberId

public String getTeamMemberId()

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

Returns:

Returns the String

internalGetCustomerId

protected io.apimatic.core.types.OptionalNullable<String> internalGetCustomerId()

Internal Getter for CustomerId. An optional ID of the customer associated with the checkout.

Returns:

Returns the Internal 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

internalGetStatementDescriptionIdentifier

protected io.apimatic.core.types.OptionalNullable<String> internalGetStatementDescriptionIdentifier()

Internal Getter for StatementDescriptionIdentifier. 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.

Returns:

Returns the Internal String

getStatementDescriptionIdentifier

public String getStatementDescriptionIdentifier()

Getter for StatementDescriptionIdentifier. 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.

Returns:

Returns the String

getTipMoney

public Money getTipMoney()

Getter for TipMoney. 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