com.squareup.square.models

Class V1Tender

java.lang.Object

com.squareup.square.models.V1Tender

public class V1Tender
extends Object

This is a model class for V1Tender type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
V1Tender(String id, String type, String name, String employeeId, String receiptUrl, String cardBrand, String panSuffix, String entryMethod, String paymentNote, V1Money totalMoney, V1Money tenderedMoney, String tenderedAt, String settledAt, V1Money changeBackMoney, V1Money refundedMoney, Boolean isExchange) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCardBrand() Getter for CardBrand.
V1Money	getChangeBackMoney() Getter for ChangeBackMoney.
String	getEmployeeId() Getter for EmployeeId.
String	getEntryMethod() Getter for EntryMethod.
String	getId() Getter for Id.
Boolean	getIsExchange() Getter for IsExchange.
String	getName() Getter for Name.
String	getPanSuffix() Getter for PanSuffix.
String	getPaymentNote() Getter for PaymentNote.
String	getReceiptUrl() Getter for ReceiptUrl.
V1Money	getRefundedMoney() Getter for RefundedMoney.
String	getSettledAt() Getter for SettledAt.
String	getTenderedAt() Getter for TenderedAt.
V1Money	getTenderedMoney() Getter for TenderedMoney.
V1Money	getTotalMoney() Getter for TotalMoney.
String	getType() Getter for Type.
int	hashCode()
V1Tender.Builder	toBuilder() Builds a new V1Tender.Builder object.
String	toString() Converts this V1Tender into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

V1Tender

public V1Tender(String id,
                String type,
                String name,
                String employeeId,
                String receiptUrl,
                String cardBrand,
                String panSuffix,
                String entryMethod,
                String paymentNote,
                V1Money totalMoney,
                V1Money tenderedMoney,
                String tenderedAt,
                String settledAt,
                V1Money changeBackMoney,
                V1Money refundedMoney,
                Boolean isExchange)

Initialization constructor.

Parameters:

id - String value for id.

type - String value for type.

name - String value for name.

employeeId - String value for employeeId.

receiptUrl - String value for receiptUrl.

cardBrand - String value for cardBrand.

panSuffix - String value for panSuffix.

entryMethod - String value for entryMethod.

paymentNote - String value for paymentNote.

totalMoney - V1Money value for totalMoney.

tenderedMoney - V1Money value for tenderedMoney.

tenderedAt - String value for tenderedAt.

settledAt - String value for settledAt.

changeBackMoney - V1Money value for changeBackMoney.

refundedMoney - V1Money value for refundedMoney.

isExchange - Boolean value for isExchange.

Method Detail

getId

public String getId()

Getter for Id. The tender's unique ID.

Returns:

Returns the String

getType

public String getType()

Getter for Type.

Returns:

Returns the String

getName

public String getName()

Getter for Name. A human-readable description of the tender.

Returns:

Returns the String

getEmployeeId

public String getEmployeeId()

Getter for EmployeeId. The ID of the employee that processed the tender.

Returns:

Returns the String

getReceiptUrl

public String getReceiptUrl()

Getter for ReceiptUrl. The URL of the receipt for the tender.

Returns:

Returns the String

getCardBrand

public String getCardBrand()

Getter for CardBrand. The brand of a credit card.

Returns:

Returns the String

getPanSuffix

public String getPanSuffix()

Getter for PanSuffix. The last four digits of the provided credit card's account number.

Returns:

Returns the String

getEntryMethod

public String getEntryMethod()

Getter for EntryMethod.

Returns:

Returns the String

getPaymentNote

public String getPaymentNote()

Getter for PaymentNote. Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.

Returns:

Returns the String

getTotalMoney

public V1Money getTotalMoney()

Getter for TotalMoney.

Returns:

Returns the V1Money

getTenderedMoney

public V1Money getTenderedMoney()

Getter for TenderedMoney.

Returns:

Returns the V1Money

getTenderedAt

public String getTenderedAt()

Getter for TenderedAt. The time when the tender was created, in ISO 8601 format.

Returns:

Returns the String

getSettledAt

public String getSettledAt()

Getter for SettledAt. The time when the tender was settled, in ISO 8601 format.

Returns:

Returns the String

getChangeBackMoney

public V1Money getChangeBackMoney()

Getter for ChangeBackMoney.

Returns:

Returns the V1Money

getRefundedMoney

public V1Money getRefundedMoney()

Getter for RefundedMoney.

Returns:

Returns the V1Money

getIsExchange

public Boolean getIsExchange()

Getter for IsExchange. Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange.

Returns:

Returns the Boolean

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public V1Tender.Builder toBuilder()

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

Returns:

a new V1Tender.Builder object