Class: ICloverConnector

remotepay.ICloverConnector()

new ICloverConnector()

Source:

Methods

(static) ICloverConnector#acceptPayment(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. For more information, see Working with Challenges.
Parameters:
Name Type Description
payment payments.Payment
Source:
Returns:
void

(static) ICloverConnector#acceptSignature(request)

If a signature is captured during a transaction, this method accepts the signature as entered.
Parameters:
Name Type Description
request remotepay.VerifySignatureRequest
Source:
Returns:
void

(static) ICloverConnector#auth(authRequest)

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:
Name Type Description
authRequest remotepay.AuthRequest
Source:
Returns:
void

(static) ICloverConnector#capturePreAuth(capturePreAuthRequest)

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:
Name Type Description
capturePreAuthRequest remotepay.CapturePreAuthRequest
Source:
Returns:
void

(static) ICloverConnector#checkBalance(request, request)

Check the balance on a card, if card supports balance inquiry
Parameters:
Name Type Description
request
request remotepay.CheckBalanceRequest
Source:
Returns:
void

(static) ICloverConnector#closeout(closeoutRequest)

Sends a request to the Clover server to close out all transactions. Note: The merchant account must be configured to allow transaction closeout.
Parameters:
Name Type Description
closeoutRequest remotepay.CloseoutRequest
Source:
Returns:
void

(static) ICloverConnector#discountAddedToDisplayOrder(discount, order)

Notify device of a discount being added to the order. The discount will then reflect in the displayOrder. Note: This is independent of a discount being added to a display line item.
Parameters:
Name Type Description
discount order.DisplayDiscount
order order.DisplayOrder
Source:
Returns:
void

(static) ICloverConnector#discountRemovedFromDisplayOrder(discount, order)

Notify device of a discount being removed to the order. The discount will then reflect in the displayOrder. Note: This is independent of a discount being removed to a display line item.
Parameters:
Name Type Description
discount order.DisplayDiscount
order order.DisplayOrder
Source:
Returns:
void

(static) ICloverConnector#displayReceiptOptions(request, request)

Display receipt options for a Credit, Refund, or Payment
Parameters:
Name Type Description
request The request details
request remotepay.DisplayReceiptOptionsRequest
Source:
Returns:
void

(static) 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().
Source:
Returns:
void

(static) ICloverConnector#incrementPreAuth(incrementPreauthRequest)

Increases the total authorized amount of an open PreAuth by the amount increment passed into the request.
Parameters:
Name Type Description
incrementPreauthRequest remotepay.IncrementPreAuthRequest
Source:
Returns:
void

(static) 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).
Source:
Returns:
void

(static) ICloverConnector#invokeInputOption(io)

Sends a keystroke to the Clover device that invokes an input option (e.g. OK, CANCEL, DONE, etc.) on the customer's behalf. InputOptions are in the CloverDeviceEvent passed to onDeviceActivityStart().
Parameters:
Name Type Description
io remotepay.InputOption
Source:
Returns:
void

(static) ICloverConnector#lineItemAddedToDisplayOrder(lineItem, order)

Notify device of a line item being added to the order. The line item will then reflect in the displayOrder. Note: This is independent of a line item being added to a display line item.
Parameters:
Name Type Description
lineItem order.DisplayLineItem
order order.DisplayOrder
Source:
Returns:
void

(static) ICloverConnector#lineItemRemovedFromDisplayOrder(lineItem, order)

Notify device of a line item being removed to the order. The line item will then reflect in the displayOrder. Note: This is independent of a line item being removed to a display line item.
Parameters:
Name Type Description
lineItem order.DisplayLineItem
order order.DisplayOrder
Source:
Returns:
void

(static) ICloverConnector#manualRefund(request)

Initiates a Manual Refund transaction (a "Refund" or credit that is not associated with a previous Payment).
Parameters:
Name Type Description
request remotepay.ManualRefundRequest
Source:
Returns:
void

(static) ICloverConnector#openCashDrawer(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:
Name Type Description
request remotepay.OpenCashDrawerRequest
Source:
Returns:
void

(static) ICloverConnector#preAuth(preAuthRequest)

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:
Name Type Description
preAuthRequest remotepay.PreAuthRequest
Source:
Returns:
void

(static) ICloverConnector#print(request)

Sends a print request using the PrintRequest object. Used to print text, Bitmap image objects, and images from a URL using the specified Clover-supported printer.
Parameters:
Name Type Description
request remotepay.PrintRequest
Source:
Returns:
void

(static) ICloverConnector#readCardData(request)

