com.squareup.square.models

Class GiftCard

java.lang.Object

com.squareup.square.models.GiftCard

public class GiftCard
extends Object

This is a model class for GiftCard type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
GiftCard(String type, String id, String ganSource, String state, Money balanceMoney, String gan, String createdAt, List<String> customerIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getBalanceMoney() Getter for BalanceMoney.
String	getCreatedAt() Getter for CreatedAt.
List<String>	getCustomerIds() Getter for CustomerIds.
String	getGan() Getter for Gan.
String	getGanSource() Getter for GanSource.
String	getId() Getter for Id.
String	getState() Getter for State.
String	getType() Getter for Type.
int	hashCode()
GiftCard.Builder	toBuilder() Builds a new GiftCard.Builder object.
String	toString() Converts this GiftCard into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GiftCard

public GiftCard(String type,
                String id,
                String ganSource,
                String state,
                Money balanceMoney,
                String gan,
                String createdAt,
                List<String> customerIds)

Initialization constructor.

Parameters:

type - String value for type.

id - String value for id.

ganSource - String value for ganSource.

state - String value for state.

balanceMoney - Money value for balanceMoney.

gan - String value for gan.

createdAt - String value for createdAt.

customerIds - List of String value for customerIds.

Method Detail

getId

public String getId()

Getter for Id. The Square-assigned ID of the gift card.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Indicates the gift card type.

Returns:

Returns the String

getGanSource

public String getGanSource()

Getter for GanSource. Indicates the source that generated the gift card account number (GAN).

Returns:

Returns the String

getState

public String getState()

Getter for State. Indicates the gift card state.

Returns:

Returns the String

getBalanceMoney

public Money getBalanceMoney()

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

getGan

public String getGan()

Getter for Gan. The gift card account number (GAN). Buyers can use the GAN to make purchases or check the gift card balance.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp when the gift card was created, in RFC 3339 format. In the case of a digital gift card, it is the time when you create a card (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API). In the case of a plastic gift card, it is the time when Square associates the card with the seller at the time of activation.

Returns:

Returns the String

getCustomerIds

public List<String> getCustomerIds()

Getter for CustomerIds. The IDs of the [customer profiles]($m/Customer) to whom this gift card is linked.

Returns:

Returns the List of 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 GiftCard into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public GiftCard.Builder toBuilder()

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

Returns:

a new GiftCard.Builder object