com.clover.remote.client.messages

Class TransactionRequest

java.lang.Object

com.clover.remote.client.messages.BaseRequest

com.clover.remote.client.messages.TransactionRequest

Direct Known Subclasses:

AuthRequest, ManualRefundRequest, PreAuthRequest, SaleRequest

public abstract class TransactionRequest
extends BaseRequest

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
long	getAmount() Get the field value
java.lang.Boolean	getAutoAcceptPaymentConfirmations() Get the field value
java.lang.Boolean	getAutoAcceptSignature() Get the field value
java.lang.Integer	getCardEntryMethods() Get the field value
java.lang.Boolean	getCardNotPresent() Get the field value
java.lang.Boolean	getDisableDuplicateChecking() Get the field value
java.lang.Boolean	getDisablePrinting() Get the field value
java.lang.Boolean	getDisableReceiptSelection() Get the field value
java.lang.Boolean	getDisableRestartTransactionOnFail() Get the field value
java.lang.String	getExternalId() Get the field value
com.clover.sdk.v3.payments.DataEntryLocation	getSignatureEntryLocation() Get the field value
java.lang.Long	getSignatureThreshold() Get the field value
abstract com.clover.common2.payments.PayIntent.TransactionType	getType() Get the field value
com.clover.sdk.v3.payments.VaultedCard	getVaultedCard() Get the field value
void	setAmount(long amount) Set the field value
void	setAutoAcceptPaymentConfirmations(java.lang.Boolean autoAcceptPaymentConfirmations) Set the field value
void	setAutoAcceptSignature(java.lang.Boolean autoAcceptSignature) Set the field value
void	setCardEntryMethods(java.lang.Integer cardEntryMethods) Set the field value
void	setCardNotPresent(java.lang.Boolean cardNotPresent) Set the field value
void	setDisableDuplicateChecking(java.lang.Boolean disableDuplicateChecking) Set the field value
void	setDisablePrinting(java.lang.Boolean disablePrinting) Set the field value
void	setDisableReceiptSelection(java.lang.Boolean disableReceiptSelection) Set the field value
void	setDisableRestartTransactionOnFail(java.lang.Boolean disableRestartTransactionOnFail) Set the field value
void	setExternalId(java.lang.String externalId) 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	setVaultedCard(com.clover.sdk.v3.payments.VaultedCard vaultedCard) Set the field value

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

setDisablePrinting

public void setDisablePrinting(java.lang.Boolean disablePrinting)

Set the field value

Parameters:

disablePrinting - Do not print

getDisablePrinting

public java.lang.Boolean getDisablePrinting()

Get the field value

Returns:

Do not print

setCardNotPresent

public void setCardNotPresent(java.lang.Boolean cardNotPresent)

Set the field value

Parameters:

cardNotPresent - If true then card not present is accepted

getCardNotPresent

public java.lang.Boolean getCardNotPresent()

Get the field value

Returns:

If true then card not present is accepted

setDisableRestartTransactionOnFail

public void setDisableRestartTransactionOnFail(java.lang.Boolean disableRestartTransactionOnFail)

Set the field value

Parameters:

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

getDisableRestartTransactionOnFail

public java.lang.Boolean getDisableRestartTransactionOnFail()

Get the field value

Returns:

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

setAmount

public void setAmount(long amount)

Set the field value

Parameters:

amount - Total amount paid

getAmount

public long getAmount()

Get the field value

Returns:

Total amount paid

setCardEntryMethods

public void setCardEntryMethods(java.lang.Integer cardEntryMethods)

Set the field value

Parameters:

cardEntryMethods - Allowed entry methods

getCardEntryMethods

public java.lang.Integer getCardEntryMethods()

Get the field value

Returns:

Allowed entry methods

setVaultedCard

public void setVaultedCard(com.clover.sdk.v3.payments.VaultedCard vaultedCard)

Set the field value

Parameters:

vaultedCard - A saved card

getVaultedCard

public com.clover.sdk.v3.payments.VaultedCard getVaultedCard()

Get the field value

Returns:

A saved card

setExternalId

public void setExternalId(java.lang.String externalId)

Set the field value

Parameters:

externalId - An id that will be persisted with transactions.

getExternalId

public java.lang.String getExternalId()

Get the field value

Returns:

An id that will be persisted with transactions.

getType

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

Get the field value

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

setDisableReceiptSelection

public void setDisableReceiptSelection(java.lang.Boolean disableReceiptSelection)

Set the field value

Parameters:

disableReceiptSelection - The disable receipt options screen settings overrides

getDisableReceiptSelection

public java.lang.Boolean getDisableReceiptSelection()

Get the field value

Returns:

The disable receipt options screen settings overrides

setDisableDuplicateChecking

public void setDisableDuplicateChecking(java.lang.Boolean disableDuplicateChecking)

Set the field value

Parameters:

disableDuplicateChecking - The disable duplicate transaction validation settings overrides

getDisableDuplicateChecking

public java.lang.Boolean getDisableDuplicateChecking()

Get the field value

Returns:

The disable duplicate transaction validation settings overrides

setAutoAcceptPaymentConfirmations

public void setAutoAcceptPaymentConfirmations(java.lang.Boolean autoAcceptPaymentConfirmations)

Set the field value

Parameters:

autoAcceptPaymentConfirmations - The automatically accept payment confirmations settings override

getAutoAcceptPaymentConfirmations

public java.lang.Boolean getAutoAcceptPaymentConfirmations()

Get the field value

Returns:

The automatically accept payment confirmations settings override

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