com.squareup.square.models

Class Refund

java.lang.Object

com.squareup.square.models.Refund

public class Refund
extends Object

This is a model class for Refund type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Refund(String id, String locationId, String tenderId, String reason, Money amountMoney, String status, String transactionId, String createdAt, Money processingFeeMoney, List<AdditionalRecipient> additionalRecipients) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<AdditionalRecipient>	getAdditionalRecipients() Getter for AdditionalRecipients.
Money	getAmountMoney() Getter for AmountMoney.
String	getCreatedAt() Getter for CreatedAt.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
Money	getProcessingFeeMoney() Getter for ProcessingFeeMoney.
String	getReason() Getter for Reason.
String	getStatus() Getter for Status.
String	getTenderId() Getter for TenderId.
String	getTransactionId() Getter for TransactionId.
int	hashCode()
Refund.Builder	toBuilder() Builds a new Refund.Builder object.
String	toString() Converts this Refund into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Refund

public Refund(String id,
              String locationId,
              String tenderId,
              String reason,
              Money amountMoney,
              String status,
              String transactionId,
              String createdAt,
              Money processingFeeMoney,
              List<AdditionalRecipient> additionalRecipients)

Initialization constructor.

Parameters:

id - String value for id.

locationId - String value for locationId.

tenderId - String value for tenderId.

reason - String value for reason.

amountMoney - Money value for amountMoney.

status - String value for status.

transactionId - String value for transactionId.

createdAt - String value for createdAt.

processingFeeMoney - Money value for processingFeeMoney.

additionalRecipients - List of AdditionalRecipient value for additionalRecipients.

Method Detail

getId

public String getId()

Getter for Id. The refund's unique ID.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the refund's associated location.

Returns:

Returns the String

getTransactionId

public String getTransactionId()

Getter for TransactionId. The ID of the transaction that the refunded tender is part of.

Returns:

Returns the String

getTenderId

public String getTenderId()

Getter for TenderId. The ID of the refunded tender.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp for when the refund was created, in RFC 3339 format.

Returns:

Returns the String

getReason

public String getReason()

Getter for Reason. The reason for the refund being issued.

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

getStatus

public String getStatus()

Getter for Status. Indicates a refund's current status.

Returns:

Returns the String

getProcessingFeeMoney

public Money getProcessingFeeMoney()

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

getAdditionalRecipients

public List<AdditionalRecipient> getAdditionalRecipients()

Getter for AdditionalRecipients. Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.

Returns:

Returns the List of AdditionalRecipient

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Refund.Builder toBuilder()

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

Returns:

a new Refund.Builder object