com.squareup.square.models

Class RefundPaymentRequest

java.lang.Object

com.squareup.square.models.RefundPaymentRequest

public class RefundPaymentRequest
extends Object

This is a model class for RefundPaymentRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RefundPaymentRequest(String idempotencyKey, Money amountMoney, Money appFeeMoney, String paymentId, String reason, String paymentVersionToken, 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	getIdempotencyKey() Getter for IdempotencyKey.
String	getPaymentId() Getter for PaymentId.
String	getPaymentVersionToken() Getter for PaymentVersionToken.
String	getReason() Getter for Reason.
String	getTeamMemberId() Getter for TeamMemberId.
int	hashCode()
RefundPaymentRequest.Builder	toBuilder() Builds a new RefundPaymentRequest.Builder object.
String	toString() Converts this RefundPaymentRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefundPaymentRequest

public RefundPaymentRequest(String idempotencyKey,
                            Money amountMoney,
                            Money appFeeMoney,
                            String paymentId,
                            String reason,
                            String paymentVersionToken,
                            String teamMemberId)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

amountMoney - Money value for amountMoney.

appFeeMoney - Money value for appFeeMoney.

paymentId - String value for paymentId.

reason - String value for reason.

paymentVersionToken - String value for paymentVersionToken.

teamMemberId - String value for teamMemberId.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies this `RefundPayment` request. The key can be any valid string but must be unique for every `RefundPayment` request. Keys are limited to a max of 45 characters - however, the number of allowed characters might be less than 45, if multi-byte characters are used. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).

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

getPaymentId

public String getPaymentId()

Getter for PaymentId. The unique ID of the payment being refunded. Must be provided and non-empty.

Returns:

Returns the String

getReason

public String getReason()

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

Returns:

Returns the String

getPaymentVersionToken

public String getPaymentVersionToken()

Getter for PaymentVersionToken. Used for optimistic concurrency. This opaque token identifies the current `Payment` version that the caller expects. If the server has a different version of the Payment, the update fails and a response with a VERSION_MISMATCH error is returned. If the versions match, or the field is not provided, the refund proceeds as normal.

Returns:

Returns the String

getTeamMemberId

public String getTeamMemberId()

Getter for TeamMemberId. An optional [TeamMember]($m/TeamMember) ID to associate with this refund.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public RefundPaymentRequest.Builder toBuilder()

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

Returns:

a new RefundPaymentRequest.Builder object