CloverConnector  4.0.2
Copyright (C) 2018 Clover Network, Inc.
com.clover.sdk.v3.payments Namespace Reference

Classes

class  AdditionalCharge
 
class  AdditionalChargeAmount
 
class  AppTracking
 
class  Authorization
 
class  Batch
 
class  BatchCardTotal
 
class  BatchDetail
 
class  BatchRequest
 
class  BatchTotalStats
 
class  BatchTotalType
 
class  CardTransaction
 
class  CashAdvanceCustomerIdentification
 
class  CashAdvanceExtra
 
class  Credit
 
class  DCCInfo
 
class  GatewayTxs
 
class  GermanInfo
 
class  GiftCard
 
class  GiftCardResponse
 
class  GiftCardTransaction
 
class  LineItemPayment
 
class  Payment
 
class  PaymentResponse
 
class  PaymentTaxRate
 
class  Refund
 
class  RegionalExtras
 
class  ServerTotalStats
 
class  ServiceChargeAmount
 
class  SignatureDisclaimer
 
class  TaxableAmountRate
 
class  Transaction
 
class  TransactionInfo
 
class  TransactionSettings
 
class  VaultedCard
 

Enumerations

enum  AccountType { AccountType.CREDIT, AccountType.DEBIT, AccountType.CHECKING, AccountType.SAVINGS }
 
enum  AdditionalChargeType { AdditionalChargeType.INTERAC }
 
enum  AVSResult {
  AVSResult.SUCCESS, AVSResult.ZIP_CODE_MATCH, AVSResult.ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED, AVSResult.ADDRESS_MATCH,
  AVSResult.ADDRESS_MATCH_ZIP_NOT_CHECKED, AVSResult.NEITHER_MATCH, AVSResult.SERVICE_FAILURE, AVSResult.SERVICE_UNAVAILABLE,
  AVSResult.NOT_CHECKED, AVSResult.ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED, AVSResult.ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED
}
 
enum  BatchState {
  BatchState.OPEN, BatchState.QUEUED_FOR_PROCESSING, BatchState.PROCESSING, BatchState.CLOSED,
  BatchState.FAILED
}
 
enum  BatchType { BatchType.MANUAL_CLOSE, BatchType.AUTO_CLOSE }
 
enum  CardEntryType {
  CardEntryType.SWIPED, CardEntryType.KEYED, CardEntryType.VOICE, CardEntryType.VAULTED,
  CardEntryType.OFFLINE_SWIPED, CardEntryType.OFFLINE_KEYED, CardEntryType.EMV_CONTACT, CardEntryType.EMV_CONTACTLESS,
  CardEntryType.MSD_CONTACTLESS, CardEntryType.PINPAD_MANUAL_ENTRY
}
 
enum  CardTransactionState { CardTransactionState.PENDING, CardTransactionState.CLOSED }
 
enum  CardTransactionType {
  CardTransactionType.AUTH, CardTransactionType.PREAUTH, CardTransactionType.PREAUTHCAPTURE, CardTransactionType.ADJUST,
  CardTransactionType.VOID, CardTransactionType.VOIDRETURN, CardTransactionType.RETURN, CardTransactionType.REFUND,
  CardTransactionType.NAKEDREFUND, CardTransactionType.GETBALANCE, CardTransactionType.BATCHCLOSE, CardTransactionType.ACTIVATE,
  CardTransactionType.BALANCE_LOCK, CardTransactionType.LOAD, CardTransactionType.CASHOUT, CardTransactionType.CASHOUT_ACTIVE_STATUS,
  CardTransactionType.REDEMPTION, CardTransactionType.REDEMPTION_UNLOCK, CardTransactionType.RELOAD
}
 
enum  CardType {
  CardType.VISA, CardType.MC, CardType.AMEX, CardType.DISCOVER,
  CardType.DINERS_CLUB, CardType.JCB, CardType.MAESTRO, CardType.SOLO,
  CardType.LASER, CardType.CHINA_UNION_PAY, CardType.CARTE_BLANCHE, CardType.UNKNOWN,
  CardType.GIFT_CARD, CardType.EBT, CardType.INTERAC, CardType.OTHER
}
 
