com.clover.remote.client

Interface ICloverConnector

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CloverConnector

public interface ICloverConnector
extends java.io.Serializable

CloverConnector is the interface for sending requests to a connected Clover device. This document defines the available methods.

Method Summary

Modifier and Type	Method and Description
void	acceptPayment(Payment payment) If Payment confirmation is required during a transaction due to a Challenge, this method accepts the Payment.
void	acceptSignature(VerifySignatureRequest request) If a signature is captured during a transaction, this method accepts the signature as entered.
void	addCloverConnectorListener(ICloverConnectorListener listener) Adds a Clover Connector listener.
void	auth(AuthRequest request) Requests an Auth transaction.
void	cancel() Deprecated. Use invokeInputOption(InputOption) instead.
void	capturePreAuth(CapturePreAuthRequest request) Marks a PreAuth Payment for capture by a Closeout process.
void	closeout(CloseoutRequest request) Sends a request to the Clover server to close out all transactions.
void	displayPaymentReceiptOptions(DisplayReceiptOptionsRequest request) Displays the customer-facing payment receipt options (print, email, etc.) for a Payment on the Clover device.
void	displayPaymentReceiptOptions(java.lang.String orderId, java.lang.String paymentId) Deprecated.
void	dispose() Disposes the connection to the Clover device.
void	initializeConnection() Initializes the connection and starts communication with the Clover device.
void	invokeInputOption(InputOption io) Sends a keystroke to the Clover device that invokes an input option (OK, CANCEL, DONE, etc.) on the customer's behalf.
void	manualRefund(ManualRefundRequest request) Initiates a Manual Refund transaction (a “Refund” or credit that is not associated with a previous Payment).
void	openCashDrawer(OpenCashDrawerRequest request) Opens the first cash drawer found connected to the Clover device.
void	openCashDrawer(java.lang.String reason) Deprecated.
void	preAuth(PreAuthRequest request) Initiates a PreAuth transaction (a pre-authorization for a certain amount).
void	print(PrintRequest request) Sends a print request using the PrintRequest object.
void	printImage(Bitmap image) Deprecated. Use print(PrintRequest request) instead.
void	printImageFromURL(java.lang.String url) Deprecated. Use print(PrintRequest request) instead.
void	printText(java.util.List<java.lang.String> messages) Deprecated. Use print(PrintRequest request) instead.
void	readCardData(ReadCardDataRequest request) Requests card information (specifically Track 1 and Track 2 card data).
void	refundPayment(RefundPaymentRequest request) Refunds the full or partial amount of a Payment.
void	rejectPayment(Payment payment, Challenge challenge) If Payment confirmation is required during a transaction due to a Challenge, this method rejects the Payment.
void	rejectSignature(VerifySignatureRequest request) If a signature is captured during a transaction, this method rejects the signature as entered.
void	removeCloverConnectorListener(ICloverConnectorListener listener) Removes a Clover Connector listener.
void	removeDisplayOrder(DisplayOrder order) Removes the DisplayOrder object from the Clover device's screen.
void	resetDevice() Sends a request to reset the Clover device back to the welcome screen.
void	retrieveDeviceStatus(RetrieveDeviceStatusRequest request) Sends a message requesting the current status of the Clover device.
void	retrievePayment(RetrievePaymentRequest request) Requests the Payment information associated with the externalPaymentId passed in.
void	retrievePendingPayments() Retrieves a list of unprocessed Payments that were taken offline and are pending submission to the server.
void	retrievePrinters(RetrievePrintersRequest request) Queries available printers attached to the Clover device using the RetrievePrintersRequest object.
void	retrievePrintJobStatus(PrintJobStatusRequest request) Queries the status of a print job using the PrintJobStatusRequest object.
void	sale(SaleRequest request) Requests a Sale transaction (purchase).
void	sendMessageToActivity(MessageToActivity request) Sends a message to a Custom Activity running on a Clover device.
void	showDisplayOrder(DisplayOrder order) Displays an Order and associated lineItems on the Clover device.
void	showMessage(java.lang.String message) Displays a string-based message on the Clover device's screen.
void	showThankYouScreen() Displays the thank you screen on the Clover device.
void	showWelcomeScreen() Displays the welcome screen on the Clover device.
void	startCustomActivity(CustomActivityRequest request) Starts a Custom Activity on the Clover device.
void	tipAdjustAuth(TipAdjustAuthRequest request) Adjusts the tip for a previous Auth transaction.
void	vaultCard(java.lang.Integer cardEntryMethods) Asks the Clover device to capture card information and request a payment token from the payment gateway.
void	voidPayment(VoidPaymentRequest request) Voids a transaction.

Method Detail

initializeConnection

void initializeConnection()

Initializes the connection and starts communication with the Clover device. This method is called after the connector has been created and listeners have been added to it. It must be called before any other method (other than those that add or remove listeners).

