com.squareup.square.models

Class PaymentRefund

java.lang.Object

com.squareup.square.models.PaymentRefund

public class PaymentRefund
extends Object

This is a model class for PaymentRefund type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PaymentRefund(String id, Money amountMoney, String status, String locationId, Money appFeeMoney, List<ProcessingFee> processingFee, String paymentId, String orderId, String reason, String createdAt, String updatedAt, String teamMemberId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
Money	getAppFeeMoney() Getter for AppFeeMoney.
String	getCreatedAt() Getter for CreatedAt.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getOrderId() Getter for OrderId.
String	getPaymentId() Getter for PaymentId.
List<ProcessingFee>	getProcessingFee() Getter for ProcessingFee.
String	getReason() Getter for Reason.
String	getStatus() Getter for Status.
String	getTeamMemberId() Getter for TeamMemberId.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
PaymentRefund.Builder	toBuilder() Builds a new PaymentRefund.Builder object.
String	toString() Converts this PaymentRefund into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentRefund

public PaymentRefund(String id,
                     Money amountMoney,
                     String status,
                     String locationId,
                     Money appFeeMoney,
                     List<ProcessingFee> processingFee,
                     String paymentId,
                     String orderId,
                     String reason,
                     String createdAt,
                     String updatedAt,
                     String teamMemberId)

Initialization constructor.

Parameters:

id - String value for id.

amountMoney - Money value for amountMoney.

status - String value for status.

locationId - String value for locationId.

appFeeMoney - Money value for appFeeMoney.

processingFee - List of ProcessingFee value for processingFee.

paymentId - String value for paymentId.

orderId - String value for orderId.

reason - String value for reason.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

teamMemberId - String value for teamMemberId.

Method Detail

getId

public String getId()

Getter for Id. The unique ID for this refund, generated by Square.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. The refund's status: - `PENDING` - Awaiting approval. - `COMPLETED` - Successfully completed. - `REJECTED` - The refund was rejected. - `FAILED` - An error occurred.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The location ID associated with the payment this refund is attached to.

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

getAppFeeMoney

public Money getAppFeeMoney()

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

getProcessingFee

public List<ProcessingFee> getProcessingFee()

Getter for ProcessingFee. Processing fees and fee adjustments assessed by Square for this refund.

Returns:

Returns the List of ProcessingFee

getPaymentId

public String getPaymentId()

Getter for PaymentId. The ID of the payment associated with this refund.

Returns:

Returns the String

getOrderId

public String getOrderId()

Getter for OrderId. The ID of the order associated with the refund.

Returns:

Returns the String

getReason

public String getReason()

Getter for Reason. The reason for the refund.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

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

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp of when the refund was last updated, in RFC 3339 format.

Returns:

Returns the String

getTeamMemberId

public String getTeamMemberId()

Getter for TeamMemberId. An optional ID of the team member associated with taking the payment.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PaymentRefund.Builder toBuilder()

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

Returns:

a new PaymentRefund.Builder object