AuthRequest

public class AuthRequest extends TransactionRequest

This is an auto-generated Clover data object.

A authorization request

Fields

Constructors

Link copied to clipboard
public void AuthRequest()
Constructs a new empty instance.
public void AuthRequest(String json)
Constructs a new instance from the given JSON String.
public void AuthRequest(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 AuthRequest(AuthRequest src)
Constructs a new instance that is a deep copy of the source instance.

Types

Link copied to clipboard
public interface Constraints

Properties

Link copied to clipboard
public final static int CONTENTS_FILE_DESCRIPTOR
Link copied to clipboard
Link copied to clipboard
public final static int PARCELABLE_WRITE_RETURN_VALUE

Functions

Link copied to clipboard
Clears the 'allowOfflinePayment' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearAmount()
Clears the 'amount' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'approveOfflinePaymentWithoutPrompt' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'autoAcceptPaymentConfirmations' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'autoAcceptSignature' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearCardEntryMethods()
Clears the 'cardEntryMethods' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearCardNotPresent()
Clears the 'cardNotPresent' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearDisableCashback()
Clears the 'disableCashback' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'disableDuplicateChecking' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearDisablePrinting()
Clears the 'disablePrinting' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'disableReceiptSelection' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'disableRestartTransactionOnFail' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearExternalId()
Clears the 'externalId' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'externalReferenceId' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearExtras()
Clears the 'extras' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'forceOfflinePayment' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearOrderId()
Clears the 'orderId' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearRegionalExtras()
Clears the 'regionalExtras' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearRequestId()
Clears the 'requestId' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'signatureEntryLocation' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'signatureThreshold' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearTaxAmount()
Clears the 'taxAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearTipMode()
Clears the 'tipMode' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearTippableAmount()
Clears the 'tippableAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearTipSuggestions()
Clears the 'tipSuggestions' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearType()
Clears the 'type' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearVaultedCard()
Clears the 'vaultedCard' field, the 'has' method for this field will now return false
Link copied to clipboard
public void clearVersion()
Clears the 'version' field, the 'has' method for this field will now return false
Link copied to clipboard
public boolean containsChanges()
Returns true if this instance has any changes.
Link copied to clipboard
Create a copy of this instance that contains only fields that were set after the constructor was called.
Link copied to clipboard
public final int describeContents()
Link copied to clipboard
If true then offline payments can be accepted
Link copied to clipboard
public Long getAmount()
Total amount paid
Link copied to clipboard
If true then offline payments will be approved without a prompt
Link copied to clipboard
Do not show/send potential duplicate challenges
Link copied to clipboard
Do not show/send signature verification challenges
Link copied to clipboard
public final Bundle getBundle()
Link copied to clipboard
Allowed entry methods
Link copied to clipboard
If true then card not present is accepted
Link copied to clipboard
If true, do not allow cash back
Link copied to clipboard
Do not do heuristic duplicate checking
Link copied to clipboard
If true, then do not print using the clover printer.
Link copied to clipboard
Do not show the receipt options screen
Link copied to clipboard
If the transaction times out or fails because of decline, do not restart it
Link copied to clipboard
An id that will be persisted with transactions.
Link copied to clipboard
An id that can be passed to the merchant's gateway, and ultimately appear in settlement records.
Link copied to clipboard
Extra pass-through data used by external systems.
Link copied to clipboard
If true then the payment will be taken offline
Link copied to clipboard
public abstract 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.
Link copied to clipboard
public String getOrderId()
Identifier for the order to apply this to.
Link copied to clipboard
A map of values for regional specific data
Link copied to clipboard
Identifier for the request
Link copied to clipboard
Where the signature should be obtained from (paper, screen...
Link copied to clipboard
If the amount is equal to or greater than this amount, then a signature should be obtained
Link copied to clipboard
public Long getTaxAmount()
Amount paid in taxes
Link copied to clipboard
The tip mode for the auth request.
Link copied to clipboard
The total amount used when calculating tips
Link copied to clipboard
Custom Tip Suggestions that can be set per transaction
Link copied to clipboard
The type of the transaction.
Link copied to clipboard
A saved card
Link copied to clipboard
Identifier for the version
Link copied to clipboard
public boolean hasAllowOfflinePayment()
Checks whether the 'allowOfflinePayment' field has been set, however the value could be null
Link copied to clipboard
public boolean hasAmount()
Checks whether the 'amount' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'approveOfflinePaymentWithoutPrompt' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'autoAcceptPaymentConfirmations' field has been set, however the value could be null
Link copied to clipboard
public boolean hasAutoAcceptSignature()
Checks whether the 'autoAcceptSignature' field has been set, however the value could be null
Link copied to clipboard
public boolean hasCardEntryMethods()
Checks whether the 'cardEntryMethods' field has been set, however the value could be null
Link copied to clipboard
public boolean hasCardNotPresent()
Checks whether the 'cardNotPresent' field has been set, however the value could be null
Link copied to clipboard
public boolean hasDisableCashback()
Checks whether the 'disableCashback' field has been set, however the value could be null
Link copied to clipboard
public boolean hasDisableDuplicateChecking()
Checks whether the 'disableDuplicateChecking' field has been set, however the value could be null
Link copied to clipboard
public boolean hasDisablePrinting()
Checks whether the 'disablePrinting' field has been set, however the value could be null
Link copied to clipboard
public boolean hasDisableReceiptSelection()
Checks whether the 'disableReceiptSelection' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'disableRestartTransactionOnFail' field has been set, however the value could be null
Link copied to clipboard
public boolean hasExternalId()
Checks whether the 'externalId' field has been set, however the value could be null
Link copied to clipboard
public boolean hasExternalReferenceId()
Checks whether the 'externalReferenceId' field has been set, however the value could be null
Link copied to clipboard
public boolean hasExtras()
Checks whether the 'extras' field has been set, however the value could be null
Link copied to clipboard
public boolean hasForceOfflinePayment()
Checks whether the 'forceOfflinePayment' field has been set, however the value could be null
Link copied to clipboard
public boolean hasOrderId()
Checks whether the 'orderId' field has been set, however the value could be null
Link copied to clipboard
public boolean hasRegionalExtras()
Checks whether the 'regionalExtras' field has been set, however the value could be null
Link copied to clipboard
public boolean hasRequestId()
Checks whether the 'requestId' field has been set, however the value could be null
Link copied to clipboard
public boolean hasSignatureEntryLocation()
Checks whether the 'signatureEntryLocation' field has been set, however the value could be null
Link copied to clipboard
public boolean hasSignatureThreshold()
Checks whether the 'signatureThreshold' field has been set, however the value could be null
Link copied to clipboard
public boolean hasTaxAmount()
Checks whether the 'taxAmount' field has been set, however the value could be null
Link copied to clipboard
public boolean hasTipMode()
Checks whether the 'tipMode' field has been set, however the value could be null
Link copied to clipboard
public boolean hasTippableAmount()
Checks whether the 'tippableAmount' field has been set, however the value could be null
Link copied to clipboard
public boolean hasTipSuggestions()
Checks whether the 'tipSuggestions' field has been set, however the value could be null
Link copied to clipboard
public boolean hasType()
Checks whether the 'type' field has been set, however the value could be null
Link copied to clipboard
public boolean hasVaultedCard()
Checks whether the 'vaultedCard' field has been set, however the value could be null
Link copied to clipboard
public boolean hasVersion()
Checks whether the 'version' field has been set, however the value could be null
Link copied to clipboard
public boolean isNotEmptyExtras()
Checks whether the 'extras' field is set and is not null and is not empty
Link copied to clipboard
public boolean isNotEmptyRegionalExtras()
Checks whether the 'regionalExtras' field is set and is not null and is not empty
Link copied to clipboard
public boolean isNotEmptyTipSuggestions()
Checks whether the 'tipSuggestions' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'allowOfflinePayment' field is set and is not null
Link copied to clipboard
public boolean isNotNullAmount()
Checks whether the 'amount' field is set and is not null
Checks whether the 'approveOfflinePaymentWithoutPrompt' field is set and is not null
Link copied to clipboard
Checks whether the 'autoAcceptPaymentConfirmations' field is set and is not null
Link copied to clipboard
Checks whether the 'autoAcceptSignature' field is set and is not null
Link copied to clipboard
public boolean isNotNullCardEntryMethods()
Checks whether the 'cardEntryMethods' field is set and is not null
Link copied to clipboard
public boolean isNotNullCardNotPresent()
Checks whether the 'cardNotPresent' field is set and is not null
Link copied to clipboard
public boolean isNotNullDisableCashback()
Checks whether the 'disableCashback' field is set and is not null
Link copied to clipboard
Checks whether the 'disableDuplicateChecking' field is set and is not null
Link copied to clipboard
public boolean isNotNullDisablePrinting()
Checks whether the 'disablePrinting' field is set and is not null
Link copied to clipboard
Checks whether the 'disableReceiptSelection' field is set and is not null
Link copied to clipboard
Checks whether the 'disableRestartTransactionOnFail' field is set and is not null
Link copied to clipboard
public boolean isNotNullExternalId()
Checks whether the 'externalId' field is set and is not null
Link copied to clipboard
Checks whether the 'externalReferenceId' field is set and is not null
Link copied to clipboard
public boolean isNotNullExtras()
Checks whether the 'extras' field is set and is not null
Link copied to clipboard
Checks whether the 'forceOfflinePayment' field is set and is not null
Link copied to clipboard
public boolean isNotNullOrderId()
Checks whether the 'orderId' field is set and is not null
Link copied to clipboard
public boolean isNotNullRegionalExtras()
Checks whether the 'regionalExtras' field is set and is not null
Link copied to clipboard
public boolean isNotNullRequestId()
Checks whether the 'requestId' field is set and is not null
Link copied to clipboard
Checks whether the 'signatureEntryLocation' field is set and is not null
Link copied to clipboard
public boolean isNotNullSignatureThreshold()
Checks whether the 'signatureThreshold' field is set and is not null
Link copied to clipboard
public boolean isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not null
Link copied to clipboard
public boolean isNotNullTipMode()
Checks whether the 'tipMode' field is set and is not null
Link copied to clipboard
public boolean isNotNullTippableAmount()
Checks whether the 'tippableAmount' field is set and is not null
Link copied to clipboard
public boolean isNotNullTipSuggestions()
Checks whether the 'tipSuggestions' field is set and is not null
Link copied to clipboard
public boolean isNotNullType()
Checks whether the 'type' field is set and is not null
Link copied to clipboard
public boolean isNotNullVaultedCard()
Checks whether the 'vaultedCard' field is set and is not null
Link copied to clipboard
public boolean isNotNullVersion()
Checks whether the 'version' field is set and is not null
Link copied to clipboard
public void mergeChanges(AuthRequest src)
public void mergeChanges(BaseRequest src)
public void mergeChanges(TransactionRequest src)
Copy all the changed fields from the given source to this instance.
Link copied to clipboard
public void resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
Link copied to clipboard
public TransactionRequest setAllowOfflinePayment(Boolean allowOfflinePayment)
Sets the field 'allowOfflinePayment'.
Link copied to clipboard
Sets the field 'amount'.
Link copied to clipboard
public TransactionRequest setApproveOfflinePaymentWithoutPrompt(Boolean approveOfflinePaymentWithoutPrompt)
Sets the field 'approveOfflinePaymentWithoutPrompt'.
Link copied to clipboard
public BaseTransactionRequest setAutoAcceptPaymentConfirmations(Boolean autoAcceptPaymentConfirmations)
Sets the field 'autoAcceptPaymentConfirmations'.
Link copied to clipboard
public TransactionRequest setAutoAcceptSignature(Boolean autoAcceptSignature)
Sets the field 'autoAcceptSignature'.
Link copied to clipboard
Sets the field 'cardEntryMethods'.
Link copied to clipboard
Sets the field 'cardNotPresent'.
Link copied to clipboard
Sets the field 'disableCashback'.
Link copied to clipboard
Sets the field 'disableDuplicateChecking'.
Link copied to clipboard
Sets the field 'disablePrinting'.
Link copied to clipboard
Sets the field 'disableReceiptSelection'.
Link copied to clipboard
public BaseTransactionRequest setDisableRestartTransactionOnFail(Boolean disableRestartTransactionOnFail)
Sets the field 'disableRestartTransactionOnFail'.
Link copied to clipboard
Sets the field 'externalId'.
Link copied to clipboard
Sets the field 'externalReferenceId'.
Link copied to clipboard
Sets the field 'extras'.
Link copied to clipboard
public TransactionRequest setForceOfflinePayment(Boolean forceOfflinePayment)
Sets the field 'forceOfflinePayment'.
Link copied to clipboard
Sets the field 'orderId'.
Link copied to clipboard
Sets the field 'regionalExtras'.
Link copied to clipboard
public BaseRequest setRequestId(String requestId)
Sets the field 'requestId'.
Link copied to clipboard
Sets the field 'signatureEntryLocation'.
Link copied to clipboard
public TransactionRequest setSignatureThreshold(Long signatureThreshold)
Sets the field 'signatureThreshold'.
Link copied to clipboard
Sets the field 'taxAmount'.
Link copied to clipboard
public AuthRequest setTipMode(TipMode tipMode)
Sets the field 'tipMode'.
Link copied to clipboard
public TransactionRequest setTippableAmount(Long tippableAmount)
Sets the field 'tippableAmount'.
Link copied to clipboard
Sets the field 'tipSuggestions'.
Link copied to clipboard
Sets the field 'type'.
Link copied to clipboard
Sets the field 'vaultedCard'.
Link copied to clipboard
public BaseRequest setVersion(Integer version)
Sets the field 'version'.
Link copied to clipboard
public final String toString()
Link copied to clipboard
public abstract void validate()
public void validate()
Link copied to clipboard
public final void writeToParcel(Parcel dest, int flags)