addCloverConnectorListener

void addCloverConnectorListener(ICloverConnectorListener listener)

Adds a Clover Connector listener.

Parameters:

listener - The connection listener.

removeCloverConnectorListener

void removeCloverConnectorListener(ICloverConnectorListener listener)

Removes a Clover Connector listener.

Parameters:

listener - The connection listener.

sale

void sale(SaleRequest request)

Requests a Sale transaction (purchase).

Parameters:

request - A SaleRequest object containing basic information for the transaction.

acceptSignature

void acceptSignature(VerifySignatureRequest request)

If a signature is captured during a transaction, this method accepts the signature as entered.

Parameters:

request - The accepted VerifySignatureRequest the device passed to onVerifySignatureRequest().

rejectSignature

void rejectSignature(VerifySignatureRequest request)

If a signature is captured during a transaction, this method rejects the signature as entered.

Parameters:

request - The rejected VerifySignatureRequest() the device passed to onVerifySignatureRequest().

acceptPayment

void acceptPayment(Payment payment)

If Payment confirmation is required during a transaction due to a Challenge, this method accepts the Payment. A Challenge may be triggered by a potential duplicate Payment or an offline Payment.

Parameters:

payment - The Payment to accept.

rejectPayment

void rejectPayment(Payment payment,
                   Challenge challenge)

If Payment confirmation is required during a transaction due to a Challenge, this method rejects the Payment. A Challenge may be triggered by a potential duplicate Payment or an offline Payment.

Parameters:

payment - The Payment to reject.

challenge - The Challenge that resulted in Payment rejection.

auth

void auth(AuthRequest request)

Requests an Auth transaction. The tip for an Auth can be adjusted through the TipAdjustAuth() call until the batch Closeout is processed.

Note: The MerchantInfo.SupportsAuths boolean must be set to true.

Parameters:

request - The AuthRequest details.

preAuth

void preAuth(PreAuthRequest request)

Initiates a PreAuth transaction (a pre-authorization for a certain amount). This transaction lets the merchant know whether the account associated with a card has sufficient funds, without actually charging the card. When the merchant is ready to charge a final amount, the POS will call CapturePreAuth() to complete the Payment.

Note: The MerchantInfo.SupportsPreAuths boolean must be set to true.

Parameters:

request - The PreAuthRequest details.

capturePreAuth

void capturePreAuth(CapturePreAuthRequest request)

Marks a PreAuth Payment for capture by a Closeout process. After a PreAuth is captured, it is effectively the same as an Auth Payment.

Note: Should only be called if the request's PaymentID is from a PreAuthResponse.

Parameters:

The - CapturePreAuthRequest details.

tipAdjustAuth

void tipAdjustAuth(TipAdjustAuthRequest request)

Adjusts the tip for a previous Auth transaction. This call can be made until the Auth Payment has been finalized by a Closeout.

Note: Should only be called if the request's PaymentID is from an AuthResponse.

Parameters:

request - The TipAdjustAuthRequest details.

voidPayment

void voidPayment(VoidPaymentRequest request)

Voids a transaction.

Parameters:

request - A VoidRequest object containing basic information needed to void the transaction.

refundPayment

void refundPayment(RefundPaymentRequest request)

Refunds the full or partial amount of a Payment.

Parameters:

request - The RefundPaymentRequest details.

manualRefund

void manualRefund(ManualRefundRequest request)

Initiates a Manual Refund transaction (a “Refund” or credit that is not associated with a previous Payment).

Parameters:

request - A ManualRefundRequest object with the request details.

vaultCard

void vaultCard(java.lang.Integer cardEntryMethods)

Asks the Clover device to capture card information and request a payment token from the payment gateway. The payment token can be used for future Sale and Auth requests in place of the card details. The merchant account must be configured to allow payment tokens.

Note: The MerchantInfo.SupportsVaultCards boolean must be set to true.

Parameters:

cardEntryMethods - The card entry methods allowed to capture the payment token. If this parameter is null, the default values (CARD_ENTRY_METHOD_MAG_STRIPE, CARD_ENTRY_METHOD_ICC_CONTACT, and CARD_ENTRY_METHOD_NFC_CONTACTLESS) will be used.

cancel

@Deprecated
void cancel()

Deprecated. Use invokeInputOption(InputOption) instead.

Sends a "cancel" button press to the Clover device.

closeout

void closeout(CloseoutRequest request)

Sends a request to the Clover server to close out all transactions.

Note: The merchant account must be configured to allow transaction closeout.

Parameters:

request - The CloseoutRequest details.

print

void print(PrintRequest request)

Sends a print request using the PrintRequest object. Used to print text, Bitmap image objects, and images from a URL using the specified printer.

Parameters:

request - The PrintRequest details.

retrievePrinters

void retrievePrinters(RetrievePrintersRequest request)

Queries available printers attached to the Clover device using the RetrievePrintersRequest object.

