com.squareup.square.models

Class V1CreateRefundRequest

java.lang.Object

com.squareup.square.models.V1CreateRefundRequest

public class V1CreateRefundRequest
extends Object

This is a model class for V1CreateRefundRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
V1CreateRefundRequest(String paymentId, String type, String reason, V1Money refundedMoney, String requestIdempotenceKey) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPaymentId() Getter for PaymentId.
String	getReason() Getter for Reason.
V1Money	getRefundedMoney() Getter for RefundedMoney.
String	getRequestIdempotenceKey() Getter for RequestIdempotenceKey.
String	getType() Getter for Type.
int	hashCode()
V1CreateRefundRequest.Builder	toBuilder() Builds a new V1CreateRefundRequest.Builder object.
String	toString() Converts this V1CreateRefundRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

V1CreateRefundRequest

public V1CreateRefundRequest(String paymentId,
                             String type,
                             String reason,
                             V1Money refundedMoney,
                             String requestIdempotenceKey)

Initialization constructor.

Parameters:

paymentId - String value for paymentId.

type - String value for type.

reason - String value for reason.

refundedMoney - V1Money value for refundedMoney.

requestIdempotenceKey - String value for requestIdempotenceKey.

Method Detail

getPaymentId

public String getPaymentId()

Getter for PaymentId. The ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund.

Returns:

Returns the String

getType

public String getType()

Getter for Type.

Returns:

Returns the String

getReason

public String getReason()

Getter for Reason. The reason for the refund.

Returns:

Returns the String

getRefundedMoney

public V1Money getRefundedMoney()

Getter for RefundedMoney.

Returns:

Returns the V1Money

getRequestIdempotenceKey

public String getRequestIdempotenceKey()

Getter for RequestIdempotenceKey. An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public V1CreateRefundRequest.Builder toBuilder()

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

Returns:

a new V1CreateRefundRequest.Builder object