Class TransactionSettings

    • Constructor Detail

      • TransactionSettings

        public TransactionSettings()
        Constructs a new empty instance.
      • TransactionSettings

        protected TransactionSettings​(boolean noInit)
        Constructs a new empty instance.
      • TransactionSettings

        public TransactionSettings​(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.
      • TransactionSettings

        public TransactionSettings​(TransactionSettings src)
        Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
    • Method Detail

      • getCardEntryMethods

        public Integer getCardEntryMethods()
      • getDisableCashBack

        public Boolean getDisableCashBack()
      • getCloverShouldHandleReceipts

        public Boolean getCloverShouldHandleReceipts()
      • getForcePinEntryOnSwipe

        public Boolean getForcePinEntryOnSwipe()
      • getDisableRestartTransactionOnFailure

        public Boolean getDisableRestartTransactionOnFailure()
      • getAllowOfflinePayment

        public Boolean getAllowOfflinePayment()
      • getApproveOfflinePaymentWithoutPrompt

        public Boolean getApproveOfflinePaymentWithoutPrompt()
      • getForceOfflinePayment

        public Boolean getForceOfflinePayment()
      • getSignatureThreshold

        public Long getSignatureThreshold()
      • getTipMode

        public TipMode getTipMode()
      • getTippableAmount

        public Long getTippableAmount()
      • getDisableReceiptSelection

        public Boolean getDisableReceiptSelection()
      • getDisableDuplicateCheck

        public Boolean getDisableDuplicateCheck()
      • getAutoAcceptPaymentConfirmations

        public Boolean getAutoAcceptPaymentConfirmations()
        If set to true, confirmation requests triggered by a challenge at the payment gateway are automatically accepted, and confirmation requests are not transmitted back to the calling program. Be sure you are willing to accept the risk associated with accepting offline or duplicate payment challenges. See https://docs.clover.com/build/working-with-challenges for more information.
      • getAutoAcceptSignature

        public Boolean getAutoAcceptSignature()
      • getReturnResultOnTransactionComplete

        public Boolean getReturnResultOnTransactionComplete()
      • getDisableCreditSurcharge

        public Boolean getDisableCreditSurcharge()
      • getRemoteReceipts

        public Boolean getRemoteReceipts()
      • getRemoteConfirmationRequired

        public Boolean getRemoteConfirmationRequired()
        Indicates if remote payment confirmation is required, i.e. by RemotePay. This is TRUE for tethered devices.
      • getEnableKioskMode

        public Boolean getEnableKioskMode()
        If set to true, this indicates that the device interaction is customer-facing only and does not involve the merchant. The default value is false, which is the normal processing mode for most order/payment interactions.
      • 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.
        Specified by:
        getJSONObject in interface JSONifiable
      • isNotNullCardEntryMethods

        public boolean isNotNullCardEntryMethods()
        Checks whether the 'cardEntryMethods' field is set and is not null
      • isNotNullDisableCashBack

        public boolean isNotNullDisableCashBack()
        Checks whether the 'disableCashBack' field is set and is not null
      • isNotNullCloverShouldHandleReceipts

        public boolean isNotNullCloverShouldHandleReceipts()
        Checks whether the 'cloverShouldHandleReceipts' field is set and is not null
      • isNotNullForcePinEntryOnSwipe

        public boolean isNotNullForcePinEntryOnSwipe()
        Checks whether the 'forcePinEntryOnSwipe' field is set and is not null
      • isNotNullDisableRestartTransactionOnFailure

        public boolean isNotNullDisableRestartTransactionOnFailure()
        Checks whether the 'disableRestartTransactionOnFailure' field is set and is not null
      • isNotNullAllowOfflinePayment

        public boolean isNotNullAllowOfflinePayment()
        Checks whether the 'allowOfflinePayment' field is set and is not null
      • isNotNullApproveOfflinePaymentWithoutPrompt

        public boolean isNotNullApproveOfflinePaymentWithoutPrompt()
        Checks whether the 'approveOfflinePaymentWithoutPrompt' field is set and is not null
      • isNotNullForceOfflinePayment

        public boolean isNotNullForceOfflinePayment()
        Checks whether the 'forceOfflinePayment' field is set and is not null
      • isNotNullSignatureThreshold

        public boolean isNotNullSignatureThreshold()
        Checks whether the 'signatureThreshold' field is set and is not null
      • isNotNullSignatureEntryLocation

        public boolean isNotNullSignatureEntryLocation()
        Checks whether the 'signatureEntryLocation' 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
      • isNotNullDisableReceiptSelection

        public boolean isNotNullDisableReceiptSelection()
        Checks whether the 'disableReceiptSelection' field is set and is not null
      • isNotNullDisableDuplicateCheck

        public boolean isNotNullDisableDuplicateCheck()
        Checks whether the 'disableDuplicateCheck' 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
      • isNotNullReturnResultOnTransactionComplete

        public boolean isNotNullReturnResultOnTransactionComplete()
        Checks whether the 'returnResultOnTransactionComplete' field is set and is not null
      • isNotNullTipSuggestions

        public boolean isNotNullTipSuggestions()
        Checks whether the 'tipSuggestions' field is set and is not null
      • isNotEmptyTipSuggestions

        public boolean isNotEmptyTipSuggestions()
        Checks whether the 'tipSuggestions' field is set and is not null and is not empty
      • isNotNullCashbackSuggestions

        public boolean isNotNullCashbackSuggestions()
        Checks whether the 'cashbackSuggestions' field is set and is not null
      • isNotEmptyCashbackSuggestions

        public boolean isNotEmptyCashbackSuggestions()
        Checks whether the 'cashbackSuggestions' field is set and is not null and is not empty
      • isNotNullRegionalExtras

        public boolean isNotNullRegionalExtras()
        Checks whether the 'regionalExtras' field is set and is not null
      • isNotEmptyRegionalExtras

        public boolean isNotEmptyRegionalExtras()
        Checks whether the 'regionalExtras' field is set and is not null and is not empty
      • isNotNullDisableCreditSurcharge

        public boolean isNotNullDisableCreditSurcharge()
        Checks whether the 'disableCreditSurcharge' field is set and is not null
      • isNotNullReceiptOptions

        public boolean isNotNullReceiptOptions()
        Checks whether the 'receiptOptions' field is set and is not null
      • isNotEmptyReceiptOptions

        public boolean isNotEmptyReceiptOptions()
        Checks whether the 'receiptOptions' field is set and is not null and is not empty
      • isNotNullRemoteReceipts

        public boolean isNotNullRemoteReceipts()
        Checks whether the 'remoteReceipts' field is set and is not null
      • isNotNullRemoteConfirmationRequired

        public boolean isNotNullRemoteConfirmationRequired()
        Checks whether the 'remoteConfirmationRequired' field is set and is not null
      • isNotNullTenderOptions

        public boolean isNotNullTenderOptions()
        Checks whether the 'tenderOptions' field is set and is not null
      • isNotEmptyTenderOptions

        public boolean isNotEmptyTenderOptions()
        Checks whether the 'tenderOptions' field is set and is not null and is not empty
      • isNotNullEnableKioskMode

        public boolean isNotNullEnableKioskMode()
        Checks whether the 'enableKioskMode' field is set and is not null
      • hasCardEntryMethods

        public boolean hasCardEntryMethods()
        Checks whether the 'cardEntryMethods' 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
      • hasCloverShouldHandleReceipts

        public boolean hasCloverShouldHandleReceipts()
        Checks whether the 'cloverShouldHandleReceipts' field has been set, however the value could be null
      • hasForcePinEntryOnSwipe

        public boolean hasForcePinEntryOnSwipe()
        Checks whether the 'forcePinEntryOnSwipe' field has been set, however the value could be null
      • hasDisableRestartTransactionOnFailure

        public boolean hasDisableRestartTransactionOnFailure()
        Checks whether the 'disableRestartTransactionOnFailure' field has been set, however the value could be null
      • hasAllowOfflinePayment

        public boolean hasAllowOfflinePayment()
        Checks whether the 'allowOfflinePayment' 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
      • hasForceOfflinePayment

        public boolean hasForceOfflinePayment()
        Checks whether the 'forceOfflinePayment' 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
      • hasSignatureEntryLocation

        public boolean hasSignatureEntryLocation()
        Checks whether the 'signatureEntryLocation' 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
      • hasDisableReceiptSelection

        public boolean hasDisableReceiptSelection()
        Checks whether the 'disableReceiptSelection' field has been set, however the value could be null
      • hasDisableDuplicateCheck

        public boolean hasDisableDuplicateCheck()
        Checks whether the 'disableDuplicateCheck' 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
      • hasReturnResultOnTransactionComplete

        public boolean hasReturnResultOnTransactionComplete()
        Checks whether the 'returnResultOnTransactionComplete' 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
      • hasCashbackSuggestions

        public boolean hasCashbackSuggestions()
        Checks whether the 'cashbackSuggestions' 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
      • hasDisableCreditSurcharge

        public boolean hasDisableCreditSurcharge()
        Checks whether the 'disableCreditSurcharge' field has been set, however the value could be null
      • hasReceiptOptions

        public boolean hasReceiptOptions()
        Checks whether the 'receiptOptions' field has been set, however the value could be null
      • hasRemoteReceipts

        public boolean hasRemoteReceipts()
        Checks whether the 'remoteReceipts' field has been set, however the value could be null
      • hasRemoteConfirmationRequired

        public boolean hasRemoteConfirmationRequired()
        Checks whether the 'remoteConfirmationRequired' field has been set, however the value could be null
      • hasTenderOptions

        public boolean hasTenderOptions()
        Checks whether the 'tenderOptions' field has been set, however the value could be null
      • hasEnableKioskMode

        public boolean hasEnableKioskMode()
        Checks whether the 'enableKioskMode' field has been set, however the value could be null
      • setCardEntryMethods

        public TransactionSettings setCardEntryMethods​(Integer cardEntryMethods)
        Sets the field 'cardEntryMethods'.
      • setDisableCashBack

        public TransactionSettings setDisableCashBack​(Boolean disableCashBack)
        Sets the field 'disableCashBack'.
      • setCloverShouldHandleReceipts

        public TransactionSettings setCloverShouldHandleReceipts​(Boolean cloverShouldHandleReceipts)
        Sets the field 'cloverShouldHandleReceipts'.
      • setForcePinEntryOnSwipe

        public TransactionSettings setForcePinEntryOnSwipe​(Boolean forcePinEntryOnSwipe)
        Sets the field 'forcePinEntryOnSwipe'.
      • setDisableRestartTransactionOnFailure

        public TransactionSettings setDisableRestartTransactionOnFailure​(Boolean disableRestartTransactionOnFailure)
        Sets the field 'disableRestartTransactionOnFailure'.
      • setAllowOfflinePayment

        public TransactionSettings setAllowOfflinePayment​(Boolean allowOfflinePayment)
        Sets the field 'allowOfflinePayment'.
      • setApproveOfflinePaymentWithoutPrompt

        public TransactionSettings setApproveOfflinePaymentWithoutPrompt​(Boolean approveOfflinePaymentWithoutPrompt)
        Sets the field 'approveOfflinePaymentWithoutPrompt'.
      • setForceOfflinePayment

        public TransactionSettings setForceOfflinePayment​(Boolean forceOfflinePayment)
        Sets the field 'forceOfflinePayment'.
      • setSignatureThreshold

        public TransactionSettings setSignatureThreshold​(Long signatureThreshold)
        Sets the field 'signatureThreshold'.
      • setTippableAmount

        public TransactionSettings setTippableAmount​(Long tippableAmount)
        Sets the field 'tippableAmount'.
      • setDisableReceiptSelection

        public TransactionSettings setDisableReceiptSelection​(Boolean disableReceiptSelection)
        Sets the field 'disableReceiptSelection'.
      • setDisableDuplicateCheck

        public TransactionSettings setDisableDuplicateCheck​(Boolean disableDuplicateCheck)
        Sets the field 'disableDuplicateCheck'.
      • setAutoAcceptPaymentConfirmations

        public TransactionSettings setAutoAcceptPaymentConfirmations​(Boolean autoAcceptPaymentConfirmations)
        Sets the field 'autoAcceptPaymentConfirmations'.
      • setAutoAcceptSignature

        public TransactionSettings setAutoAcceptSignature​(Boolean autoAcceptSignature)
        Sets the field 'autoAcceptSignature'.
      • setReturnResultOnTransactionComplete

        public TransactionSettings setReturnResultOnTransactionComplete​(Boolean returnResultOnTransactionComplete)
        Sets the field 'returnResultOnTransactionComplete'.
      • setTipSuggestions

        public TransactionSettings setTipSuggestions​(List<TipSuggestion> tipSuggestions)
        Sets the field 'tipSuggestions'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
      • setCashbackSuggestions

        public TransactionSettings setCashbackSuggestions​(List<CashbackSuggestion> cashbackSuggestions)
        Sets the field 'cashbackSuggestions'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
      • setDisableCreditSurcharge

        public TransactionSettings setDisableCreditSurcharge​(Boolean disableCreditSurcharge)
        Sets the field 'disableCreditSurcharge'.
      • setRemoteConfirmationRequired

        public TransactionSettings setRemoteConfirmationRequired​(Boolean remoteConfirmationRequired)
        Sets the field 'remoteConfirmationRequired'.
      • setEnableKioskMode

        public TransactionSettings setEnableKioskMode​(Boolean enableKioskMode)
        Sets the field 'enableKioskMode'.
      • clearCardEntryMethods

        public void clearCardEntryMethods()
        Clears the 'cardEntryMethods' 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
      • clearCloverShouldHandleReceipts

        public void clearCloverShouldHandleReceipts()
        Clears the 'cloverShouldHandleReceipts' field, the 'has' method for this field will now return false
      • clearForcePinEntryOnSwipe

        public void clearForcePinEntryOnSwipe()
        Clears the 'forcePinEntryOnSwipe' field, the 'has' method for this field will now return false
      • clearDisableRestartTransactionOnFailure

        public void clearDisableRestartTransactionOnFailure()
        Clears the 'disableRestartTransactionOnFailure' field, the 'has' method for this field will now return false
      • clearAllowOfflinePayment

        public void clearAllowOfflinePayment()
        Clears the 'allowOfflinePayment' 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
      • clearForceOfflinePayment

        public void clearForceOfflinePayment()
        Clears the 'forceOfflinePayment' 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
      • clearSignatureEntryLocation

        public void clearSignatureEntryLocation()
        Clears the 'signatureEntryLocation' 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
      • clearDisableReceiptSelection

        public void clearDisableReceiptSelection()
        Clears the 'disableReceiptSelection' field, the 'has' method for this field will now return false
      • clearDisableDuplicateCheck

        public void clearDisableDuplicateCheck()
        Clears the 'disableDuplicateCheck' 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
      • clearReturnResultOnTransactionComplete

        public void clearReturnResultOnTransactionComplete()
        Clears the 'returnResultOnTransactionComplete' 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
      • clearCashbackSuggestions

        public void clearCashbackSuggestions()
        Clears the 'cashbackSuggestions' 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
      • clearDisableCreditSurcharge

        public void clearDisableCreditSurcharge()
        Clears the 'disableCreditSurcharge' field, the 'has' method for this field will now return false
      • clearReceiptOptions

        public void clearReceiptOptions()
        Clears the 'receiptOptions' field, the 'has' method for this field will now return false
      • clearRemoteReceipts

        public void clearRemoteReceipts()
        Clears the 'remoteReceipts' field, the 'has' method for this field will now return false
      • clearRemoteConfirmationRequired

        public void clearRemoteConfirmationRequired()
        Clears the 'remoteConfirmationRequired' field, the 'has' method for this field will now return false
      • clearTenderOptions

        public void clearTenderOptions()
        Clears the 'tenderOptions' field, the 'has' method for this field will now return false
      • clearEnableKioskMode

        public void clearEnableKioskMode()
        Clears the 'enableKioskMode' field, the 'has' method for this field will now return false
      • containsChanges

        public boolean containsChanges()
        Returns true if this instance has any changes.
      • resetChangeLog

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

        public TransactionSettings copyChanges()
        Create a copy of this instance that contains only fields that were set after the constructor was called.
      • mergeChanges

        public void mergeChanges​(TransactionSettings src)
        Copy all the changed fields from the given source to this instance.