com.squareup.square.models

Class CreateRefundRequest

java.lang.Object

com.squareup.square.models.CreateRefundRequest

public class CreateRefundRequest
extends Object

This is a model class for CreateRefundRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateRefundRequest(String idempotencyKey, String tenderId, Money amountMoney, String reason) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
String	getIdempotencyKey() Getter for IdempotencyKey.
String	getReason() Getter for Reason.
String	getTenderId() Getter for TenderId.
int	hashCode()
CreateRefundRequest.Builder	toBuilder() Builds a new CreateRefundRequest.Builder object.
String	toString() Converts this CreateRefundRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateRefundRequest

public CreateRefundRequest(String idempotencyKey,
                           String tenderId,
                           Money amountMoney,
                           String reason)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

tenderId - String value for tenderId.

amountMoney - Money value for amountMoney.

reason - String value for reason.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.

Returns:

Returns the String

getTenderId

public String getTenderId()

Getter for TenderId. The ID of the tender to refund. A [`Transaction`]($m/Transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API.

Returns:

Returns the String

getReason

public String getReason()

Getter for Reason. A description of the reason for the refund. Default value: `Refund via API`

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

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateRefundRequest.Builder toBuilder()

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

Returns:

a new CreateRefundRequest.Builder object