com.squareup.square.models

Class V1Refund

java.lang.Object

com.squareup.square.models.V1Refund

public class V1Refund
extends Object

This is a model class for V1Refund type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	V1Refund(String type, io.apimatic.core.types.OptionalNullable<String> reason, V1Money refundedMoney, V1Money refundedProcessingFeeMoney, V1Money refundedTaxMoney, V1Money refundedAdditiveTaxMoney, io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> refundedAdditiveTax, V1Money refundedInclusiveTaxMoney, io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> refundedInclusiveTax, V1Money refundedTipMoney, V1Money refundedDiscountMoney, V1Money refundedSurchargeMoney, io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>> refundedSurcharges, String createdAt, io.apimatic.core.types.OptionalNullable<String> processedAt, io.apimatic.core.types.OptionalNullable<String> paymentId, io.apimatic.core.types.OptionalNullable<String> merchantId, io.apimatic.core.types.OptionalNullable<Boolean> isExchange) Internal initialization constructor.
	V1Refund(String type, String reason, V1Money refundedMoney, V1Money refundedProcessingFeeMoney, V1Money refundedTaxMoney, V1Money refundedAdditiveTaxMoney, List<V1PaymentTax> refundedAdditiveTax, V1Money refundedInclusiveTaxMoney, List<V1PaymentTax> refundedInclusiveTax, V1Money refundedTipMoney, V1Money refundedDiscountMoney, V1Money refundedSurchargeMoney, List<V1PaymentSurcharge> refundedSurcharges, String createdAt, String processedAt, String paymentId, String merchantId, Boolean isExchange) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpContext	getContext()
String	getCreatedAt() Getter for CreatedAt.
Boolean	getIsExchange() Getter for IsExchange.
String	getMerchantId() Getter for MerchantId.
String	getPaymentId() Getter for PaymentId.
String	getProcessedAt() Getter for ProcessedAt.
String	getReason() Getter for Reason.
List<V1PaymentTax>	getRefundedAdditiveTax() Getter for RefundedAdditiveTax.
V1Money	getRefundedAdditiveTaxMoney() Getter for RefundedAdditiveTaxMoney.
V1Money	getRefundedDiscountMoney() Getter for RefundedDiscountMoney.
List<V1PaymentTax>	getRefundedInclusiveTax() Getter for RefundedInclusiveTax.
V1Money	getRefundedInclusiveTaxMoney() Getter for RefundedInclusiveTaxMoney.
V1Money	getRefundedMoney() Getter for RefundedMoney.
V1Money	getRefundedProcessingFeeMoney() Getter for RefundedProcessingFeeMoney.
V1Money	getRefundedSurchargeMoney() Getter for RefundedSurchargeMoney.
List<V1PaymentSurcharge>	getRefundedSurcharges() Getter for RefundedSurcharges.
V1Money	getRefundedTaxMoney() Getter for RefundedTaxMoney.
V1Money	getRefundedTipMoney() Getter for RefundedTipMoney.
String	getType() Getter for Type.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIsExchange() Internal Getter for IsExchange.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetMerchantId() Internal Getter for MerchantId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPaymentId() Internal Getter for PaymentId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetProcessedAt() Internal Getter for ProcessedAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReason() Internal Getter for Reason.
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>>	internalGetRefundedAdditiveTax() Internal Getter for RefundedAdditiveTax.
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>>	internalGetRefundedInclusiveTax() Internal Getter for RefundedInclusiveTax.
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>>	internalGetRefundedSurcharges() Internal Getter for RefundedSurcharges.
V1Refund.Builder	toBuilder() Builds a new V1Refund.Builder object.
String	toString() Converts this V1Refund into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

V1Refund

public V1Refund(String type,
                String reason,
                V1Money refundedMoney,
                V1Money refundedProcessingFeeMoney,
                V1Money refundedTaxMoney,
                V1Money refundedAdditiveTaxMoney,
                List<V1PaymentTax> refundedAdditiveTax,
                V1Money refundedInclusiveTaxMoney,
                List<V1PaymentTax> refundedInclusiveTax,
                V1Money refundedTipMoney,
                V1Money refundedDiscountMoney,
                V1Money refundedSurchargeMoney,
                List<V1PaymentSurcharge> refundedSurcharges,
                String createdAt,
                String processedAt,
                String paymentId,
                String merchantId,
                Boolean isExchange)

Initialization constructor.

Parameters:

type - String value for type.

reason - String value for reason.

refundedMoney - V1Money value for refundedMoney.

refundedProcessingFeeMoney - V1Money value for refundedProcessingFeeMoney.

refundedTaxMoney - V1Money value for refundedTaxMoney.

refundedAdditiveTaxMoney - V1Money value for refundedAdditiveTaxMoney.

refundedAdditiveTax - List of V1PaymentTax value for refundedAdditiveTax.

refundedInclusiveTaxMoney - V1Money value for refundedInclusiveTaxMoney.

refundedInclusiveTax - List of V1PaymentTax value for refundedInclusiveTax.

refundedTipMoney - V1Money value for refundedTipMoney.

refundedDiscountMoney - V1Money value for refundedDiscountMoney.

refundedSurchargeMoney - V1Money value for refundedSurchargeMoney.

refundedSurcharges - List of V1PaymentSurcharge value for refundedSurcharges.

createdAt - String value for createdAt.

processedAt - String value for processedAt.

paymentId - String value for paymentId.

merchantId - String value for merchantId.

