com.squareup.square.models

Class Tender

java.lang.Object

com.squareup.square.models.Tender

public class Tender
extends Object

This is a model class for Tender type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tender.Builder Class to build instances of Tender.

Constructor Summary

Constructors

Constructor and Description
Tender(String type, String id, String locationId, String transactionId, String createdAt, String note, Money amountMoney, Money tipMoney, Money processingFeeMoney, String customerId, TenderCardDetails cardDetails, TenderCashDetails cashDetails, List<AdditionalRecipient> additionalRecipients, String paymentId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<AdditionalRecipient>	getAdditionalRecipients() Getter for AdditionalRecipients.
Money	getAmountMoney() Getter for AmountMoney.
TenderCardDetails	getCardDetails() Getter for CardDetails.
TenderCashDetails	getCashDetails() Getter for CashDetails.
String	getCreatedAt() Getter for CreatedAt.
String	getCustomerId() Getter for CustomerId.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getNote() Getter for Note.
String	getPaymentId() Getter for PaymentId.
Money	getProcessingFeeMoney() Getter for ProcessingFeeMoney.
Money	getTipMoney() Getter for TipMoney.
String	getTransactionId() Getter for TransactionId.
String	getType() Getter for Type.
int	hashCode()
Tender.Builder	toBuilder() Builds a new Tender.Builder object.
String	toString() Converts this Tender into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tender

public Tender(String type,
              String id,
              String locationId,
              String transactionId,
              String createdAt,
              String note,
              Money amountMoney,
              Money tipMoney,
              Money processingFeeMoney,
              String customerId,
              TenderCardDetails cardDetails,
              TenderCashDetails cashDetails,
              List<AdditionalRecipient> additionalRecipients,
              String paymentId)

Initialization constructor.

Parameters:

type - String value for type.

id - String value for id.

locationId - String value for locationId.

transactionId - String value for transactionId.

createdAt - String value for createdAt.

note - String value for note.

amountMoney - Money value for amountMoney.

tipMoney - Money value for tipMoney.

processingFeeMoney - Money value for processingFeeMoney.

customerId - String value for customerId.

cardDetails - TenderCardDetails value for cardDetails.

cashDetails - TenderCashDetails value for cashDetails.

additionalRecipients - List of AdditionalRecipient value for additionalRecipients.

paymentId - String value for paymentId.

Method Detail

getId

public String getId()

Getter for Id. The tender's unique ID. It is the associated payment ID.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the transaction's associated location.

Returns:

Returns the String

getTransactionId

public String getTransactionId()

Getter for TransactionId. The ID of the tender's associated transaction.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp for when the tender was created, in RFC 3339 format.

Returns:

Returns the String

getNote

public String getNote()

Getter for Note. An optional note associated with the tender at the time of payment.

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

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

getProcessingFeeMoney

public Money getProcessingFeeMoney()

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

getCustomerId

public String getCustomerId()

Getter for CustomerId. If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Indicates a tender's type.

Returns:

Returns the String

getCardDetails

public TenderCardDetails getCardDetails()

Getter for CardDetails. Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`

Returns:

Returns the TenderCardDetails

getCashDetails

public TenderCashDetails getCashDetails()

Getter for CashDetails. Represents the details of a tender with `type` `CASH`.

Returns:

Returns the TenderCashDetails

getAdditionalRecipients

public List<AdditionalRecipient> getAdditionalRecipients()

Getter for AdditionalRecipients. Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.

Returns:

Returns the List of AdditionalRecipient

getPaymentId

public String getPaymentId()

Getter for PaymentId. The ID of the [Payment]($m/Payment) that corresponds to this tender. This value is only present for payments created with the v2 Payments API.

Returns:

Returns the String

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 Tender into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Tender.Builder toBuilder()

Builds a new Tender.Builder object. Creates the instance with the state of the current model.

Returns:

a new Tender.Builder object