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

Modifier	Constructor and Description
protected	GiftCardActivityRefund(io.apimatic.core.types.OptionalNullable<String> redeemActivityId, Money amountMoney, io.apimatic.core.types.OptionalNullable<String> referenceId, String paymentId) Initialization constructor.
	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()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetRedeemActivityId() Internal Getter for RedeemActivityId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
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.

GiftCardActivityRefund

protected GiftCardActivityRefund(io.apimatic.core.types.OptionalNullable<String> redeemActivityId,
                                 Money amountMoney,
                                 io.apimatic.core.types.OptionalNullable<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

internalGetRedeemActivityId

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

Internal Getter for RedeemActivityId. The ID of the refunded `REDEEM` gift card activity. Square populates this field if the `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request represents a redemption made by the same gift card. Note that you must use `RefundPayment` to refund a gift card payment to the same gift card if the payment was processed by Square. For applications that use a custom payment processing system, this field is required when creating a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card.

Returns:

Returns the Internal String

getRedeemActivityId

public String getRedeemActivityId()

Getter for RedeemActivityId. The ID of the refunded `REDEEM` gift card activity. Square populates this field if the `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request represents a redemption made by the same gift card. Note that you must use `RefundPayment` to refund a gift card payment to the same gift card if the payment was processed by Square. For applications that use a custom payment processing system, this field is required when creating a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card.

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

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.

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.

Returns:

Returns the String

getPaymentId

public String getPaymentId()

Getter for PaymentId. The ID of the refunded payment. Square populates this field if the refund is for a payment processed by Square and one of the following conditions is true: - The Refunds API is used to refund a gift card payment to the same gift card. - A seller initiated the refund from Square Point of Sale or the Seller Dashboard. The payment source can be the same gift card or a cross-tender payment from a credit card or a different gift card.

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