com.squareup.sdk.reader.checkout

Class Tender

java.lang.Object

com.squareup.sdk.reader.checkout.Tender

public final class Tender
extends java.lang.Object

Represents a payment method used in a transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tender.Builder Builder class for constructing Tender objects.
static class	Tender.Type The payment method type.

Method Summary

Modifier and Type	Method and Description
Tender.Builder	buildUpon() Creates a new Tender Tender.Builder, with attributes copied from this instance.
boolean	equals(java.lang.Object o)
TenderCardDetails	getCardDetails() Details related to the card payment represented by this tender.
TenderCashDetails	getCashDetails() Details related to the cash payment represented by this tender.
java.util.Date	getCreatedAt() The date and time when the tender was created, as determined by the client device.
java.lang.String	getTenderId() A unique ID for this tender issued by Square's servers.
Money	getTipMoney() The amount added to this tender as tip.
Money	getTotalMoney() The total amount of this tender, including tips.
Tender.Type	getType() The type of this tender.
int	hashCode()
static Tender.Builder	newCardTenderBuilder(java.lang.String tenderId, Money totalMoney, TenderCardDetails cardDetails) Creates a new tender builder of type Tender.Type.CARD with default values.
static Tender.Builder	newCashTenderBuilder(Money totalMoney, TenderCashDetails cashDetails) Creates a new tender builder of type Tender.Type.CASH with default values.
static Tender.Builder	newOtherTenderBuilder(Money totalMoney) Creates a new tender builder of type Tender.Type.OTHER with default values.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newCardTenderBuilder

@NonNull
public static Tender.Builder newCardTenderBuilder(@NonNull
                                                           java.lang.String tenderId,
                                                           @NonNull
                                                           Money totalMoney,
                                                           @NonNull
                                                           TenderCardDetails cardDetails)

Creates a new tender builder of type Tender.Type.CARD with default values.

This method is provided for testing purposes.

Returns:

A new Tender builder instance.

newCashTenderBuilder

@NonNull
public static Tender.Builder newCashTenderBuilder(@NonNull
                                                           Money totalMoney,
                                                           @NonNull
                                                           TenderCashDetails cashDetails)

Creates a new tender builder of type Tender.Type.CASH with default values.

This method is provided for testing purposes.

Returns:

A new Tender builder instance.

newOtherTenderBuilder

@NonNull
public static Tender.Builder newOtherTenderBuilder(@NonNull
                                                            Money totalMoney)

Creates a new tender builder of type Tender.Type.OTHER with default values.

This method is provided for testing purposes.

Returns:

A new Tender builder instance.

getTenderId

@NonNull
public java.lang.String getTenderId()
                                      throws java.lang.IllegalStateException

A unique ID for this tender issued by Square's servers. Tender IDs can be used to issue refunds with the Connect v2 Transactions API at a later time.

Throws:

java.lang.IllegalStateException - if type is not Tender.Type.CARD.

getTotalMoney

@NonNull
public Money getTotalMoney()

The total amount of this tender, including tips.

getType

@NonNull
public Tender.Type getType()

The type of this tender.

getCardDetails

@NonNull
public TenderCardDetails getCardDetails()
                                          throws java.lang.IllegalStateException

Details related to the card payment represented by this tender.

Throws:

java.lang.IllegalStateException - if type is not Tender.Type.CARD.

getCashDetails

@NonNull
public TenderCashDetails getCashDetails()
                                          throws java.lang.IllegalStateException

Details related to the cash payment represented by this tender.

Throws:

java.lang.IllegalStateException - if type is not Tender.Type.CASH.

getCreatedAt

@NonNull
public java.util.Date getCreatedAt()

The date and time when the tender was created, as determined by the client device.

getTipMoney

@NonNull
public Money getTipMoney()

The amount added to this tender as tip. Included as a part of totalMoney.

buildUpon

@NonNull
public Tender.Builder buildUpon()

Creates a new Tender Tender.Builder, with attributes copied from this instance.

This method is provided for testing purposes.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object