Parameters:

request - The RetrievePrintersRequest details.

retrievePrintJobStatus

void retrievePrintJobStatus(PrintJobStatusRequest request)

Queries the status of a print job using the PrintJobStatusRequest object.

Parameters:

request - The PrintJobStatusRequest details.

openCashDrawer

void openCashDrawer(OpenCashDrawerRequest request)

Opens the first cash drawer found connected to the Clover device. The reason for opening the cash drawer must be set on OpenCashDrawerRequest.

Parameters:

request - The OpenCashDrawerRequest object defining the reason the cash drawer is being opened, and an optional device identifier.

openCashDrawer

@Deprecated
void openCashDrawer(java.lang.String reason)

Deprecated.

Opens the first cash drawer found connected to the Clover device.

Parameters:

reason - The reason for opening the cash drawer.

printText

@Deprecated
void printText(java.util.List<java.lang.String> messages)

Deprecated. Use print(PrintRequest request) instead.

Prints custom messages in plain text through the Clover Mini's built-in printer.

Parameters:

messages - An array of text messages to print.

printImage

@Deprecated
void printImage(Bitmap image)

Deprecated. Use print(PrintRequest request) instead.

Prints an image on paper receipts through the Clover Mini's built-in printer.

Parameters:

image - The image to print.

printImageFromURL

@Deprecated
void printImageFromURL(java.lang.String url)

Deprecated. Use print(PrintRequest request) instead.

Prints an image from the web on paper receipts through the Clover device's built-in printer.

Parameters:

url - The URL for the image to print.

showMessage

void showMessage(java.lang.String message)

Displays a string-based message on the Clover device's screen.

Parameters:

message - The string message to display.

showWelcomeScreen

void showWelcomeScreen()

Displays the welcome screen on the Clover device.

showThankYouScreen

void showThankYouScreen()

Displays the thank you screen on the Clover device.

displayPaymentReceiptOptions

@Deprecated
void displayPaymentReceiptOptions(java.lang.String orderId,
                                              java.lang.String paymentId)

Deprecated.

Displays the customer-facing receipt options (print, email, etc.) for a Payment on the Clover device.

Parameters:

paymentId - The ID of the Payment associated with the receipt.

orderId - The ID of the Order associated with the receipt.

displayPaymentReceiptOptions

void displayPaymentReceiptOptions(DisplayReceiptOptionsRequest request)

Displays the customer-facing payment receipt options (print, email, etc.) for a Payment on the Clover device.

Parameters:

DisplayReceiptOptionsRequest - The request.

showDisplayOrder

void showDisplayOrder(DisplayOrder order)

Displays an Order and associated lineItems on the Clover device. Will replace an Order that is already displayed on the device screen.

Parameters:

order - The Order to display.

removeDisplayOrder

void removeDisplayOrder(DisplayOrder order)

Removes the DisplayOrder object from the Clover device's screen.

Parameters:

order - The Order to remove.

dispose

void dispose()

Disposes the connection to the Clover device. After this is called, the connection to the device is severed, and the CloverConnector object is no longer usable. Instantiate a new CloverConnector object in order to call initializeConnection().

invokeInputOption

void invokeInputOption(InputOption io)

Sends a keystroke to the Clover device that invokes an input option (OK, CANCEL, DONE, etc.) on the customer's behalf. InputOptions are on the CloverDeviceEvent passed to onDeviceActivityStart().

Parameters:

io - The input option to invoke.

resetDevice

void resetDevice()

Sends a request to reset the Clover device back to the welcome screen. Can be used when the device is in an unknown or invalid state from the perspective of the POS. NOTE: This request could cause the POS to miss a transaction or other information. Use cautiously as a last resort.

retrievePendingPayments

void retrievePendingPayments()

Retrieves a list of unprocessed Payments that were taken offline and are pending submission to the server.

readCardData

void readCardData(ReadCardDataRequest request)

Requests card information (specifically Track 1 and Track 2 card data).

Parameters:

request - The ReadCardDataRequest details.

sendMessageToActivity

void sendMessageToActivity(MessageToActivity request)

Sends a message to a Custom Activity running on a Clover device.

Parameters:

request - The MessageToActivity with the message to send to the Custom Activity.

startCustomActivity

void startCustomActivity(CustomActivityRequest request)

Starts a Custom Activity on the Clover device.

Parameters:

request - The CustomActivityRequest details.

retrieveDeviceStatus

void retrieveDeviceStatus(RetrieveDeviceStatusRequest request)

Sends a message requesting the current status of the Clover device.

Parameters:

request - The RetrieveDeviceStatusRequest details.

retrievePayment

void retrievePayment(RetrievePaymentRequest request)

Requests the Payment information associated with the externalPaymentId passed in. Only valid for Payments made in the past 24 hours on the Clover device queried.

Parameters:

request - The request details.