enum  Currency { Currency.USD, Currency.GBP, Currency.EUR }
 
enum  CvmResult {
  CvmResult.NO_CVM_REQUIRED, CvmResult.SIGNATURE, CvmResult.PIN, CvmResult.ONLINE_PIN,
  CvmResult.SIGNATURE_AND_PIN, CvmResult.CVM_FAILED, CvmResult.DEVICE
}
 
enum  CVVResult { CVVResult.SUCCESS, CVVResult.FAILURE, CVVResult.NOT_PROCESSED, CVVResult.NOT_PRESENT }
 
enum  DataEntryLocation { DataEntryLocation.ON_SCREEN, DataEntryLocation.ON_PAPER, DataEntryLocation.NONE }
 
enum  GatewayTxState {
  GatewayTxState.INITIATED, GatewayTxState.INITIATED_ON_AUTH, GatewayTxState.ACKNOWLEDGED, GatewayTxState.CONNECT_FAILED,
  GatewayTxState.TIMEOUT, GatewayTxState.FAILED, GatewayTxState.REVERSE_INITIATED, GatewayTxState.REVERSE_INITIATED_ON_AUTH,
  GatewayTxState.REVERSED, GatewayTxState.REVERSAL_FAILED
}
 
enum  GatewayTxType {
  GatewayTxType.AUTH, GatewayTxType.PREAUTH, GatewayTxType.PREAUTHCAPTURE, GatewayTxType.ADJUST,
  GatewayTxType.VOID, GatewayTxType.VOIDRETURN, GatewayTxType.RETURN, GatewayTxType.REFUND,
  GatewayTxType.NAKEDREFUND, GatewayTxType.GETBALANCE, GatewayTxType.BATCHCLOSE, GatewayTxType.ACTIVATE,
  GatewayTxType.BALANCE_LOCK, GatewayTxType.LOAD, GatewayTxType.CASHOUT, GatewayTxType.CASHOUT_ACTIVE_STATUS,
  GatewayTxType.REDEMPTION, GatewayTxType.REDEMPTION_UNLOCK, GatewayTxType.RELOAD
}
 
enum  GiftCardState { GiftCardState.INVALID, GiftCardState.ACTIVATED, GiftCardState.INACTIVE }
 
enum  IdType { IdType.DRIVERS_LICENSE, IdType.PASSPORT }
 
enum  Result {
  Result.SUCCESS, Result.FAIL, Result.INITIATED, Result.VOIDED,
  Result.VOIDING, Result.AUTH, Result.AUTH_COMPLETED
}
 
enum  ReversalReason { ReversalReason.CHIP_DECLINE, ReversalReason.CARDHOLDER_CANCELLATION, ReversalReason.COMMUNICATION_ERROR, ReversalReason.OTHER_REASON }
 
enum  SelectedService {
  SelectedService.NONE, SelectedService.PAYMENT, SelectedService.REFUND, SelectedService.CANCELLATION,
  SelectedService.PRE_AUTH, SelectedService.UPDATE_PRE_AUTH, SelectedService.PAYMENT_COMPLETION, SelectedService.CASH_ADVANCE,
  SelectedService.DEFERRED_PAYMENT, SelectedService.DEFERRED_PAYMENT_COMPLETION, SelectedService.VOICE_AUTHORISATION, SelectedService.CARDHOLDER_DETECTION
}
 
enum  TipMode {
  TipMode.TIP_PROVIDED, TipMode.ON_SCREEN_BEFORE_PAYMENT, TipMode.ON_SCREEN_AFTER_PAYMENT, TipMode.ON_PAPER,
  TipMode.NO_TIP
}
 
enum  TransactionResult {
  TransactionResult.APPROVED, TransactionResult.DECLINED, TransactionResult.ABORTED, TransactionResult.VOICE_AUTHORISATION,
  TransactionResult.PAYMENT_PART_ONLY, TransactionResult.PARTIALLY_APPROVED, TransactionResult.NONE
}
 
enum  TxFormat { TxFormat.DEFAULT, TxFormat.NEXO }
 
