The CloverConnector API serves as the interface for connecting to a Clover device. This document defines the available methods. More...

Inheritance diagram for com.clover.remotepay.sdk.ICloverConnector:

Public Member Functions
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). More...

void	AddCloverConnectorListener (ICloverConnectorListener connectorListener)
	Adds a Clover Connector listener. More...

void	RemoveCloverConnectorListener (ICloverConnectorListener connectorListener)
	Removes a Clover Connector listener. More...

void	Sale (SaleRequest request)
	Requests a Sale transaction (purchase). More...

void	AcceptSignature (VerifySignatureRequest request)
	If a signature is captured during a transaction, this method accepts the signature as entered. More...

void	RejectSignature (VerifySignatureRequest request)
	If a signature is captured during a transaction, this method rejects the signature as entered. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

void	VoidPayment (VoidPaymentRequest request)
	Voids a transaction. More...

void	VoidPaymentRefund (VoidPaymentRefundRequest request)

void	RefundPayment (RefundPaymentRequest request)
	Refunds the full or partial amount of a Payment. More...

void	ManualRefund (ManualRefundRequest request)
	Initiates a Manual Refund transaction (a “Refund” or credit that is not associated with a previous Payment). More...

void	VaultCard (int? 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. Note: The merchant account must be configured to allow payment tokens. More...

void	ReadCardData (ReadCardDataRequest request)
	Requests card information (specifically Track 1 and Track 2 card data). More...

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. More...

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. More...

void	ShowMessage (string message)
	Displays a string-based message on the Clover device's screen. More...

void	ShowWelcomeScreen ()
	Displays the welcome screen on the Clover device. More...

void	ShowThankYouScreen ()
	Displays the thank you screen on the Clover device. More...

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

void	OpenCashDrawer (OpenCashDrawerRequest request)
	Opens the first cash drawer found connected to the Clover device. The reason for opening the cash drawer must be provided. More...

void	ShowDisplayOrder (DisplayOrder order)
	Displays an Order and associated line items on the Clover device. Will replace an Order that is already displayed on the device screen. More...

void	RemoveDisplayOrder (DisplayOrder order)
	Removes the DisplayOrder object from the Clover device's screen. More...

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(). More...

void	InvokeInputOption (transport.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(). More...

void	Print (PrintRequest request)
	Sends a print request using the PrintRequest object. Used to print text, Bitmap image objects, and images from URLs using the specified printer. More...

void	RetrievePrinters (RetrievePrintersRequest request)
	Queries available printers attached to the Clover device using the RetrievePrintersRequest object. More...

void	RetrievePrintJobStatus (PrintJobStatusRequest request)
	Queries the status of a print job using the PrintJobStatusRequest object. More...

void	RetrievePendingPayments ()
	Retrieves a list of unprocessed Payments that were taken offline and are pending submission to the server. More...

void	StartCustomActivity (CustomActivityRequest request)
	Starts a Custom Activity on the Clover device. Note: The Custom Activity must already be set up and configured on the Clover device. More...

void	SendMessageToActivity (MessageToActivity request)
	Sends a message to a Custom Activity running on a Clover device. More...

void	RetrieveDeviceStatus (RetrieveDeviceStatusRequest request)
	Sends a message requesting the current status of the Clover device. More...

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. More...

void	DisplayReceiptOptions (DisplayReceiptOptionsRequest request)
	Display receipt options for a Credit, Refund, or Payment More...

void	RegisterForCustomerProvidedData (RegisterForCustomerProvidedDataRequest request)
	Register to receive customer data with the Clover Loyalty API More...

void	SetCustomerInfo (SetCustomerInfoRequest request)
	Set the Clover Loyalty API's current customer info More...

Detailed Description

The CloverConnector API serves as the interface for connecting to a Clover device. This document defines the available methods.

Definition at line 28 of file ICloverConnector.cs.

Member Function Documentation

◆ AcceptPayment()

void com.clover.remotepay.sdk.ICloverConnector.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.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ AcceptSignature()

void com.clover.remotepay.sdk.ICloverConnector.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().

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ AddCloverConnectorListener()

void com.clover.remotepay.sdk.ICloverConnector.AddCloverConnectorListener ( ICloverConnectorListener connectorListener )

Adds a Clover Connector listener.

Parameters

connectorListener The connection listener.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ Auth()

void com.clover.remotepay.sdk.ICloverConnector.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.

Parameters

request The AuthRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ CapturePreAuth()

void com.clover.remotepay.sdk.ICloverConnector.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

request The CapturePreAuthRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ Closeout()

void com.clover.remotepay.sdk.ICloverConnector.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.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ DisplayPaymentReceiptOptions()

void com.clover.remotepay.sdk.ICloverConnector.DisplayPaymentReceiptOptions ( DisplayPaymentReceiptOptionsRequest request )

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

Parameters

request The request with payment IDs, etc., to locate the receipt

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ DisplayReceiptOptions()

void com.clover.remotepay.sdk.ICloverConnector.DisplayReceiptOptions ( DisplayReceiptOptionsRequest request )

Display receipt options for a Credit, Refund, or Payment

Parameters

request The DisplayReceiptOptionsRequest details

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ Dispose()

void com.clover.remotepay.sdk.ICloverConnector.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().

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ InitializeConnection()

void com.clover.remotepay.sdk.ICloverConnector.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).

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ InvokeInputOption()

void com.clover.remotepay.sdk.ICloverConnector.InvokeInputOption ( transport.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.

◆ ManualRefund()

void com.clover.remotepay.sdk.ICloverConnector.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.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ OpenCashDrawer()

void com.clover.remotepay.sdk.ICloverConnector.OpenCashDrawer ( OpenCashDrawerRequest request )

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

Parameters

request Request with text specifying the reason for opening the cash drawer.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ PreAuth()

void com.clover.remotepay.sdk.ICloverConnector.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.

Parameters

request The PreAuthRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ Print()

void com.clover.remotepay.sdk.ICloverConnector.Print ( PrintRequest request )

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

Parameters

request The PrintRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ ReadCardData()

void com.clover.remotepay.sdk.ICloverConnector.ReadCardData ( ReadCardDataRequest request )

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

Parameters

request The ReadCardDataRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RefundPayment()

void com.clover.remotepay.sdk.ICloverConnector.RefundPayment ( RefundPaymentRequest request )

Refunds the full or partial amount of a Payment.

Parameters

request The RefundPaymentRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RegisterForCustomerProvidedData()

void com.clover.remotepay.sdk.ICloverConnector.RegisterForCustomerProvidedData ( RegisterForCustomerProvidedDataRequest request )

Register to receive customer data with the Clover Loyalty API

Parameters

request

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RejectPayment()

void com.clover.remotepay.sdk.ICloverConnector.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 accept.
challenge	The Challenge that resulted in Payment rejection.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RejectSignature()

void com.clover.remotepay.sdk.ICloverConnector.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().

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RemoveCloverConnectorListener()

void com.clover.remotepay.sdk.ICloverConnector.RemoveCloverConnectorListener ( ICloverConnectorListener connectorListener )

Removes a Clover Connector listener.

Parameters

connectorListener The connection listener.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RemoveDisplayOrder()

void com.clover.remotepay.sdk.ICloverConnector.RemoveDisplayOrder ( DisplayOrder order )

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

Parameters

order The DisplayOrder to remove.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ ResetDevice()

void com.clover.remotepay.sdk.ICloverConnector.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.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RetrieveDeviceStatus()

void com.clover.remotepay.sdk.ICloverConnector.RetrieveDeviceStatus ( RetrieveDeviceStatusRequest request )

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

Parameters

request The RetrieveDeviceStatusRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RetrievePayment()

void com.clover.remotepay.sdk.ICloverConnector.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 RetrievePaymentRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RetrievePendingPayments()

void com.clover.remotepay.sdk.ICloverConnector.RetrievePendingPayments ( )

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

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RetrievePrinters()

void com.clover.remotepay.sdk.ICloverConnector.RetrievePrinters ( RetrievePrintersRequest request )

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

Parameters

request The RetrievePrintersRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ RetrievePrintJobStatus()

void com.clover.remotepay.sdk.ICloverConnector.RetrievePrintJobStatus ( PrintJobStatusRequest request )

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

Parameters

request The PrintJobStatusRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ Sale()

void com.clover.remotepay.sdk.ICloverConnector.Sale ( SaleRequest request )

Requests a Sale transaction (purchase).

Parameters

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

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ SendMessageToActivity()

void com.clover.remotepay.sdk.ICloverConnector.SendMessageToActivity ( MessageToActivity request )

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

Parameters

request The MessageToActivity details to send to the Custom Activity.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ SetCustomerInfo()

void com.clover.remotepay.sdk.ICloverConnector.SetCustomerInfo ( SetCustomerInfoRequest request )

Set the Clover Loyalty API's current customer info

Parameters

request

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ ShowDisplayOrder()

void com.clover.remotepay.sdk.ICloverConnector.ShowDisplayOrder ( DisplayOrder order )

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

Parameters

order The DisplayOrder to display.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ ShowMessage()

void com.clover.remotepay.sdk.ICloverConnector.ShowMessage ( string message )

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

Parameters

message The string message to display.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ ShowThankYouScreen()

void com.clover.remotepay.sdk.ICloverConnector.ShowThankYouScreen ( )

Displays the thank you screen on the Clover device.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ ShowWelcomeScreen()

void com.clover.remotepay.sdk.ICloverConnector.ShowWelcomeScreen ( )

Displays the welcome screen on the Clover device.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ StartCustomActivity()

void com.clover.remotepay.sdk.ICloverConnector.StartCustomActivity ( CustomActivityRequest request )

Starts a Custom Activity on the Clover device. Note: The Custom Activity must already be set up and configured on the Clover device.

Parameters

request The CustomActivityRequest details.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ TipAdjustAuth()

void com.clover.remotepay.sdk.ICloverConnector.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.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ VaultCard()

void com.clover.remotepay.sdk.ICloverConnector.VaultCard ( int? 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. Note: The merchant account must be configured to allow payment tokens.

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.

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ VoidPayment()

void com.clover.remotepay.sdk.ICloverConnector.VoidPayment ( VoidPaymentRequest request )

Voids a transaction.

Parameters

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

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

◆ VoidPaymentRefund()

void com.clover.remotepay.sdk.ICloverConnector.VoidPaymentRefund ( VoidPaymentRefundRequest request )

Parameters

request

Implemented in com.clover.remotepay.sdk.CloverConnector, and Clover.RemotePay.CloverEventConnector.

The documentation for this interface was generated from the following file:

c:/git/winsdk-branches/Develop/lib/CloverConnector/com/clover/remotepay/sdk/ICloverConnector.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ AcceptPayment()

◆ AcceptSignature()

◆ AddCloverConnectorListener()

◆ Auth()

◆ CapturePreAuth()

◆ Closeout()

◆ DisplayPaymentReceiptOptions()

◆ DisplayReceiptOptions()

◆ Dispose()

◆ InitializeConnection()

◆ InvokeInputOption()

◆ ManualRefund()

◆ OpenCashDrawer()

◆ PreAuth()

◆ Print()

◆ ReadCardData()

◆ RefundPayment()

◆ RegisterForCustomerProvidedData()

◆ RejectPayment()

◆ RejectSignature()

◆ RemoveCloverConnectorListener()

◆ RemoveDisplayOrder()

◆ ResetDevice()

◆ RetrieveDeviceStatus()

◆ RetrievePayment()

◆ RetrievePendingPayments()

◆ RetrievePrinters()

◆ RetrievePrintJobStatus()

◆ Sale()

◆ SendMessageToActivity()

◆ SetCustomerInfo()

◆ ShowDisplayOrder()

◆ ShowMessage()

◆ ShowThankYouScreen()

◆ ShowWelcomeScreen()

◆ StartCustomActivity()

◆ TipAdjustAuth()

◆ VaultCard()

◆ VoidPayment()

◆ VoidPaymentRefund()