com.squareup.square.models

Class GiftCardActivityRefund

java.lang.Object

com.squareup.square.models.GiftCardActivityRefund

public class GiftCardActivityRefund
extends Object

This is a model class for GiftCardActivityRefund type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
GiftCardActivityRefund(String redeemActivityId, Money amountMoney, String referenceId, String paymentId) 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	getRedeemActivityId() Getter for RedeemActivityId.
String	getReferenceId() Getter for ReferenceId.
int	hashCode()
GiftCardActivityRefund.Builder	toBuilder() Builds a new GiftCardActivityRefund.Builder object.
String	toString() Converts this GiftCardActivityRefund into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GiftCardActivityRefund

public GiftCardActivityRefund(String redeemActivityId,
                              Money amountMoney,
                              String referenceId,
                              String paymentId)

Initialization constructor.

Parameters:

redeemActivityId - String value for redeemActivityId.

amountMoney - Money value for amountMoney.

referenceId - String value for referenceId.

paymentId - String value for paymentId.

Method Detail

getRedeemActivityId

public String getRedeemActivityId()

Getter for RedeemActivityId. The ID for the Redeem activity that needs to be refunded. Hence, the activity it refers to has to be of the REDEEM type.

Returns:

Returns the String

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

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

getPaymentId

public String getPaymentId()

Getter for PaymentId. When the Square Payments API is used, Refund is not called on the Gift Cards API. However, when Square reads a Refund activity from the Gift Cards API, the developer needs to know the ID of the payment (made using this gift card) that is being refunded.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public GiftCardActivityRefund.Builder toBuilder()

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

Returns:

a new GiftCardActivityRefund.Builder object