isExchange - Boolean value for isExchange.

V1Refund

protected V1Refund(String type,
                   io.apimatic.core.types.OptionalNullable<String> reason,
                   V1Money refundedMoney,
                   V1Money refundedProcessingFeeMoney,
                   V1Money refundedTaxMoney,
                   V1Money refundedAdditiveTaxMoney,
                   io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> refundedAdditiveTax,
                   V1Money refundedInclusiveTaxMoney,
                   io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> refundedInclusiveTax,
                   V1Money refundedTipMoney,
                   V1Money refundedDiscountMoney,
                   V1Money refundedSurchargeMoney,
                   io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>> refundedSurcharges,
                   String createdAt,
                   io.apimatic.core.types.OptionalNullable<String> processedAt,
                   io.apimatic.core.types.OptionalNullable<String> paymentId,
                   io.apimatic.core.types.OptionalNullable<String> merchantId,
                   io.apimatic.core.types.OptionalNullable<Boolean> isExchange)

Internal initialization constructor.

Method Detail

getContext

public HttpContext getContext()

getType

public String getType()

Getter for Type.

Returns:

Returns the String

internalGetReason

protected io.apimatic.core.types.OptionalNullable<String> internalGetReason()

Internal Getter for Reason. The merchant-specified reason for the refund.

Returns:

Returns the Internal String

getReason

public String getReason()

Getter for Reason. The merchant-specified reason for the refund.

Returns:

Returns the String

getRefundedMoney

public V1Money getRefundedMoney()

Getter for RefundedMoney.

Returns:

Returns the V1Money

getRefundedProcessingFeeMoney

public V1Money getRefundedProcessingFeeMoney()

Getter for RefundedProcessingFeeMoney.

Returns:

Returns the V1Money

getRefundedTaxMoney

public V1Money getRefundedTaxMoney()

Getter for RefundedTaxMoney.

Returns:

Returns the V1Money

getRefundedAdditiveTaxMoney

public V1Money getRefundedAdditiveTaxMoney()

Getter for RefundedAdditiveTaxMoney.

Returns:

Returns the V1Money

internalGetRefundedAdditiveTax

protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> internalGetRefundedAdditiveTax()

Internal Getter for RefundedAdditiveTax. All of the additive taxes associated with the refund.

Returns:

Returns the Internal List of V1PaymentTax

getRefundedAdditiveTax

public List<V1PaymentTax> getRefundedAdditiveTax()

Getter for RefundedAdditiveTax. All of the additive taxes associated with the refund.

Returns:

Returns the List of V1PaymentTax

getRefundedInclusiveTaxMoney

public V1Money getRefundedInclusiveTaxMoney()

Getter for RefundedInclusiveTaxMoney.

Returns:

Returns the V1Money

internalGetRefundedInclusiveTax

protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> internalGetRefundedInclusiveTax()

Internal Getter for RefundedInclusiveTax. All of the inclusive taxes associated with the refund.

Returns:

Returns the Internal List of V1PaymentTax

getRefundedInclusiveTax

public List<V1PaymentTax> getRefundedInclusiveTax()

Getter for RefundedInclusiveTax. All of the inclusive taxes associated with the refund.

Returns:

Returns the List of V1PaymentTax

getRefundedTipMoney

public V1Money getRefundedTipMoney()

Getter for RefundedTipMoney.

Returns:

Returns the V1Money

getRefundedDiscountMoney

public V1Money getRefundedDiscountMoney()

Getter for RefundedDiscountMoney.

Returns:

Returns the V1Money

getRefundedSurchargeMoney

public V1Money getRefundedSurchargeMoney()

Getter for RefundedSurchargeMoney.

Returns:

Returns the V1Money

internalGetRefundedSurcharges

protected io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>> internalGetRefundedSurcharges()

Internal Getter for RefundedSurcharges. A list of all surcharges associated with the refund.

Returns:

Returns the Internal List of V1PaymentSurcharge

getRefundedSurcharges

public List<V1PaymentSurcharge> getRefundedSurcharges()

Getter for RefundedSurcharges. A list of all surcharges associated with the refund.

Returns:

Returns the List of V1PaymentSurcharge

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The time when the merchant initiated the refund for Square to process, in ISO 8601 format.

Returns:

Returns the String

internalGetProcessedAt

protected io.apimatic.core.types.OptionalNullable<String> internalGetProcessedAt()

Internal Getter for ProcessedAt. The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.

Returns:

Returns the Internal String

getProcessedAt

public String getProcessedAt()

Getter for ProcessedAt. The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.

Returns:

Returns the String

internalGetPaymentId

protected io.apimatic.core.types.OptionalNullable<String> internalGetPaymentId()

Internal Getter for PaymentId. A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.

Returns:

Returns the Internal String

getPaymentId

public String getPaymentId()

Getter for PaymentId. A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.

Returns:

Returns the String

internalGetMerchantId

protected io.apimatic.core.types.OptionalNullable<String> internalGetMerchantId()

Internal Getter for MerchantId.

Returns:

Returns the Internal String

getMerchantId

public String getMerchantId()

Getter for MerchantId.

Returns:

Returns the String

internalGetIsExchange

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetIsExchange()

Internal Getter for IsExchange. Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.

Returns:

Returns the Internal Boolean

getIsExchange

public Boolean getIsExchange()

Getter for IsExchange. Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.

Returns:

Returns the Boolean

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public V1Refund.Builder toBuilder()

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

Returns:

a new V1Refund.Builder object