Requests card information (specifically Track 1 and Track 2 card data).
Parameters:
Name Type Description
request remotepay.ReadCardDataRequest
Source:
See:
  • ICloverConnectorListener.onReadCardDataResponse(ReadCardDataResponse)
Returns:
void

(static) ICloverConnector#refundPayment(request)

Refunds the full or partial amount of a Payment.
Parameters:
Name Type Description
request remotepay.RefundPaymentRequest
Source:
Returns:
void

(static) ICloverConnector#registerForCustomerProvidedData(request)

Register an interest in receiving customer provided data.
Parameters:
Name Type Description
request remotepay.RegisterForCustomerProvidedDataRequest
Source:
Returns:
void

(static) ICloverConnector#rejectPayment(payment, 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. For more information, see Working with Challenges.
Parameters:
Name Type Description
payment payments.Payment
challenge base.Challenge
Source:
Returns:
void

(static) ICloverConnector#rejectSignature(request)

If a signature is captured during a transaction, this method rejects the signature as entered.
Parameters:
Name Type Description
request remotepay.VerifySignatureRequest
Source:
Returns:
void

(static) ICloverConnector#removeDisplayOrder(order)

Removes the DisplayOrder object from the Clover device's screen.
Parameters:
Name Type Description
order order.DisplayOrder
Source:
Returns:
void

(static) 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.
Source:
Returns:
void

(static) ICloverConnector#retrieveDeviceStatus(request) → {Null}

Sends a message requesting the current status of the Clover device.
Parameters:
Name Type Description
request remotepay.RetrieveDeviceStatusRequest
Source:
Returns:
Type
Null

(static) ICloverConnector#retrievePayment(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:
Name Type Description
request remotepay.RetrievePaymentRequest
Source:
See:
  • ICloverConnectorListener.onRetrievePaymentResponse(RetrievePaymentResponse)
Returns:
void

(static) ICloverConnector#retrievePendingPayments()

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

(static) ICloverConnector#retrievePrinters(request)

Queries available printers attached to the Clover device using the RetrievePrintersRequest object.
Parameters:
Name Type Description
request remotepay.RetrievePrintersRequest
Source:
See:
  • ICloverConnectorListener.onRetrievePrintersResponse(RetrievePrintersResponse)
Returns:
void

(static) ICloverConnector#retrievePrintJobStatus(request)

Queries the status of a print job.
Parameters:
Name Type Description
request remotepay.PrintJobStatusRequest
Source:
See:
  • ICloverConnectorListener.onPrintJobStatusResponse(PrintJobStatusResponse)
Returns:
void

(static) ICloverConnector#sale(request)

Requests a Sale transaction (purchase).
Parameters:
Name Type Description
request remotepay.SaleRequest
Source:
Returns:
void

(static) ICloverConnector#sendMessageToActivity(request)

Sends a message to a Custom Activity running on a Clover device.
Parameters:
Name Type Description
request remotepay.MessageToActivity
Source:
See:
  • ICloverConnectorListener.onMessageFromActivity(MessageFromActivity)
Returns:
void

(static) ICloverConnector#setCustomerInfo(request)

Parameters:
Name Type Description
request remotepay.SetCustomerInfoRequest
Source:
Returns:
void

(static) ICloverConnector#showDisplayOrder(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:
Name Type Description
order order.DisplayOrder
Source:
Returns:
void

(static) ICloverConnector#showMessage(message)

Displays a string-based message on the Clover device's screen.
Parameters:
Name Type Description
message String
Source:
Returns:
void

(static) ICloverConnector#showThankYouScreen()

Displays the thank you screen on the Clover device.
Source:
Returns:
void

(static) ICloverConnector#showWelcomeScreen()

Displays the welcome screen on the Clover device.
Source:
Returns:
void

(static) ICloverConnector#startCustomActivity(request)

Starts a Custom Activity on the Clover device.
Parameters:
Name Type Description
request remotepay.CustomActivityRequest
Source:
Returns:
void

(static) ICloverConnector#tipAdjustAuth(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:
Name Type Description
request remotepay.TipAdjustAuthRequest
Source:
Returns:
void

(static) ICloverConnector#vaultCard(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. Note: If the cardEntryMethods param is null, the default values (CARD_ENTRY_METHOD_MAG_STRIPE, CARD_ENTRY_METHOD_ICC_CONTACT, and CARD_ENTRY_METHOD_NFC_CONTACTLESS) will be used.
Parameters:
Name Type Description
cardEntryMethods Number must be an integer
Source:
Returns:
void

(static) ICloverConnector#voidPayment(request)

Voids a transaction.
Parameters:
Name Type Description
request remotepay.VoidPaymentRequest
Source:
Returns:
void