public class Refund extends GenericParcelable implements Validator, JSONifiable
id
orderRef
device
amount
taxAmount
tipAmount
createdTime
clientCreatedTime
gatewayProcessingTime
payment
employee
lineItems
overrideMerchantTender
taxableAmountRates
serviceChargeAmount
additionalCharges
attributes
germanInfo
appTracking
voided
voidReason
cardTransaction
transactionInfo
merchant
externalReferenceId
authCode
status
oceanGatewayInfo
reason
Modifier and Type | Class and Description |
---|---|
static interface |
Refund.Constraints |
JSONifiable.Creator<T>
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static Parcelable.Creator<Refund> |
CREATOR |
static JSONifiable.Creator<Refund> |
JSON_CREATOR |
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
Modifier | Constructor and Description |
---|---|
|
Refund()
Constructs a new empty instance.
|
protected |
Refund(boolean noInit)
Constructs a new empty instance.
|
|
Refund(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be
reflected in this instance and vice-versa.
|
|
Refund(Refund src)
Constructs a new instance that is a deep copy of the source instance.
|
|
Refund(String json)
Constructs a new instance from the given JSON String.
|
Modifier and Type | Method and Description |
---|---|
void |
clearAdditionalCharges()
Clears the 'additionalCharges' field, the 'has' method for this field will now return false
|
void |
clearAmount()
Clears the 'amount' field, the 'has' method for this field will now return false
|
void |
clearAppTracking()
Clears the 'appTracking' field, the 'has' method for this field will now return false
|
void |
clearAttributes()
Clears the 'attributes' field, the 'has' method for this field will now return false
|
void |
clearAuthCode()
Clears the 'authCode' field, the 'has' method for this field will now return false
|
void |
clearCardTransaction()
Clears the 'cardTransaction' field, the 'has' method for this field will now return false
|
void |
clearClientCreatedTime()
Clears the 'clientCreatedTime' field, the 'has' method for this field will now return false
|
void |
clearCreatedTime()
Clears the 'createdTime' field, the 'has' method for this field will now return false
|
void |
clearDevice()
Clears the 'device' field, the 'has' method for this field will now return false
|
void |
clearEmployee()
Clears the 'employee' field, the 'has' method for this field will now return false
|
void |
clearExternalReferenceId()
Clears the 'externalReferenceId' field, the 'has' method for this field will now return false
|
void |
clearGatewayProcessingTime()
Clears the 'gatewayProcessingTime' field, the 'has' method for this field will now return false
|
void |
clearGermanInfo()
Clears the 'germanInfo' field, the 'has' method for this field will now return false
|
void |
clearId()
Clears the 'id' field, the 'has' method for this field will now return false
|
void |
clearLineItems()
Clears the 'lineItems' field, the 'has' method for this field will now return false
|
void |
clearMerchant()
Clears the 'merchant' field, the 'has' method for this field will now return false
|
void |
clearOceanGatewayInfo()
Clears the 'oceanGatewayInfo' field, the 'has' method for this field will now return false
|
void |
clearOrderRef()
Clears the 'orderRef' field, the 'has' method for this field will now return false
|
void |
clearOverrideMerchantTender()
Clears the 'overrideMerchantTender' field, the 'has' method for this field will now return false
|
void |
clearPayment()
Clears the 'payment' field, the 'has' method for this field will now return false
|
void |
clearReason()
Clears the 'reason' field, the 'has' method for this field will now return false
|
void |
clearServiceChargeAmount()
Clears the 'serviceChargeAmount' field, the 'has' method for this field will now return false
|
void |
clearStatus()
Clears the 'status' field, the 'has' method for this field will now return false
|
void |
clearTaxableAmountRates()
Clears the 'taxableAmountRates' field, the 'has' method for this field will now return false
|
void |
clearTaxAmount()
Clears the 'taxAmount' field, the 'has' method for this field will now return false
|
void |
clearTipAmount()
Clears the 'tipAmount' field, the 'has' method for this field will now return false
|
void |
clearTransactionInfo()
Clears the 'transactionInfo' field, the 'has' method for this field will now return false
|
void |
clearVoided()
Clears the 'voided' field, the 'has' method for this field will now return false
|
void |
clearVoidReason()
Clears the 'voidReason' field, the 'has' method for this field will now return false
|
boolean |
containsChanges()
Returns true if this instance has any changes.
|
Refund |
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
|
List<AdditionalChargeAmount> |
getAdditionalCharges() |
Long |
getAmount()
Total amount refunded, including tax and tip
|
AppTracking |
getAppTracking()
Tracking information for the app that created this refund.
|
Map<String,String> |
getAttributes() |
String |
getAuthCode()
Auth code generated by the acquire
|
CardTransaction |
getCardTransaction()
Information about the card used for credit or debit card refunds
|
Long |
getClientCreatedTime()
The time when the refund was recorded on the client
|
Long |
getCreatedTime()
The time when the refund was recorded on the server
|
Reference |
getDevice()
Device which processed the transaction for this refund, a 128-bit UUID, not a normal base-13 Clover ID.
|
Reference |
getEmployee() |
String |
getExternalReferenceId()
The external reference id if associated with the refund
|
Long |
getGatewayProcessingTime()
The time when the refund was processed by the gateway
|
protected GenericClient |
getGenericClient() |
GermanInfo |
getGermanInfo()
German region-specific information
|
String |
getId()
Unique identifier
|
JSONObject |
getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be
reflected in this instance and vice-versa.
|
List<Reference> |
getLineItems() |
Reference |
getMerchant() |
OceanGatewayInfo |
getOceanGatewayInfo()
Ocean Gateway info - for India region
|
Reference |
getOrderRef()
The order with which the refund is associated
|
Tender |
getOverrideMerchantTender()
The tender type associated with this payment, e.g.
|
Reference |
getPayment()
The payment with which the refund is associated
|
String |
getReason()
Reason why the refund was initiated
|
ServiceChargeAmount |
getServiceChargeAmount() |
RefundStatus |
getStatus()
Status of the refund.It can be Fail/Success/Pending
|
List<TaxableAmountRate> |
getTaxableAmountRates() |
Long |
getTaxAmount()
Tax amount refunded
|
Long |
getTipAmount()
Tip amount refunded
|
TransactionInfo |
getTransactionInfo()
Transaction information
|
Boolean |
getVoided() |
String |
getVoidReason() |
boolean |
hasAdditionalCharges()
Checks whether the 'additionalCharges' field has been set, however the value could be null
|
boolean |
hasAmount()
Checks whether the 'amount' field has been set, however the value could be null
|
boolean |
hasAppTracking()
Checks whether the 'appTracking' field has been set, however the value could be null
|
boolean |
hasAttributes()
Checks whether the 'attributes' field has been set, however the value could be null
|
boolean |
hasAuthCode()
Checks whether the 'authCode' field has been set, however the value could be null
|
boolean |
hasCardTransaction()
Checks whether the 'cardTransaction' field has been set, however the value could be null
|
boolean |
hasClientCreatedTime()
Checks whether the 'clientCreatedTime' field has been set, however the value could be null
|
boolean |
hasCreatedTime()
Checks whether the 'createdTime' field has been set, however the value could be null
|
boolean |
hasDevice()
Checks whether the 'device' field has been set, however the value could be null
|
boolean |
hasEmployee()
Checks whether the 'employee' field has been set, however the value could be null
|
boolean |
hasExternalReferenceId()
Checks whether the 'externalReferenceId' field has been set, however the value could be null
|
boolean |
hasGatewayProcessingTime()
Checks whether the 'gatewayProcessingTime' field has been set, however the value could be null
|
boolean |
hasGermanInfo()
Checks whether the 'germanInfo' field has been set, however the value could be null
|
boolean |
hasId()
Checks whether the 'id' field has been set, however the value could be null
|
boolean |
hasLineItems()
Checks whether the 'lineItems' field has been set, however the value could be null
|
boolean |
hasMerchant()
Checks whether the 'merchant' field has been set, however the value could be null
|
boolean |
hasOceanGatewayInfo()
Checks whether the 'oceanGatewayInfo' field has been set, however the value could be null
|
boolean |
hasOrderRef()
Checks whether the 'orderRef' field has been set, however the value could be null
|
boolean |
hasOverrideMerchantTender()
Checks whether the 'overrideMerchantTender' field has been set, however the value could be null
|
boolean |
hasPayment()
Checks whether the 'payment' field has been set, however the value could be null
|
boolean |
hasReason()
Checks whether the 'reason' field has been set, however the value could be null
|
boolean |
hasServiceChargeAmount()
Checks whether the 'serviceChargeAmount' field has been set, however the value could be null
|
boolean |
hasStatus()
Checks whether the 'status' field has been set, however the value could be null
|
boolean |
hasTaxableAmountRates()
Checks whether the 'taxableAmountRates' field has been set, however the value could be null
|
boolean |
hasTaxAmount()
Checks whether the 'taxAmount' field has been set, however the value could be null
|
boolean |
hasTipAmount()
Checks whether the 'tipAmount' field has been set, however the value could be null
|
boolean |
hasTransactionInfo()
Checks whether the 'transactionInfo' field has been set, however the value could be null
|
boolean |
hasVoided()
Checks whether the 'voided' field has been set, however the value could be null
|
boolean |
hasVoidReason()
Checks whether the 'voidReason' field has been set, however the value could be null
|
boolean |
isNotEmptyAdditionalCharges()
Checks whether the 'additionalCharges' field is set and is not null and is not empty
|
boolean |
isNotEmptyAttributes()
Checks whether the 'attributes' field is set and is not null and is not empty
|
boolean |
isNotEmptyLineItems()
Checks whether the 'lineItems' field is set and is not null and is not empty
|
boolean |
isNotEmptyTaxableAmountRates()
Checks whether the 'taxableAmountRates' field is set and is not null and is not empty
|
boolean |
isNotNullAdditionalCharges()
Checks whether the 'additionalCharges' field is set and is not null
|
boolean |
isNotNullAmount()
Checks whether the 'amount' field is set and is not null
|
boolean |
isNotNullAppTracking()
Checks whether the 'appTracking' field is set and is not null
|
boolean |
isNotNullAttributes()
Checks whether the 'attributes' field is set and is not null
|
boolean |
isNotNullAuthCode()
Checks whether the 'authCode' field is set and is not null
|
boolean |
isNotNullCardTransaction()
Checks whether the 'cardTransaction' field is set and is not null
|
boolean |
isNotNullClientCreatedTime()
Checks whether the 'clientCreatedTime' field is set and is not null
|
boolean |
isNotNullCreatedTime()
Checks whether the 'createdTime' field is set and is not null
|
boolean |
isNotNullDevice()
Checks whether the 'device' field is set and is not null
|
boolean |
isNotNullEmployee()
Checks whether the 'employee' field is set and is not null
|
boolean |
isNotNullExternalReferenceId()
Checks whether the 'externalReferenceId' field is set and is not null
|
boolean |
isNotNullGatewayProcessingTime()
Checks whether the 'gatewayProcessingTime' field is set and is not null
|
boolean |
isNotNullGermanInfo()
Checks whether the 'germanInfo' field is set and is not null
|
boolean |
isNotNullId()
Checks whether the 'id' field is set and is not null
|
boolean |
isNotNullLineItems()
Checks whether the 'lineItems' field is set and is not null
|
boolean |
isNotNullMerchant()
Checks whether the 'merchant' field is set and is not null
|
boolean |
isNotNullOceanGatewayInfo()
Checks whether the 'oceanGatewayInfo' field is set and is not null
|
boolean |
isNotNullOrderRef()
Checks whether the 'orderRef' field is set and is not null
|
boolean |
isNotNullOverrideMerchantTender()
Checks whether the 'overrideMerchantTender' field is set and is not null
|
boolean |
isNotNullPayment()
Checks whether the 'payment' field is set and is not null
|
boolean |
isNotNullReason()
Checks whether the 'reason' field is set and is not null
|
boolean |
isNotNullServiceChargeAmount()
Checks whether the 'serviceChargeAmount' field is set and is not null
|
boolean |
isNotNullStatus()
Checks whether the 'status' field is set and is not null
|
boolean |
isNotNullTaxableAmountRates()
Checks whether the 'taxableAmountRates' field is set and is not null
|
boolean |
isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not null
|
boolean |
isNotNullTipAmount()
Checks whether the 'tipAmount' field is set and is not null
|
boolean |
isNotNullTransactionInfo()
Checks whether the 'transactionInfo' field is set and is not null
|
boolean |
isNotNullVoided()
Checks whether the 'voided' field is set and is not null
|
boolean |
isNotNullVoidReason()
Checks whether the 'voidReason' field is set and is not null
|
void |
mergeChanges(Refund src)
Copy all the changed fields from the given source to this instance.
|
void |
resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
|
Refund |
setAdditionalCharges(List<AdditionalChargeAmount> additionalCharges)
Sets the field 'additionalCharges'.
|
Refund |
setAmount(Long amount)
Sets the field 'amount'.
|
Refund |
setAppTracking(AppTracking appTracking)
Sets the field 'appTracking'.
|
Refund |
setAttributes(Map<String,String> attributes)
Sets the field 'attributes'.
|
Refund |
setAuthCode(String authCode)
Sets the field 'authCode'.
|
Refund |
setCardTransaction(CardTransaction cardTransaction)
Sets the field 'cardTransaction'.
|
Refund |
setClientCreatedTime(Long clientCreatedTime)
Sets the field 'clientCreatedTime'.
|
Refund |
setCreatedTime(Long createdTime)
Sets the field 'createdTime'.
|
Refund |
setDevice(Reference device)
Sets the field 'device'.
|
Refund |
setEmployee(Reference employee)
Sets the field 'employee'.
|
Refund |
setExternalReferenceId(String externalReferenceId)
Sets the field 'externalReferenceId'.
|
Refund |
setGatewayProcessingTime(Long gatewayProcessingTime)
Sets the field 'gatewayProcessingTime'.
|
Refund |
setGermanInfo(GermanInfo germanInfo)
Sets the field 'germanInfo'.
|
Refund |
setId(String id)
Sets the field 'id'.
|
Refund |
setLineItems(List<Reference> lineItems)
Sets the field 'lineItems'.
|
Refund |
setMerchant(Reference merchant)
Sets the field 'merchant'.
|
Refund |
setOceanGatewayInfo(OceanGatewayInfo oceanGatewayInfo)
Sets the field 'oceanGatewayInfo'.
|
Refund |
setOrderRef(Reference orderRef)
Sets the field 'orderRef'.
|
Refund |
setOverrideMerchantTender(Tender overrideMerchantTender)
Sets the field 'overrideMerchantTender'.
|
Refund |
setPayment(Reference payment)
Sets the field 'payment'.
|
Refund |
setReason(String reason)
Sets the field 'reason'.
|
Refund |
setServiceChargeAmount(ServiceChargeAmount serviceChargeAmount)
Sets the field 'serviceChargeAmount'.
|
Refund |
setStatus(RefundStatus status)
Sets the field 'status'.
|
Refund |
setTaxableAmountRates(List<TaxableAmountRate> taxableAmountRates)
Sets the field 'taxableAmountRates'.
|
Refund |
setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.
|
Refund |
setTipAmount(Long tipAmount)
Sets the field 'tipAmount'.
|
Refund |
setTransactionInfo(TransactionInfo transactionInfo)
Sets the field 'transactionInfo'.
|
Refund |
setVoided(Boolean voided)
Sets the field 'voided'.
|
Refund |
setVoidReason(String voidReason)
Sets the field 'voidReason'.
|
void |
validate() |
describeContents, getBundle, toString, writeToParcel
public static final Parcelable.Creator<Refund> CREATOR
public static final JSONifiable.Creator<Refund> JSON_CREATOR
public Refund()
protected Refund(boolean noInit)
public Refund(String json) throws IllegalArgumentException
IllegalArgumentException
public Refund(JSONObject jsonObject)
public Refund(Refund src)
public String getId()
public Reference getOrderRef()
public Reference getDevice()
public Long getAmount()
public Long getTaxAmount()
public Long getTipAmount()
public Long getCreatedTime()
public Long getClientCreatedTime()
public Long getGatewayProcessingTime()
public Reference getPayment()
public Reference getEmployee()
public Tender getOverrideMerchantTender()
public List<TaxableAmountRate> getTaxableAmountRates()
public ServiceChargeAmount getServiceChargeAmount()
public List<AdditionalChargeAmount> getAdditionalCharges()
public GermanInfo getGermanInfo()
public AppTracking getAppTracking()
public Boolean getVoided()
public String getVoidReason()
public CardTransaction getCardTransaction()
public TransactionInfo getTransactionInfo()
public Reference getMerchant()
public String getExternalReferenceId()
public String getAuthCode()
public RefundStatus getStatus()
public OceanGatewayInfo getOceanGatewayInfo()
public String getReason()
protected GenericClient getGenericClient()
getGenericClient
in class GenericParcelable
public JSONObject getJSONObject()
getJSONObject
in interface JSONifiable
public boolean isNotNullId()
public boolean isNotNullOrderRef()
public boolean isNotNullDevice()
public boolean isNotNullAmount()
public boolean isNotNullTaxAmount()
public boolean isNotNullTipAmount()
public boolean isNotNullCreatedTime()
public boolean isNotNullClientCreatedTime()
public boolean isNotNullGatewayProcessingTime()
public boolean isNotNullPayment()
public boolean isNotNullEmployee()
public boolean isNotNullLineItems()
public boolean isNotEmptyLineItems()
public boolean isNotNullOverrideMerchantTender()
public boolean isNotNullTaxableAmountRates()
public boolean isNotEmptyTaxableAmountRates()
public boolean isNotNullServiceChargeAmount()
public boolean isNotNullAdditionalCharges()
public boolean isNotEmptyAdditionalCharges()
public boolean isNotNullAttributes()
public boolean isNotEmptyAttributes()
public boolean isNotNullGermanInfo()
public boolean isNotNullAppTracking()
public boolean isNotNullVoided()
public boolean isNotNullVoidReason()
public boolean isNotNullCardTransaction()
public boolean isNotNullTransactionInfo()
public boolean isNotNullMerchant()
public boolean isNotNullExternalReferenceId()
public boolean isNotNullAuthCode()
public boolean isNotNullStatus()
public boolean isNotNullOceanGatewayInfo()
public boolean isNotNullReason()
public boolean hasId()
public boolean hasOrderRef()
public boolean hasDevice()
public boolean hasAmount()
public boolean hasTaxAmount()
public boolean hasTipAmount()
public boolean hasCreatedTime()
public boolean hasClientCreatedTime()
public boolean hasGatewayProcessingTime()
public boolean hasPayment()
public boolean hasEmployee()
public boolean hasLineItems()
public boolean hasOverrideMerchantTender()
public boolean hasTaxableAmountRates()
public boolean hasServiceChargeAmount()
public boolean hasAdditionalCharges()
public boolean hasAttributes()
public boolean hasGermanInfo()
public boolean hasAppTracking()
public boolean hasVoided()
public boolean hasVoidReason()
public boolean hasCardTransaction()
public boolean hasTransactionInfo()
public boolean hasMerchant()
public boolean hasExternalReferenceId()
public boolean hasAuthCode()
public boolean hasStatus()
public boolean hasOceanGatewayInfo()
public boolean hasReason()
public Refund setOrderRef(Reference orderRef)
public Refund setDevice(Reference device)
public Refund setClientCreatedTime(Long clientCreatedTime)
public Refund setGatewayProcessingTime(Long gatewayProcessingTime)
public Refund setPayment(Reference payment)
public Refund setEmployee(Reference employee)
public Refund setLineItems(List<Reference> lineItems)
public Refund setOverrideMerchantTender(Tender overrideMerchantTender)
public Refund setTaxableAmountRates(List<TaxableAmountRate> taxableAmountRates)
public Refund setServiceChargeAmount(ServiceChargeAmount serviceChargeAmount)
public Refund setAdditionalCharges(List<AdditionalChargeAmount> additionalCharges)
public Refund setAttributes(Map<String,String> attributes)
public Refund setGermanInfo(GermanInfo germanInfo)
public Refund setAppTracking(AppTracking appTracking)
public Refund setCardTransaction(CardTransaction cardTransaction)
public Refund setTransactionInfo(TransactionInfo transactionInfo)
public Refund setMerchant(Reference merchant)
public Refund setExternalReferenceId(String externalReferenceId)
public Refund setStatus(RefundStatus status)
public Refund setOceanGatewayInfo(OceanGatewayInfo oceanGatewayInfo)
public void clearId()
public void clearOrderRef()
public void clearDevice()
public void clearAmount()
public void clearTaxAmount()
public void clearTipAmount()
public void clearCreatedTime()
public void clearClientCreatedTime()
public void clearGatewayProcessingTime()
public void clearPayment()
public void clearEmployee()
public void clearLineItems()
public void clearOverrideMerchantTender()
public void clearTaxableAmountRates()
public void clearServiceChargeAmount()
public void clearAdditionalCharges()
public void clearAttributes()
public void clearGermanInfo()
public void clearAppTracking()
public void clearVoided()
public void clearVoidReason()
public void clearCardTransaction()
public void clearTransactionInfo()
public void clearMerchant()
public void clearExternalReferenceId()
public void clearAuthCode()
public void clearStatus()
public void clearOceanGatewayInfo()
public void clearReason()
public boolean containsChanges()
public void resetChangeLog()
public Refund copyChanges()
public void mergeChanges(Refund src)