enum  TxType {
  TxType.AUTH, TxType.PREAUTH, TxType.PREAUTHCAPTURE, TxType.ADJUST,
  TxType.VOID, TxType.VOIDRETURN, TxType.RETURN, TxType.REFUND,
  TxType.NAKEDREFUND, TxType.GETBALANCE, TxType.BATCHCLOSE, TxType.ACTIVATE,
  TxType.BALANCE_LOCK, TxType.LOAD, TxType.CASHOUT, TxType.CASHOUT_ACTIVE_STATUS,
  TxType.REDEMPTION, TxType.REDEMPTION_UNLOCK, TxType.RELOAD
}
 
enum  Type { Type.TAB, Type.AUTH }
 
enum  VasDataTypeType {
  VasDataTypeType.ALL, VasDataTypeType.LOYALTY, VasDataTypeType.OFFER, VasDataTypeType.GIFT_CARD,
  VasDataTypeType.PRIVATE_LABEL_CARD, VasDataTypeType.CUSTOMER, VasDataTypeType.VAS_DATA
}
 
enum  VasProtocol { VasProtocol.ST, VasProtocol.PK }
 

Enumeration Type Documentation

◆ AccountType

Enumerator
CREDIT 
DEBIT 
CHECKING 
SAVINGS 

Definition at line 3 of file AccountType.cs.

◆ AdditionalChargeType

Enumerator
INTERAC 

Definition at line 22 of file AdditionalChargeType.cs.

◆ AVSResult

Enumerator
SUCCESS 
ZIP_CODE_MATCH 
ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED 
ADDRESS_MATCH 
ADDRESS_MATCH_ZIP_NOT_CHECKED 
NEITHER_MATCH 
SERVICE_FAILURE 
SERVICE_UNAVAILABLE 
NOT_CHECKED 
ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED 
ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED 

Definition at line 24 of file AVSResult.cs.

◆ BatchState

Enumerator
OPEN 
QUEUED_FOR_PROCESSING 
PROCESSING 
CLOSED 
FAILED 

Definition at line 24 of file BatchState.cs.

◆ BatchType

Enumerator
MANUAL_CLOSE 
AUTO_CLOSE 

Definition at line 24 of file BatchType.cs.

◆ CardEntryType

Enumerator
SWIPED 
KEYED 
VOICE 
VAULTED 
OFFLINE_SWIPED 
OFFLINE_KEYED 
EMV_CONTACT 
EMV_CONTACTLESS 
MSD_CONTACTLESS 
PINPAD_MANUAL_ENTRY 

Definition at line 24 of file CardEntryType.cs.

◆ CardTransactionState

Enumerator
PENDING 
CLOSED 

Definition at line 24 of file CardTransactionState.cs.

◆ CardTransactionType

Enumerator
AUTH 
PREAUTH 
PREAUTHCAPTURE 
ADJUST 
VOID 
VOIDRETURN 
RETURN 
REFUND 
NAKEDREFUND 
GETBALANCE 
BATCHCLOSE 
ACTIVATE 
BALANCE_LOCK 
LOAD 
CASHOUT 
CASHOUT_ACTIVE_STATUS 
REDEMPTION 
REDEMPTION_UNLOCK 
RELOAD 

Definition at line 24 of file CardTransactionType.cs.

◆ CardType

Enumerator
VISA 
MC 
AMEX 
DISCOVER 
DINERS_CLUB 
JCB 
MAESTRO 
SOLO 
LASER 
CHINA_UNION_PAY 
CARTE_BLANCHE 
UNKNOWN 
GIFT_CARD 
EBT 
INTERAC 
OTHER 

Definition at line 24 of file CardType.cs.

◆ Currency

Enumerator
USD 
GBP 
EUR 

Definition at line 24 of file Currency.cs.

◆ CvmResult

Enumerator
NO_CVM_REQUIRED 
SIGNATURE 
PIN 
ONLINE_PIN 
SIGNATURE_AND_PIN 
CVM_FAILED 
DEVICE 

Definition at line 24 of file CvmResult.cs.

◆ CVVResult

