ICloverConnector

public protocol ICloverConnector : AnyObject

Interface to the Clover remote-pay API.

Defines the interface used to interact with remote pay adapters.

  • Declaration

    Swift

    public protocol ICloverConnector : AnyObject

  • Declaration

    Swift

    public protocol ICloverConnector : AnyObject

  • Must be called to initialize the connection to the Clover device before calling any other methods on ICloverConnector

    Declaration

    Swift

    func initializeConnection() -> Void

  • Request a sale operation. parameter: SaleRequest

    Declaration

    Swift

    func  sale ( _ saleRequest:SaleRequest ) -> Void

  • Request an authorization operation.

    Declaration

    Swift

    func  auth ( _ authRequest:AuthRequest ) -> Void

  • Request a preauth operation.

    Declaration

    Swift

    func  preAuth ( _ preAuthRequest:PreAuthRequest ) -> Void

  • Request a preauth be captured.

    Declaration

    Swift

    func  capturePreAuth ( _ capturePreAuthRequest:CapturePreAuthRequest ) -> Void

  • Request a tip adjustment to an auth.

    Declaration

    Swift

    func  tipAdjustAuth ( _ authTipAdjustRequest:TipAdjustAuthRequest ) -> Void

  • Request a payment be voided.

    Declaration

    Swift

    func  voidPayment ( _ voidPaymentRequest:VoidPaymentRequest ) -> Void

  • Request a payment be refunded.

    Declaration

    Swift

    func  refundPayment ( _ refundPaymentRequest:RefundPaymentRequest ) -> Void

  • Request an amount be refunded.

    Declaration

    Swift

    func  manualRefund ( _ manualRefundRequest:ManualRefundRequest ) -> Void

  • Request a cancel be sent to the device.

    Use resetDevice() or invokeInputOption() with the screen appropriate options instead.

    Declaration

    Swift

    func  cancel () -> Void

  • Request a closeout.

    Declaration

    Swift

    func  closeout ( _ closeoutRequest:CloseoutRequest ) -> Void

  • Request receipt options be displayed for a payment.

    Declaration

    Swift

    func displayPaymentReceiptOptions( _ orderId:String, paymentId: String) -> Void

  • Accept a signature verification request.

    Declaration

    Swift

    func  acceptSignature ( _ signatureVerifyRequest:VerifySignatureRequest ) -> Void

  • Reject a signature verification request.

    Declaration

    Swift

    func  rejectSignature ( _ signatureVerifyRequest:VerifySignatureRequest ) -> Void

  • Request to vault a card.

    Declaration

    Swift

    func  vaultCard ( _ vaultCardRequest:VaultCardRequest ) -> Void

  • Request to print some text on the default printer.

    Declaration

    Swift

    func  printText ( _ lines:[String] ) -> Void

  • Request to print an image on the default printer.

    The size of the image should be limited, and the optimal width of the image is 384 pixels.

    The img parameter type is implementation specific to the adapter.

    Declaration

    Swift

    public protocol ICloverConnector : AnyObject

  • Request to print an image based on a url

    Declaration

    Swift

    func printImageFromURL(_ url:String) -> Void

  • Request that the cash drawer connected to the device be opened.

    Declaration

    Swift

    func  openCashDrawer (_ reason: String) -> Void

  • Request to place a message on the device screen.

    Declaration

    Swift

    func  showMessage ( _ message:String ) -> Void

  • Request to display the default welcome screen on the device.

    Declaration

    Swift

    func  showWelcomeScreen () -> Void

  • Request to display the default thank you screen on the device.

    Declaration

    Swift

    func  showThankYouScreen () -> Void

  • Request to display an order on the device.

    Declaration

    Swift

    func  showDisplayOrder ( _ order:DisplayOrder ) -> Void

  • Request to display an order on the device.

    Declaration

    Swift

    func  removeDisplayOrder ( _ order:DisplayOrder ) -> Void

  • sends a reset request to the device if the POS and device get out of sync.

    Declaration

    Swift

    func  resetDevice ( ) -> Void

  • Declaration

    Swift

    func invokeInputOption( _ inputOption:InputOption ) -> Void

  • Used to request card information. Specifically track1 and track2 information

    Declaration

    Swift

    func readCardData( _ request:ReadCardDataRequest ) -> Void

  • If payment confirmation is required during a Sale, this method accepts the payment

    Declaration

    Swift

    func acceptPayment( _ payment:CLVModels.Payments.Payment ) -> Void

  • If payment confirmation is required during a Sale, this method rejects the payment

    Declaration

    Swift

    func rejectPayment( _ payment:CLVModels.Payments.Payment, challenge:Challenge ) -> Void

  • Used to request a list of pending payments that have been taken offline, but haven’t processed yet. will trigger an onRetrievePendingPaymentsResponse callback

    Declaration

    Swift

    func retrievePendingPayments() -> Void

  • Disposes the connector and any connections created by the connector.

    Declaration

    Swift

    func dispose() -> Void

  • start an custom activity on the device

    Declaration

    Swift

    func startCustomActivity(_ request:CustomActivityRequest) -> Void

  • send a message to a currently running custom activity

    Declaration

    Swift

    func sendMessageToActivity(_ request:MessageToActivity) -> Void

  • request the current status of the device

    Declaration

    Swift

    func retrieveDeviceStatus(_request: RetrieveDeviceStatusRequest) -> Void

  • request the payment for a given external id

    Declaration

    Swift

    func retrievePayment(_request: RetrievePaymentRequest) -> Void

  • Request to print an image on the default printer.

    The size of the image should be limited, and the optimal width of the image is 384 pixels.

    The img parameter type is implementation specific to the adapter.

    Declaration

    Swift

    public protocol ICloverConnector : AnyObject