com.squareup.square.models

Class TerminalRefund

java.lang.Object

com.squareup.square.models.TerminalRefund

public class TerminalRefund
extends Object

This is a model class for TerminalRefund type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
TerminalRefund(String paymentId, Money amountMoney, String reason, String deviceId, String id, String refundId, String orderId, String deadlineDuration, String status, String cancelReason, String createdAt, String updatedAt, String appId, String locationId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
String	getAppId() Getter for AppId.
String	getCancelReason() Getter for CancelReason.
String	getCreatedAt() Getter for CreatedAt.
String	getDeadlineDuration() Getter for DeadlineDuration.
String	getDeviceId() Getter for DeviceId.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getOrderId() Getter for OrderId.
String	getPaymentId() Getter for PaymentId.
String	getReason() Getter for Reason.
String	getRefundId() Getter for RefundId.
String	getStatus() Getter for Status.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
TerminalRefund.Builder	toBuilder() Builds a new TerminalRefund.Builder object.
String	toString() Converts this TerminalRefund into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminalRefund

public TerminalRefund(String paymentId,
                      Money amountMoney,
                      String reason,
                      String deviceId,
                      String id,
                      String refundId,
                      String orderId,
                      String deadlineDuration,
                      String status,
                      String cancelReason,
                      String createdAt,
                      String updatedAt,
                      String appId,
                      String locationId)

Initialization constructor.

Parameters:

paymentId - String value for paymentId.

amountMoney - Money value for amountMoney.

reason - String value for reason.

deviceId - String value for deviceId.

id - String value for id.

refundId - String value for refundId.

orderId - String value for orderId.

deadlineDuration - String value for deadlineDuration.

status - String value for status.

cancelReason - String value for cancelReason.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

appId - String value for appId.

locationId - String value for locationId.

Method Detail

getId

public String getId()

Getter for Id. A unique ID for this `TerminalRefund`.

Returns:

Returns the String

getRefundId

public String getRefundId()

Getter for RefundId. The reference to the payment refund created by completing this `TerminalRefund`.

Returns:

Returns the String

getPaymentId

public String getPaymentId()

Getter for PaymentId. The unique ID of the payment being refunded.

Returns:

Returns the String

getOrderId

public String getOrderId()

Getter for OrderId. The reference to the Square order ID for the payment identified by the `payment_id`.

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

getReason

public String getReason()

Getter for Reason. A description of the reason for the refund.

Returns:

Returns the String

getDeviceId

public String getDeviceId()

Getter for DeviceId. The unique ID of the device intended for this `TerminalRefund`. The Id can be retrieved from /v2/devices api.

Returns:

Returns the String

getDeadlineDuration

public String getDeadlineDuration()

Getter for DeadlineDuration. The RFC 3339 duration, after which the refund is automatically canceled. A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason of `TIMED_OUT`. Default: 5 minutes from creation. Maximum: 5 minutes

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. The status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.

Returns:

Returns the String

getCancelReason

public String getCancelReason()

Getter for CancelReason.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The time when the `TerminalRefund` was created, as an RFC 3339 timestamp.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp.

Returns:

Returns the String

getAppId

public String getAppId()

Getter for AppId. The ID of the application that created the refund.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The location of the device where the `TerminalRefund` was directed.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public TerminalRefund.Builder toBuilder()

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

Returns:

a new TerminalRefund.Builder object