clover-android-connector-sdk/com.clover.sdk.v3.remotepay/SaleRequest

SaleRequest

public class SaleRequest extends TransactionRequest

This is an auto-generated Clover data object.

Fields

Constructors

SaleRequest

public void SaleRequest()

Constructs a new empty instance.

public void SaleRequest(String json)

Constructs a new instance from the given JSON String.

public void SaleRequest(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.

public void SaleRequest(SaleRequest src)

Constructs a new instance that is a deep copy of the source instance.

Types

Constraints

public interface Constraints

Properties

CONTENTS_FILE_DESCRIPTOR

public final static int CONTENTS_FILE_DESCRIPTOR

CREATOR

public final static Parcelable.Creator<BaseRequest> CREATOR

public final static Parcelable.Creator<BaseTransactionRequest> CREATOR

public final static Parcelable.Creator<SaleRequest> CREATOR

public final static Parcelable.Creator<TransactionRequest> CREATOR

JSON_CREATOR

public final static JSONifiable.Creator<BaseRequest> JSON_CREATOR

public final static JSONifiable.Creator<BaseTransactionRequest> JSON_CREATOR

public final static JSONifiable.Creator<SaleRequest> JSON_CREATOR

public final static JSONifiable.Creator<TransactionRequest> JSON_CREATOR

PARCELABLE_WRITE_RETURN_VALUE

public final static int PARCELABLE_WRITE_RETURN_VALUE

Functions

clearAllowOfflinePayment

public void clearAllowOfflinePayment()

Clears the 'allowOfflinePayment' field, the 'has' method for this field will now return false

clearAmount

public void clearAmount()

Clears the 'amount' field, the 'has' method for this field will now return false

clearApproveOfflinePaymentWithoutPrompt

public void clearApproveOfflinePaymentWithoutPrompt()

Clears the 'approveOfflinePaymentWithoutPrompt' field, the 'has' method for this field will now return false

clearAutoAcceptPaymentConfirmations

public void clearAutoAcceptPaymentConfirmations()

Clears the 'autoAcceptPaymentConfirmations' field, the 'has' method for this field will now return false

clearAutoAcceptSignature

public void clearAutoAcceptSignature()

Clears the 'autoAcceptSignature' field, the 'has' method for this field will now return false

clearCardEntryMethods

public void clearCardEntryMethods()

Clears the 'cardEntryMethods' field, the 'has' method for this field will now return false

clearCardNotPresent

public void clearCardNotPresent()

Clears the 'cardNotPresent' field, the 'has' method for this field will now return false

clearDisableCashback

public void clearDisableCashback()

Clears the 'disableCashback' field, the 'has' method for this field will now return false

clearDisableDuplicateChecking

public void clearDisableDuplicateChecking()

Clears the 'disableDuplicateChecking' field, the 'has' method for this field will now return false

clearDisablePrinting

public void clearDisablePrinting()

Clears the 'disablePrinting' field, the 'has' method for this field will now return false

clearDisableReceiptSelection

public void clearDisableReceiptSelection()

Clears the 'disableReceiptSelection' field, the 'has' method for this field will now return false

clearDisableRestartTransactionOnFail

public void clearDisableRestartTransactionOnFail()

Clears the 'disableRestartTransactionOnFail' field, the 'has' method for this field will now return false

clearExternalId

public void clearExternalId()

Clears the 'externalId' field, the 'has' method for this field will now return false

clearExternalReferenceId

public void clearExternalReferenceId()

Clears the 'externalReferenceId' field, the 'has' method for this field will now return false

clearExtras

public void clearExtras()

Clears the 'extras' field, the 'has' method for this field will now return false

clearForceOfflinePayment

public void clearForceOfflinePayment()

Clears the 'forceOfflinePayment' field, the 'has' method for this field will now return false

clearOrderId

public void clearOrderId()

Clears the 'orderId' field, the 'has' method for this field will now return false

clearRegionalExtras

public void clearRegionalExtras()

Clears the 'regionalExtras' field, the 'has' method for this field will now return false

clearRequestId

public void clearRequestId()

Clears the 'requestId' field, the 'has' method for this field will now return false

clearSignatureEntryLocation

public void clearSignatureEntryLocation()

Clears the 'signatureEntryLocation' field, the 'has' method for this field will now return false

clearSignatureThreshold

public void clearSignatureThreshold()

Clears the 'signatureThreshold' field, the 'has' method for this field will now return false

clearTaxAmount

public void clearTaxAmount()

Clears the 'taxAmount' field, the 'has' method for this field will now return false

clearTipAmount

public void clearTipAmount()

Clears the 'tipAmount' field, the 'has' method for this field will now return false

clearTipMode

public void clearTipMode()

Clears the 'tipMode' field, the 'has' method for this field will now return false

clearTippableAmount

public void clearTippableAmount()

Clears the 'tippableAmount' field, the 'has' method for this field will now return false

clearTipSuggestions

public void clearTipSuggestions()

Clears the 'tipSuggestions' field, the 'has' method for this field will now return false

clearType

public void clearType()

Clears the 'type' field, the 'has' method for this field will now return false

clearVaultedCard

public void clearVaultedCard()

Clears the 'vaultedCard' field, the 'has' method for this field will now return false

clearVersion

public void clearVersion()

Clears the 'version' field, the 'has' method for this field will now return false

containsChanges

public boolean containsChanges()

Returns true if this instance has any changes.

copyChanges

public BaseRequest copyChanges()

public BaseTransactionRequest copyChanges()

public SaleRequest copyChanges()

Create a copy of this instance that contains only fields that were set after the constructor was called.

describeContents

public final int describeContents()

getAllowOfflinePayment

public Boolean getAllowOfflinePayment()

If true then offline payments can be accepted

getAmount

public Long getAmount()

Total amount paid

getApproveOfflinePaymentWithoutPrompt

public Boolean getApproveOfflinePaymentWithoutPrompt()

If true then offline payments will be approved without a prompt

getAutoAcceptPaymentConfirmations

public Boolean getAutoAcceptPaymentConfirmations()

Do not show/send potential duplicate challenges

getAutoAcceptSignature

public Boolean getAutoAcceptSignature()

Do not show/send signature verification challenges

getBundle

public final Bundle getBundle()

getCardEntryMethods

public Integer getCardEntryMethods()

Allowed entry methods

getCardNotPresent

public Boolean getCardNotPresent()

If true then card not present is accepted

getDisableCashback

public Boolean getDisableCashback()

If true, do not allow cash back

getDisableDuplicateChecking

public Boolean getDisableDuplicateChecking()

Do not do heuristic duplicate checking

getDisablePrinting

public Boolean getDisablePrinting()

If true, then do not print using the clover printer.

getDisableReceiptSelection

public Boolean getDisableReceiptSelection()

Do not show the receipt options screen

getDisableRestartTransactionOnFail

public Boolean getDisableRestartTransactionOnFail()

If the transaction times out or fails because of decline, do not restart it

getExternalId

public String getExternalId()

An id that will be persisted with transactions.

getExternalReferenceId

public String getExternalReferenceId()

An id that can be passed to the merchant's gateway, and ultimately appear in settlement records.

getExtras

public Map<String, String> getExtras()

Extra pass-through data used by external systems.

getForceOfflinePayment

public Boolean getForceOfflinePayment()

If true then the payment will be taken offline

getJSONObject

public abstract JSONObject getJSONObject()

public 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.

getOrderId

public String getOrderId()

Identifier for the order to apply this to.

getRegionalExtras

public Map<String, String> getRegionalExtras()

A map of values for regional specific data

getRequestId

public String getRequestId()

Identifier for the request

getSignatureEntryLocation

public DataEntryLocation getSignatureEntryLocation()

Where the signature should be obtained from (paper, screen...

getSignatureThreshold

public Long getSignatureThreshold()

If the amount is equal to or greater than this amount, then a signature should be obtained

getTaxAmount

public Long getTaxAmount()

Amount paid in taxes

getTipAmount

public Long getTipAmount()

Included tip

getTipMode

public TipMode getTipMode()

getTippableAmount

public Long getTippableAmount()

The total amount used when calculating tips

getTipSuggestions

public List<TipSuggestion> getTipSuggestions()

Custom Tip Suggestions that can be set per transaction

getType

public TransactionType getType()

The type of the transaction.

getVaultedCard

public VaultedCard getVaultedCard()

A saved card

getVersion

public Integer getVersion()

Identifier for the version

hasAllowOfflinePayment

public boolean hasAllowOfflinePayment()

Checks whether the 'allowOfflinePayment' field has been set, however the value could be null

hasAmount

public boolean hasAmount()

Checks whether the 'amount' field has been set, however the value could be null

hasApproveOfflinePaymentWithoutPrompt

public boolean hasApproveOfflinePaymentWithoutPrompt()

Checks whether the 'approveOfflinePaymentWithoutPrompt' field has been set, however the value could be null

hasAutoAcceptPaymentConfirmations

public boolean hasAutoAcceptPaymentConfirmations()

Checks whether the 'autoAcceptPaymentConfirmations' field has been set, however the value could be null

hasAutoAcceptSignature

public boolean hasAutoAcceptSignature()

Checks whether the 'autoAcceptSignature' field has been set, however the value could be null

hasCardEntryMethods

public boolean hasCardEntryMethods()

Checks whether the 'cardEntryMethods' field has been set, however the value could be null

hasCardNotPresent

public boolean hasCardNotPresent()

Checks whether the 'cardNotPresent' field has been set, however the value could be null

hasDisableCashback

public boolean hasDisableCashback()

Checks whether the 'disableCashback' field has been set, however the value could be null

hasDisableDuplicateChecking

public boolean hasDisableDuplicateChecking()

Checks whether the 'disableDuplicateChecking' field has been set, however the value could be null

hasDisablePrinting

public boolean hasDisablePrinting()

Checks whether the 'disablePrinting' field has been set, however the value could be null

hasDisableReceiptSelection

public boolean hasDisableReceiptSelection()

Checks whether the 'disableReceiptSelection' field has been set, however the value could be null

hasDisableRestartTransactionOnFail

public boolean hasDisableRestartTransactionOnFail()

Checks whether the 'disableRestartTransactionOnFail' field has been set, however the value could be null

hasExternalId

public boolean hasExternalId()

Checks whether the 'externalId' field has been set, however the value could be null

hasExternalReferenceId

public boolean hasExternalReferenceId()

Checks whether the 'externalReferenceId' field has been set, however the value could be null

hasExtras

public boolean hasExtras()

Checks whether the 'extras' field has been set, however the value could be null

hasForceOfflinePayment

public boolean hasForceOfflinePayment()

Checks whether the 'forceOfflinePayment' field has been set, however the value could be null

hasOrderId

public boolean hasOrderId()

Checks whether the 'orderId' field has been set, however the value could be null

hasRegionalExtras

public boolean hasRegionalExtras()

Checks whether the 'regionalExtras' field has been set, however the value could be null

hasRequestId

public boolean hasRequestId()

Checks whether the 'requestId' field has been set, however the value could be null

hasSignatureEntryLocation

public boolean hasSignatureEntryLocation()

Checks whether the 'signatureEntryLocation' field has been set, however the value could be null

hasSignatureThreshold

public boolean hasSignatureThreshold()

Checks whether the 'signatureThreshold' field has been set, however the value could be null

hasTaxAmount

public boolean hasTaxAmount()

Checks whether the 'taxAmount' field has been set, however the value could be null

hasTipAmount

public boolean hasTipAmount()

Checks whether the 'tipAmount' field has been set, however the value could be null

hasTipMode

public boolean hasTipMode()

Checks whether the 'tipMode' field has been set, however the value could be null

hasTippableAmount

public boolean hasTippableAmount()

Checks whether the 'tippableAmount' field has been set, however the value could be null

hasTipSuggestions

public boolean hasTipSuggestions()

Checks whether the 'tipSuggestions' field has been set, however the value could be null

hasType

public boolean hasType()

Checks whether the 'type' field has been set, however the value could be null

hasVaultedCard

public boolean hasVaultedCard()

Checks whether the 'vaultedCard' field has been set, however the value could be null

hasVersion

public boolean hasVersion()

Checks whether the 'version' field has been set, however the value could be null

isNotEmptyExtras

public boolean isNotEmptyExtras()

Checks whether the 'extras' field is set and is not null and is not empty

isNotEmptyRegionalExtras

public boolean isNotEmptyRegionalExtras()

Checks whether the 'regionalExtras' field is set and is not null and is not empty

isNotEmptyTipSuggestions

public boolean isNotEmptyTipSuggestions()

Checks whether the 'tipSuggestions' field is set and is not null and is not empty

isNotNullAllowOfflinePayment

public boolean isNotNullAllowOfflinePayment()

Checks whether the 'allowOfflinePayment' field is set and is not null

isNotNullAmount

public boolean isNotNullAmount()

Checks whether the 'amount' field is set and is not null

isNotNullApproveOfflinePaymentWithoutPrompt

public boolean isNotNullApproveOfflinePaymentWithoutPrompt()

Checks whether the 'approveOfflinePaymentWithoutPrompt' field is set and is not null

isNotNullAutoAcceptPaymentConfirmations

public boolean isNotNullAutoAcceptPaymentConfirmations()

Checks whether the 'autoAcceptPaymentConfirmations' field is set and is not null

isNotNullAutoAcceptSignature

public boolean isNotNullAutoAcceptSignature()

Checks whether the 'autoAcceptSignature' field is set and is not null

isNotNullCardEntryMethods

public boolean isNotNullCardEntryMethods()

Checks whether the 'cardEntryMethods' field is set and is not null

isNotNullCardNotPresent

public boolean isNotNullCardNotPresent()

Checks whether the 'cardNotPresent' field is set and is not null

isNotNullDisableCashback

public boolean isNotNullDisableCashback()

Checks whether the 'disableCashback' field is set and is not null

isNotNullDisableDuplicateChecking

public boolean isNotNullDisableDuplicateChecking()

Checks whether the 'disableDuplicateChecking' field is set and is not null

isNotNullDisablePrinting

public boolean isNotNullDisablePrinting()

Checks whether the 'disablePrinting' field is set and is not null

isNotNullDisableReceiptSelection

public boolean isNotNullDisableReceiptSelection()

Checks whether the 'disableReceiptSelection' field is set and is not null

isNotNullDisableRestartTransactionOnFail

public boolean isNotNullDisableRestartTransactionOnFail()

Checks whether the 'disableRestartTransactionOnFail' field is set and is not null

isNotNullExternalId

public boolean isNotNullExternalId()

Checks whether the 'externalId' field is set and is not null

isNotNullExternalReferenceId

public boolean isNotNullExternalReferenceId()

Checks whether the 'externalReferenceId' field is set and is not null

isNotNullExtras

public boolean isNotNullExtras()

Checks whether the 'extras' field is set and is not null

isNotNullForceOfflinePayment

public boolean isNotNullForceOfflinePayment()

Checks whether the 'forceOfflinePayment' field is set and is not null

isNotNullOrderId

public boolean isNotNullOrderId()

Checks whether the 'orderId' field is set and is not null

isNotNullRegionalExtras

public boolean isNotNullRegionalExtras()

Checks whether the 'regionalExtras' field is set and is not null

isNotNullRequestId

public boolean isNotNullRequestId()

Checks whether the 'requestId' field is set and is not null

isNotNullSignatureEntryLocation

public boolean isNotNullSignatureEntryLocation()

Checks whether the 'signatureEntryLocation' field is set and is not null

isNotNullSignatureThreshold

public boolean isNotNullSignatureThreshold()

Checks whether the 'signatureThreshold' field is set and is not null

isNotNullTaxAmount

public boolean isNotNullTaxAmount()

Checks whether the 'taxAmount' field is set and is not null

isNotNullTipAmount

public boolean isNotNullTipAmount()

Checks whether the 'tipAmount' field is set and is not null

isNotNullTipMode

public boolean isNotNullTipMode()

Checks whether the 'tipMode' field is set and is not null

isNotNullTippableAmount

public boolean isNotNullTippableAmount()

Checks whether the 'tippableAmount' field is set and is not null

isNotNullTipSuggestions

public boolean isNotNullTipSuggestions()

Checks whether the 'tipSuggestions' field is set and is not null

isNotNullType

public boolean isNotNullType()

Checks whether the 'type' field is set and is not null

isNotNullVaultedCard

public boolean isNotNullVaultedCard()

Checks whether the 'vaultedCard' field is set and is not null

isNotNullVersion

public boolean isNotNullVersion()

Checks whether the 'version' field is set and is not null

mergeChanges

public void mergeChanges(BaseRequest src)

public void mergeChanges(BaseTransactionRequest src)

public void mergeChanges(SaleRequest src)

public void mergeChanges(TransactionRequest src)

Copy all the changed fields from the given source to this instance.

resetChangeLog

public void resetChangeLog()

Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.

setAllowOfflinePayment

public TransactionRequest setAllowOfflinePayment(Boolean allowOfflinePayment)

Sets the field 'allowOfflinePayment'.

setAmount

public BaseTransactionRequest setAmount(Long amount)

Sets the field 'amount'.

setApproveOfflinePaymentWithoutPrompt

public TransactionRequest setApproveOfflinePaymentWithoutPrompt(Boolean approveOfflinePaymentWithoutPrompt)

Sets the field 'approveOfflinePaymentWithoutPrompt'.

setAutoAcceptPaymentConfirmations

public BaseTransactionRequest setAutoAcceptPaymentConfirmations(Boolean autoAcceptPaymentConfirmations)

Sets the field 'autoAcceptPaymentConfirmations'.

setAutoAcceptSignature

public TransactionRequest setAutoAcceptSignature(Boolean autoAcceptSignature)

Sets the field 'autoAcceptSignature'.

setCardEntryMethods

public BaseTransactionRequest setCardEntryMethods(Integer cardEntryMethods)

Sets the field 'cardEntryMethods'.

setCardNotPresent

public BaseTransactionRequest setCardNotPresent(Boolean cardNotPresent)

Sets the field 'cardNotPresent'.

setDisableCashback

public TransactionRequest setDisableCashback(Boolean disableCashback)

Sets the field 'disableCashback'.

setDisableDuplicateChecking

public BaseTransactionRequest setDisableDuplicateChecking(Boolean disableDuplicateChecking)

Sets the field 'disableDuplicateChecking'.

setDisablePrinting

public BaseTransactionRequest setDisablePrinting(Boolean disablePrinting)

Sets the field 'disablePrinting'.

setDisableReceiptSelection

public BaseTransactionRequest setDisableReceiptSelection(Boolean disableReceiptSelection)

Sets the field 'disableReceiptSelection'.

setDisableRestartTransactionOnFail

public BaseTransactionRequest setDisableRestartTransactionOnFail(Boolean disableRestartTransactionOnFail)

Sets the field 'disableRestartTransactionOnFail'.

setExternalId

public BaseTransactionRequest setExternalId(String externalId)

Sets the field 'externalId'.

setExternalReferenceId

public BaseTransactionRequest setExternalReferenceId(String externalReferenceId)

Sets the field 'externalReferenceId'.

setExtras

public BaseTransactionRequest setExtras(Map<String, String> extras)

Sets the field 'extras'.

setForceOfflinePayment

public TransactionRequest setForceOfflinePayment(Boolean forceOfflinePayment)

Sets the field 'forceOfflinePayment'.

setOrderId

public BaseTransactionRequest setOrderId(String orderId)

Sets the field 'orderId'.

setRegionalExtras

public BaseTransactionRequest setRegionalExtras(Map<String, String> regionalExtras)

Sets the field 'regionalExtras'.

setRequestId

public BaseRequest setRequestId(String requestId)

Sets the field 'requestId'.

setSignatureEntryLocation

public TransactionRequest setSignatureEntryLocation(DataEntryLocation signatureEntryLocation)

Sets the field 'signatureEntryLocation'.

setSignatureThreshold

public TransactionRequest setSignatureThreshold(Long signatureThreshold)

Sets the field 'signatureThreshold'.

setTaxAmount

public TransactionRequest setTaxAmount(Long taxAmount)

Sets the field 'taxAmount'.

setTipAmount

public SaleRequest setTipAmount(Long tipAmount)

Sets the field 'tipAmount'.

setTipMode

public SaleRequest setTipMode(TipMode tipMode)

Sets the field 'tipMode'.

setTippableAmount

public TransactionRequest setTippableAmount(Long tippableAmount)

Sets the field 'tippableAmount'.

setTipSuggestions

public TransactionRequest setTipSuggestions(List<TipSuggestion> tipSuggestions)

Sets the field 'tipSuggestions'.

setType

public BaseTransactionRequest setType(TransactionType type)

Sets the field 'type'.

setVaultedCard

public BaseTransactionRequest setVaultedCard(VaultedCard vaultedCard)

Sets the field 'vaultedCard'.

setVersion

public BaseRequest setVersion(Integer version)

Sets the field 'version'.

toString

public final String toString()

validate

public abstract void validate()

public void validate()

writeToParcel

public final void writeToParcel(Parcel dest, int flags)