CloverConnector
3.0.2
Copyright (C) 2018 Clover Network, Inc.
|
These are the methods to implement for intercepting messages that are sent from a Clover device. More...
Public Member Functions | |
void | OnDeviceActivityStart (CloverDeviceEvent deviceEvent) |
Called when the Clover device transitions to a new screen or activity. The CloverDeviceEvent passed in will contain an event type, a description, and a list of available InputOptions. More... | |
void | OnDeviceActivityEnd (CloverDeviceEvent deviceEvent) |
Called when the Clover device transitions away from a screen or activity. The CloverDeviceEvent passed in will contain an event type and description. Note: The start and end events are not guaranteed to process in order. The event type should be used to make sure these events are paired. More... | |
void | OnDeviceError (CloverDeviceErrorEvent deviceErrorEvent) |
Called when an error occurs while trying to send messages to the Clover device. More... | |
void | OnPreAuthResponse (PreAuthResponse response) |
Called in response to a PreAuth() request. Note: The boolean IsPreAuth flag in the PreAuthResponse indicates whether CapturePreAuth() can be called for the returned Payment. If the IsPreAuth flag is false and the IsAuth flag is true, then the payment gateway coerced the PreAuth() request to an Auth. The payment will need to be voided or it will be automatically captured at closeout. More... | |
void | OnAuthResponse (AuthResponse response) |
Called in response to an Auth() request. Note: An Auth transaction may come back as a final Sale, depending on the payment gateway. The AuthResponse has a boolean IsAuth flag that indicates whether the Payment can still be tip-adjusted. More... | |
void | OnTipAdjustAuthResponse (TipAdjustAuthResponse response) |
Called in response to a tip adjustment for an Auth transaction. Contains the TipAmount if successful. More... | |
void | OnCapturePreAuthResponse (CapturePreAuthResponse response) |
Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful. More... | |
void | OnVerifySignatureRequest (VerifySignatureRequest request) |
Called when the Clover device requests verification for a user's on-screen signature. The Payment and Signature will be passed in. More... | |
void | OnConfirmPaymentRequest (ConfirmPaymentRequest request) |
Called when the Clover device encounters a Challenge at the payment gateway and requires confirmation. A Challenge is triggered by a potential duplicate Payment (DUPLICATE_CHALLENGE) or an offline Payment (OFFLINE_CHALLENGE). The device sends an OnConfirmPaymentRequest() asking the merchant to reply by sending either an AcceptPayment() or RejectPayment() call. More... | |
void | OnCloseoutResponse (CloseoutResponse response) |
Called in response to a Closeout() request. More... | |
void | OnSaleResponse (SaleResponse response) |
Called at the completion of a Sale() request. The SaleResponse contains a { More... | |
void | OnManualRefundResponse (ManualRefundResponse response) |
Called in response to a ManualRefund() request. Contains a { More... | |
void | OnRefundPaymentResponse (RefundPaymentResponse response) |
Called in response to a RefundPayment() request. Contains a { More... | |
void | OnVoidPaymentRefundResponse (VoidPaymentRefundResponse response) |
Called in response to a VoidPaymentRefund() request with results. More... | |
void | OnTipAdded (TipAddedMessage message) |
Called when a customer selects a tip amount on the Clover device's screen. More... | |
void | OnVoidPaymentResponse (VoidPaymentResponse response) |
Called in response to a VoidPayment() request. Contains a { More... | |
void | OnDeviceConnected () |
Called when the Clover device is initially connected, but not ready to communicate. More... | |
void | OnDeviceReady (MerchantInfo merchantInfo) |
Called when the Clover device is ready to communicate and respond to requests. More... | |
void | OnDeviceDisconnected () |
Called when the Clover device is disconnected from the CloverConnector or not responding. More... | |
void | OnVaultCardResponse (VaultCardResponse response) |
Called in response to a VaultCard() request. Contains a { More... | |
void | OnRetrievePendingPaymentsResponse (RetrievePendingPaymentsResponse response) |
Called in response to a RetrievePendingPayment() request. More... | |
void | OnReadCardDataResponse (ReadCardDataResponse response) |
Called in response to a ReadCardData() request. Contains card information (specifically Track 1 and Track 2 card data). More... | |
void | OnPrintManualRefundReceipt (PrintManualRefundReceiptMessage message) |
Called when a user requests a paper receipt for a Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request. More... | |
void | OnPrintManualRefundDeclineReceipt (PrintManualRefundDeclineReceiptMessage message) |
Called when a user requests a paper receipt for a declined Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request. More... | |
void | OnPrintPaymentReceipt (PrintPaymentReceiptMessage message) |
Called when a user requests a paper receipt for a Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request. More... | |
void | OnPrintPaymentDeclineReceipt (PrintPaymentDeclineReceiptMessage message) |
Called when a user requests a paper receipt for a declined Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request. More... | |
void | OnPrintPaymentMerchantCopyReceipt (PrintPaymentMerchantCopyReceiptMessage message) |
Called when a user requests a merchant copy of a Payment receipt. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request. More... | |
void | OnPrintRefundPaymentReceipt (PrintRefundPaymentReceiptMessage message) |
Called when a user requests a paper receipt for a Payment Refund. Will only be called if DisablePrinting = true on the Sale(), Auth(), PreAuth() or ManualRefund() request. More... | |
void | OnPrintJobStatusResponse (PrintJobStatusResponse response) |
Called in response to a RetrievePrintJobStatus() request. More... | |
void | OnRetrievePrintersResponse (RetrievePrintersResponse response) |
Called in response to a RetrievePrinters() request. More... | |
void | OnCustomActivityResponse (CustomActivityResponse response) |
Called when a Custom Activity finishes normally. More... | |
void | OnRetrieveDeviceStatusResponse (RetrieveDeviceStatusResponse response) |
Called in response to a RetrieveDeviceStatus() request. More... | |
void | OnMessageFromActivity (MessageFromActivity response) |
Called when a Custom Activity sends a message to the POS. More... | |
void | OnResetDeviceResponse (ResetDeviceResponse response) |
Called in response to a ResetDevice() request. More... | |
void | OnRetrievePaymentResponse (RetrievePaymentResponse response) |
Called in response to a RetrievePayment() request. More... | |
void | OnPrintJobStatusRequest (PrintJobStatusRequest request) |
Called in response to a RetrievePrintJobStatus() request. More... | |
void | OnDisplayReceiptOptionsResponse (DisplayReceiptOptionsResponse response) |
Called in response to a DisplayReceiptOptions request. More... | |
void | OnCustomerProvidedData (CustomerProvidedDataEvent response) |
Called when Loyalty API sends customer identifying data for a loyalty data type subscribed to in CloverConnector.RegisterForCustomerProvidedData() More... | |
These are the methods to implement for intercepting messages that are sent from a Clover device.
Definition at line 23 of file ICloverConnectorListener.cs.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnAuthResponse | ( | AuthResponse | response | ) |
Called in response to an Auth() request. Note: An Auth transaction may come back as a final Sale, depending on the payment gateway. The AuthResponse has a boolean IsAuth flag that indicates whether the Payment can still be tip-adjusted.
response | The AuthResponse to the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnCapturePreAuthResponse | ( | CapturePreAuthResponse | response | ) |
Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful.
response | The CapturePreAuthResponse to the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnCloseoutResponse | ( | CloseoutResponse | response | ) |
Called in response to a Closeout() request.
response | The CloseoutResponse details for the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnConfirmPaymentRequest | ( | ConfirmPaymentRequest | request | ) |
Called when the Clover device encounters a Challenge at the payment gateway and requires confirmation. A Challenge is triggered by a potential duplicate Payment (DUPLICATE_CHALLENGE) or an offline Payment (OFFLINE_CHALLENGE). The device sends an OnConfirmPaymentRequest() asking the merchant to reply by sending either an AcceptPayment() or RejectPayment() call.
Note: Duplicate Payment Challenges are raised when multiple Payments are made with the same card type and last four digits within the same hour. For this reason, we recommend that you do not programmatically call CloverConnector.RejectPayment() on all instances of DUPLICATE_CHALLENGE. For more information, see with Challenges.
request | The ConfirmPaymentRequest for confirmation. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnCustomActivityResponse | ( | CustomActivityResponse | response | ) |
Called when a Custom Activity finishes normally.
response | The CustomActivityResponse. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnCustomerProvidedData | ( | CustomerProvidedDataEvent | response | ) |
Called when Loyalty API sends customer identifying data for a loyalty data type subscribed to in CloverConnector.RegisterForCustomerProvidedData()
response | The CustomerProvidedDataEvent containing type and data payload, like PHONE, 555-1212 in type-specific custom encoding |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceActivityEnd | ( | CloverDeviceEvent | deviceEvent | ) |
Called when the Clover device transitions away from a screen or activity. The CloverDeviceEvent passed in will contain an event type and description. Note: The start and end events are not guaranteed to process in order. The event type should be used to make sure these events are paired.
deviceEvent | The CloverDeviceEvent event. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceActivityStart | ( | CloverDeviceEvent | deviceEvent | ) |
Called when the Clover device transitions to a new screen or activity. The CloverDeviceEvent passed in will contain an event type, a description, and a list of available InputOptions.
deviceEvent | The CloverDeviceEvent event. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceConnected | ( | ) |
Called when the Clover device is initially connected, but not ready to communicate.
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceDisconnected | ( | ) |
Called when the Clover device is disconnected from the CloverConnector or not responding.
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceError | ( | CloverDeviceErrorEvent | deviceErrorEvent | ) |
Called when an error occurs while trying to send messages to the Clover device.
deviceErrorEvent | The CloverDeviceErrorEvent event. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceReady | ( | MerchantInfo | merchantInfo | ) |
Called when the Clover device is ready to communicate and respond to requests.
merchantInfo | The MerchantInfo details to associate with the device. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnDisplayReceiptOptionsResponse | ( | DisplayReceiptOptionsResponse | response | ) |
Called in response to a DisplayReceiptOptions request.
response | The DisplayReceiptOptionsResponse details for the response. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnManualRefundResponse | ( | ManualRefundResponse | response | ) |
Called in response to a ManualRefund() request. Contains a {
response | The ManualRefundResponse details for the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnMessageFromActivity | ( | MessageFromActivity | response | ) |
Called when a Custom Activity sends a message to the POS.
response | The MessageFromActivity details. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPreAuthResponse | ( | PreAuthResponse | response | ) |
Called in response to a PreAuth() request. Note: The boolean IsPreAuth flag in the PreAuthResponse indicates whether CapturePreAuth() can be called for the returned Payment. If the IsPreAuth flag is false and the IsAuth flag is true, then the payment gateway coerced the PreAuth() request to an Auth. The payment will need to be voided or it will be automatically captured at closeout.
response | The PreAuthResponse details. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintJobStatusRequest | ( | PrintJobStatusRequest | request | ) |
Called in response to a RetrievePrintJobStatus() request.
request | The PrintJobStatusResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintJobStatusResponse | ( | PrintJobStatusResponse | response | ) |
Called in response to a RetrievePrintJobStatus() request.
response | The PrintJobStatusResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintManualRefundDeclineReceipt | ( | PrintManualRefundDeclineReceiptMessage | message | ) |
Called when a user requests a paper receipt for a declined Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request.
message | The PrintManualRefundDeclineReceiptMessage. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintManualRefundReceipt | ( | PrintManualRefundReceiptMessage | message | ) |
Called when a user requests a paper receipt for a Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request.
message | A callback that asks the POS to print a receipt for a ManualRefund. Contains a Credit object. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintPaymentDeclineReceipt | ( | PrintPaymentDeclineReceiptMessage | message | ) |
Called when a user requests a paper receipt for a declined Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request.
message | The PrintPaymentDeclineReceiptMessage details. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintPaymentMerchantCopyReceipt | ( | PrintPaymentMerchantCopyReceiptMessage | message | ) |
Called when a user requests a merchant copy of a Payment receipt. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request.
message | The PrintPaymentMerchantCopyReceiptMessage details. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintPaymentReceipt | ( | PrintPaymentReceiptMessage | message | ) |
Called when a user requests a paper receipt for a Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request.
message | The PrintPaymentReceiptMessage details. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnPrintRefundPaymentReceipt | ( | PrintRefundPaymentReceiptMessage | message | ) |
Called when a user requests a paper receipt for a Payment Refund. Will only be called if DisablePrinting = true on the Sale(), Auth(), PreAuth() or ManualRefund() request.
message | The PrintRefundPaymentReceiptMessage details. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnReadCardDataResponse | ( | ReadCardDataResponse | response | ) |
Called in response to a ReadCardData() request. Contains card information (specifically Track 1 and Track 2 card data).
response | The ReadCardDataResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnRefundPaymentResponse | ( | RefundPaymentResponse | response | ) |
Called in response to a RefundPayment() request. Contains a {
response | The RefundPaymentResponse details for the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnResetDeviceResponse | ( | ResetDeviceResponse | response | ) |
Called in response to a ResetDevice() request.
response | The ResetDeviceResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnRetrieveDeviceStatusResponse | ( | RetrieveDeviceStatusResponse | response | ) |
Called in response to a RetrieveDeviceStatus() request.
response | The RetrieveDeviceStatusResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnRetrievePaymentResponse | ( | RetrievePaymentResponse | response | ) |
Called in response to a RetrievePayment() request.
response | The RetrievePaymentResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnRetrievePendingPaymentsResponse | ( | RetrievePendingPaymentsResponse | response | ) |
Called in response to a RetrievePendingPayment() request.
response | The RetrievePendingPaymentsResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnRetrievePrintersResponse | ( | RetrievePrintersResponse | response | ) |
Called in response to a RetrievePrinters() request.
response | The RetrievePrintersResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnSaleResponse | ( | SaleResponse | response | ) |
Called at the completion of a Sale() request. The SaleResponse contains a {
response | The SaleResponse details for the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnTipAdded | ( | TipAddedMessage | message | ) |
Called when a customer selects a tip amount on the Clover device's screen.
message | The TipAddedMessage. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnTipAdjustAuthResponse | ( | TipAdjustAuthResponse | response | ) |
Called in response to a tip adjustment for an Auth transaction. Contains the TipAmount if successful.
response | The TipAdjustAuthResponse to the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnVaultCardResponse | ( | VaultCardResponse | response | ) |
Called in response to a VaultCard() request. Contains a {
response | The VaultCardResponse details for the request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnVerifySignatureRequest | ( | VerifySignatureRequest | request | ) |
Called when the Clover device requests verification for a user's on-screen signature. The Payment and Signature will be passed in.
request | The VerifySignatureRequest. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnVoidPaymentRefundResponse | ( | VoidPaymentRefundResponse | response | ) |
Called in response to a VoidPaymentRefund() request with results.
response |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.
void com.clover.remotepay.sdk.ICloverConnectorListener.OnVoidPaymentResponse | ( | VoidPaymentResponse | response | ) |
Called in response to a VoidPayment() request. Contains a {
response | The VoidPaymentResponse details for the transaction request. |
Implemented in Clover.RemotePay.CloverEventConnector, and com.clover.remotepay.sdk.DefaultCloverConnectorListener.