com.clover.remote.client.messages

Class TransactionRequest

java.lang.Object

com.clover.remote.client.messages.BaseRequest

com.clover.remote.client.messages.BaseTransactionRequest

com.clover.remote.client.messages.TransactionRequest

Direct Known Subclasses:

AuthRequest, SaleRequest

public abstract class TransactionRequest
extends BaseTransactionRequest

Base class used by all transaction request objects like SaleRequest, AuthRequest, etc.

Constructor Summary

Constructors

Constructor and Description
TransactionRequest(long amount, java.lang.String externalId) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllowOfflinePayment() Get the field value
java.lang.Boolean	getApproveOfflinePaymentWithoutPrompt() Get the field value
java.lang.Boolean	getAutoAcceptSignature() Get the field value
java.lang.Boolean	getDisableCashback() Get the field value
java.lang.Boolean	getForceOfflinePayment() Get the field value
com.clover.sdk.v3.payments.DataEntryLocation	getSignatureEntryLocation() Get the field value
java.lang.Long	getSignatureThreshold() Get the field value
java.lang.Long	getTaxAmount() Get the field value
java.lang.Long	getTippableAmount() Get the field value
com.clover.sdk.v3.merchant.TipSuggestion[]	getTipSuggestions() Get the field value
com.clover.common2.payments.PayIntent.TransactionType	getType() Get the field value
void	setAllowOfflinePayment(java.lang.Boolean allowOfflinePayment) Set the field value
void	setApproveOfflinePaymentWithoutPrompt(java.lang.Boolean approveOfflinePaymentWithoutPrompt) Set the field value
void	setAutoAcceptSignature(java.lang.Boolean autoAcceptSignature) Set the field value
void	setDisableCashback(java.lang.Boolean disableCashback) Set the field value
void	setForceOfflinePayment(java.lang.Boolean forceOfflinePayment) Set the field value
void	setSignatureEntryLocation(com.clover.sdk.v3.payments.DataEntryLocation signatureEntryLocation) Set the field value
void	setSignatureThreshold(java.lang.Long signatureThreshold) Set the field value
void	setTaxAmount(java.lang.Long taxAmount) Set the field value
void	setTippableAmount(java.lang.Long tippableAmount) Set the field value
void	setTipSuggestions(com.clover.sdk.v3.merchant.TipSuggestion[] tipSuggestions) Set the field value

Methods inherited from class com.clover.remote.client.messages.BaseTransactionRequest

getAmount, getAutoAcceptPaymentConfirmations, getCardEntryMethods, getCardNotPresent, getDisableDuplicateChecking, getDisablePrinting, getDisableReceiptSelection, getDisableRestartTransactionOnFail, getExternalId, getExternalReferenceId, getExtras, getRegionalExtras, getVaultedCard, setAmount, setAutoAcceptPaymentConfirmations, setCardEntryMethods, setCardNotPresent, setDisableDuplicateChecking, setDisablePrinting, setDisableReceiptSelection, setDisableRestartTransactionOnFail, setExternalId, setExternalReferenceId, setExtras, setRegionalExtras, setVaultedCard

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionRequest

public TransactionRequest(long amount,
                          java.lang.String externalId)

Constructor

Parameters:

amount - The amount of the transaction. This includes amount, tax, service charges, etc. except the tip

externalId - An id assigned by the POS that can be used to track a payment through the Clover system

Method Detail

getType

public com.clover.common2.payments.PayIntent.TransactionType getType()

Description copied from class: BaseTransactionRequest

Get the field value

Specified by:

getType in class BaseTransactionRequest

Returns:

The type of the transaction.

setSignatureThreshold

public void setSignatureThreshold(java.lang.Long signatureThreshold)

Set the field value

Parameters:

signatureThreshold - The signature threshold settings overrides

getSignatureThreshold

public java.lang.Long getSignatureThreshold()

Get the field value

Returns:

The transaction level settings overrides

setSignatureEntryLocation

public void setSignatureEntryLocation(com.clover.sdk.v3.payments.DataEntryLocation signatureEntryLocation)

Set the field value

Parameters:

signatureEntryLocation - The signature entry location settings overrides

getSignatureEntryLocation

public com.clover.sdk.v3.payments.DataEntryLocation getSignatureEntryLocation()

Get the field value

Returns:

The transaction level settings overrides

setAutoAcceptSignature

public void setAutoAcceptSignature(java.lang.Boolean autoAcceptSignature)

Set the field value

Parameters:

autoAcceptSignature - The automatically accept signature override

getAutoAcceptSignature

public java.lang.Boolean getAutoAcceptSignature()

Get the field value

Returns:

The automatically accept signature override

setDisableCashback

public void setDisableCashback(java.lang.Boolean disableCashback)

Set the field value

Parameters:

disableCashback - If true, do not allow cash back

getDisableCashback

public java.lang.Boolean getDisableCashback()

Get the field value

Returns:

If true, do not allow cash back

setTaxAmount

public void setTaxAmount(java.lang.Long taxAmount)

Set the field value

Parameters:

taxAmount - Amount paid in taxes

getTaxAmount

public java.lang.Long getTaxAmount()

Get the field value

Returns:

Amount paid in tips

setAllowOfflinePayment

public void setAllowOfflinePayment(java.lang.Boolean allowOfflinePayment)

Set the field value

Parameters:

allowOfflinePayment - If true then offline payments can be accepted

getAllowOfflinePayment

public java.lang.Boolean getAllowOfflinePayment()

Get the field value

Returns:

If true then offline payments can be accepted

setForceOfflinePayment

public void setForceOfflinePayment(java.lang.Boolean forceOfflinePayment)

Set the field value

Parameters:

forceOfflinePayment - If true then the payment will be taken offline

getForceOfflinePayment

public java.lang.Boolean getForceOfflinePayment()

Get the field value

Returns:

If true then the payment will be taken offline

setApproveOfflinePaymentWithoutPrompt

public void setApproveOfflinePaymentWithoutPrompt(java.lang.Boolean approveOfflinePaymentWithoutPrompt)

Set the field value

Parameters:

approveOfflinePaymentWithoutPrompt - If true then offline payments will be approved without a prompt

getApproveOfflinePaymentWithoutPrompt

public java.lang.Boolean getApproveOfflinePaymentWithoutPrompt()

Get the field value

Returns:

If true then offline payments will be approved without a prompt

setTippableAmount

public void setTippableAmount(java.lang.Long tippableAmount)

Set the field value

Parameters:

tippableAmount - The total amount used when calculating tips

getTippableAmount

public java.lang.Long getTippableAmount()

Get the field value

Returns:

The total amount used when calculating tips

getTipSuggestions

public com.clover.sdk.v3.merchant.TipSuggestion[] getTipSuggestions()

Get the field value

Returns:

The list of tip suggestions

setTipSuggestions

public void setTipSuggestions(com.clover.sdk.v3.merchant.TipSuggestion[] tipSuggestions)

Set the field value

Parameters:

tipSuggestions - The list of tip suggestions