Enumerator
SUCCESS 
FAILURE 
NOT_PROCESSED 
NOT_PRESENT 

Definition at line 24 of file CVVResult.cs.

◆ DataEntryLocation

Enumerator
ON_SCREEN 
ON_PAPER 
NONE 

Definition at line 11 of file DataEntryLocation.cs.

◆ GatewayTxState

Enumerator
INITIATED 
INITIATED_ON_AUTH 
ACKNOWLEDGED 
CONNECT_FAILED 
TIMEOUT 
FAILED 
REVERSE_INITIATED 
REVERSE_INITIATED_ON_AUTH 
REVERSED 
REVERSAL_FAILED 

Definition at line 24 of file GatewayTxState.cs.

◆ GatewayTxType

Enumerator
AUTH 
PREAUTH 
PREAUTHCAPTURE 
ADJUST 
VOID 
VOIDRETURN 
RETURN 
REFUND 
NAKEDREFUND 
GETBALANCE 
BATCHCLOSE 
ACTIVATE 
BALANCE_LOCK 
LOAD 
CASHOUT 
CASHOUT_ACTIVE_STATUS 
REDEMPTION 
REDEMPTION_UNLOCK 
RELOAD 

Definition at line 24 of file GatewayTxType.cs.

◆ GiftCardState

Enumerator
INVALID 
ACTIVATED 
INACTIVE 

Definition at line 24 of file GiftCardState.cs.

◆ IdType

Enumerator
DRIVERS_LICENSE 
PASSPORT 

Definition at line 3 of file IdType.cs.

◆ Result

Enumerator
SUCCESS 
FAIL 
INITIATED 
VOIDED 
VOIDING 
AUTH 
AUTH_COMPLETED 

Definition at line 24 of file Result.cs.

◆ ReversalReason

Enumerator
CHIP_DECLINE 
CARDHOLDER_CANCELLATION 
COMMUNICATION_ERROR 
OTHER_REASON 

Definition at line 3 of file ReversalReason.cs.

◆ SelectedService

Enumerator
NONE 
PAYMENT 
REFUND 
CANCELLATION 
PRE_AUTH 
UPDATE_PRE_AUTH 
PAYMENT_COMPLETION 
CASH_ADVANCE 
DEFERRED_PAYMENT 
DEFERRED_PAYMENT_COMPLETION 
VOICE_AUTHORISATION 
CARDHOLDER_DETECTION 

Definition at line 3 of file SelectedService.cs.

◆ TipMode

Enumerator
TIP_PROVIDED 
ON_SCREEN_BEFORE_PAYMENT 
ON_SCREEN_AFTER_PAYMENT 
ON_PAPER 
NO_TIP 

Definition at line 11 of file TipMode.cs.

◆ TransactionResult

Enumerator
APPROVED 
DECLINED 
ABORTED 
VOICE_AUTHORISATION 
PAYMENT_PART_ONLY 
PARTIALLY_APPROVED 
NONE 

Definition at line 3 of file TransactionResult.cs.

◆ TxFormat

Enumerator
DEFAULT 
NEXO 

Definition at line 3 of file TxFormat.cs.

◆ TxType

Enumerator
AUTH 
PREAUTH 
PREAUTHCAPTURE 
ADJUST 
VOID 
VOIDRETURN 
RETURN 
REFUND 
NAKEDREFUND 
GETBALANCE 
BATCHCLOSE 
ACTIVATE 
BALANCE_LOCK 
LOAD 
CASHOUT 
CASHOUT_ACTIVE_STATUS 
REDEMPTION 
REDEMPTION_UNLOCK 
RELOAD 

Definition at line 24 of file TxType.cs.

◆ Type

Enumerator
TAB 
AUTH 

Definition at line 24 of file Type.cs.

◆ VasDataTypeType

Enumerator
ALL 
LOYALTY 
OFFER 
GIFT_CARD 
PRIVATE_LABEL_CARD 
CUSTOMER 
VAS_DATA 

Definition at line 9 of file VasDataTypeType.cs.

◆ VasProtocol

Enumerator
ST 
PK 

Definition at line 9 of file VasProtocol.cs.