com.squareup.square.models

Class GiftCardActivityRedeem

java.lang.Object

com.squareup.square.models.GiftCardActivityRedeem

public class GiftCardActivityRedeem
extends Object

This is a model class for GiftCardActivityRedeem type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
GiftCardActivityRedeem(Money amountMoney, String paymentId, String referenceId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
String	getPaymentId() Getter for PaymentId.
String	getReferenceId() Getter for ReferenceId.
int	hashCode()
GiftCardActivityRedeem.Builder	toBuilder() Builds a new GiftCardActivityRedeem.Builder object.
String	toString() Converts this GiftCardActivityRedeem into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GiftCardActivityRedeem

public GiftCardActivityRedeem(Money amountMoney,
                              String paymentId,
                              String referenceId)

Initialization constructor.

Parameters:

amountMoney - Money value for amountMoney.

paymentId - String value for paymentId.

referenceId - String value for referenceId.

Method Detail

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

getPaymentId

public String getPaymentId()

Getter for PaymentId. When the Square Payments API is used, Redeem is not called on the Gift Cards API. However, when Square reads a Redeem activity from the Gift Cards API, developers need to know the associated `payment_id`.

Returns:

Returns the String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. A client-specified ID to associate an entity, in another system, with this gift card activity. This can be used to track the order or payment related information when the Square Orders API is not being used.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public GiftCardActivityRedeem.Builder toBuilder()

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

Returns:

a new GiftCardActivityRedeem.Builder object