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

Modifier	Constructor and Description
protected	GiftCardActivityRedeem(Money amountMoney, String paymentId, io.apimatic.core.types.OptionalNullable<String> referenceId, String status) Initialization constructor.
	GiftCardActivityRedeem(Money amountMoney, String paymentId, String referenceId, String status) 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.
String	getStatus() Getter for Status.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
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,
                              String status)

Initialization constructor.

Parameters:

amountMoney - Money value for amountMoney.

paymentId - String value for paymentId.

referenceId - String value for referenceId.

status - String value for status.

GiftCardActivityRedeem

protected GiftCardActivityRedeem(Money amountMoney,
                                 String paymentId,
                                 io.apimatic.core.types.OptionalNullable<String> referenceId,
                                 String status)

Initialization constructor.

Parameters:

amountMoney - Money value for amountMoney.

paymentId - String value for paymentId.

referenceId - String value for referenceId.

status - String value for status.

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. The ID of the payment that represents the gift card redemption. Square populates this field if the payment was processed by Square.

Returns:

Returns the String

internalGetReferenceId

protected io.apimatic.core.types.OptionalNullable<String> internalGetReferenceId()

Internal Getter for ReferenceId. A client-specified ID that associates the gift card activity with an entity in another system. Applications that use a custom payment processing system can use this field to track information related to an order or payment.

Returns:

Returns the Internal String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. A client-specified ID that associates the gift card activity with an entity in another system. Applications that use a custom payment processing system can use this field to track information related to an order or payment.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. Indicates the status of a [gift card]($m/GiftCard) redemption. This status is relevant only for redemptions made from Square products (such as Square Point of Sale) because Square products use a two-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.

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