CWS Wrapper Library  5.1.0
Classes | Enumerations | Functions
CWSWrapper Namespace Reference

Classes

class  AccountInfo
 Account information More...
 
class  AmountConfirmationData
 Results returned after terminal prompts customer to confirm amount. More...
 
class  AmountConfResults
 Result of the amount confirmation of a transaction. More...
 
class  ApiInfoResults
 Result object returned from requesting API info, such as version number, preferred card reader, etc. More...
 
class  AResults
 Base class for the results in the response from CWS WebService More...
 
class  BinLookupResult
 Contains information about a bin lookup for a payment card. More...
 
class  CalculateExtraChargeArgs
 Object which contains all extra charge calculation attributes. It is passed to CWS.CalculateExtraCharge More...
 
class  CardData
 Contains information retrieved from a customer's card by the card reader. More...
 
class  CardEntryType
 How the credit card can be obtained More...
 
class  CardReadArgs
 Holds information needed to perform a card read on the card reader.
More...
 
class  CardReaderConfigArgs
 Contains information needed to setup and configure a connection to a card reader. More...
 
class  CardReaderConnection
 A connection to an available card reader. More...
 
class  CardReaderInfo
 Contains information about the connected card reader. More...
 
class  CardReaderInfoResults
 Result object returned after requesting info about the connected card reader. More...
 
class  CardType
 You can restrict what kind of card the customer uses More...
 
class  ConConInfo
 Contains information about the current version of Converge Connect (ConCon). More...
 
class  ConnectionMethod
 The way readers can connect More...
 
class  ConnectionType
 The type of connection to make. More...
 
class  CountryCode
 The available country codes More...
 
class  CWS
 Root class for C# access to CWS's RESTful API. More...
 
class  CWSEvent
 Notification events emitted by CWS More...
 
class  CWSInfo
 Contains information on CWS, including communicating port, version, etc. More...
 
class  DebitNetworkChoice
 The available choices for debit network preference More...
 
class  DeviceConfigArgs
 Contains information needed to perform a device search. More...
 
class  DeviceConnectionCriteria
 Device connection criteria for a device search. More...
 
class  DeviceProviderType
 The name of the device provider More...
 
class  DeviceStatusData
 Contains information on the status of the card reader. More...
 
class  DeviceStatusResults
 Result object returned after requesting the status of the connected device. More...
 
class  DeviceType
 The type of device to search for. More...
 
class  EmailPaymentArgs
 Arguments to Email a receipt More...
 
class  EmvApplication
 EMV Application that the user might be asked to choose from a list, in case selection is not supported on the card reader. More...
 
class  EmvResponseData
 Contains information about an EMV transaction reponse. More...
 
class  EnvironmentInfoResults
 Result object returned after requesting information about the environment, such as version info on CWS, ConvergeConnect, and Commerce SDK. More...
 
class  GratuityAmount
 Gratuity More...
 
class  HandleBinLookupResultInfo
 Object which contains information for handling a bin lookup result. More...
 
class  HealthcareAmount
 Object which contains healthcare related amounts. More...
 
class  InetAddress
 Contains information used to make TCP/IP connections. More...
 
class  LanguageCode
 The available languages More...
 
class  LanguageInformation
 Contains the language and country codes for the terminal. More...
 
class  LogLevel
 Log Level More...
 
class  Money
 Representation of monetary amounts with a currency code (ECLCurrencyCode - ISO 4217) and a value in minor units.

  • $10.95 USD would be specified as a minor units value of 1095 and a currency code of USD.
  • $0.10 USD would be specified as a minor units value of 10 and a currency code of USD.
More...
 
class  OpenPaymentArgs
 Holds information needed to communicate with the payment gateway. More...
 
class  OpenPaymentData
 Results for a OpenPaymentGateway More...
 
class  OpenPaymentGatewayResults
 Results object returned from OpenPaymentGateway More...
 
class  Outcome
 Result object returned after completing a transaction. More...
 
class  OverrideCvmOptions
 Contains information used to override the signature option. More...
 
class  OverrideCvmOptionsResults
 Result object returned after requesting to override cvm options. More...
 
class  OverrideDebitNetworkPreferences
 Contains information used to override debit network preferences for specific card brands. More...
 
class  OverrideDebitNetworkPreferencesResults
 Result object returned after requesting the debit network preferrences to override. More...
 
class  OverrideDefaultTerminalLanguage
 Contains information used to override the language on a card reader. More...
 
class  OverrideLanguageResults
 Result object returned after requesting to override a default terminal language. More...
 
class  PaymentArgs
 Object which contains all payment transaction options. It is passed to CWS.StartPaymentTransaction More...
 
class  PaymentTransactionData
 Results returned from a payment transaction More...
 
class  PaymentTransactionResults
 Result object returned from a payment transaction. More...
 
class  PinData
 Contains the encrypted pin data retrieved from the card reader. More...
 
class  PinEntryResults
 Result object returned from requesting the customer's PIN. More...
 
class  PrintControl
 Special characters that can be inserted into receipts you print. More...
 
class  PrinterData
 Contains information about a connected printer. More...
 
class  PrinterInfo
 Contains information about a connected printer. More...
 
class  PrinterInfoResults
 Request object returned after requesting info from a connected printer. More...
 
class  PrinterSearchResults
 Result object returned after searching for any connected printers. More...
 
class  PrintPaymentArgs
 Object to hold print payment parameters More...
 
class  PrintReceiptResults
 Result object returned after printing a receipt from a connected printer. More...
 
class  ProxyInfo
 Contains informtion and credentials to communicate through a secure proxy. More...
 
class  QuickSelection
 QuickSelection - object to hold three gratuity amounts for use with gratuity flow. These gratuity amounts are expressed in a Dictionary<String,String> with the following required three keys More...
 
class  ReaderSearchResults
 Result object returned after searching for any connected card readers. More...
 
class  RebootResults
 Result object returned after requesting the device to reboot. More...
 
class  ResetResults
 Result object returned after requesting that the device perform a reset. More...
 
class  RuntimeInfo
 Contains runtime information for CWS. More...
 
class  SetPrefsResults
 Result object returned after setting the preferences of the terminal. More...
 
class  SetTerminalCardholderInputModeConfigurationResults
 Result object returned after requesting to set terminal cardholder input mode. More...
 
class  SetTerminalDeviceConfigurationResults
 Result object returned after requesting to set terminal device (i.e. device type, CAT level, etc) configuration. More...
 
class  SigCaptureResults
 Result object returned after capturing the customer's signature. More...
 
class  signatureBitmap
 Contains the data for the signature bitmap obtained from the card reader or other mechanism. More...
 
class  SignatureData
 Holds information on the signature data retrieved from the customer. More...
 
class  SignatureOption
 The available choices for signature option More...
 
class  TenderType
 Constants to specify the tender type. More...
 
class  TerminalCardholderInputModeConfiguration
 Contains information on terminal cardholder input mode. More...
 
class  TerminalConfiguration
 Contains information on the configuration of the card reader. More...
 
class  TerminalDeviceConfiguration
 Contains information on terminal device configuration (i.e. device type, CAT level, etc.) More...
 
class  Time
 Representation of time in hour (0-23) and minute (0-59) More...
 
class  TLVArgs
 Contains information on the payment gateway and the TLV data values to use. More...
 
class  Transaction
 Details of a transaction - either part of PaymentTransactionData (returned from PaymentTransaction) or returned from a transction search More...
 
class  TransactionData
 Contains information about the transaction performed on the card reader. More...
 
class  TransactionSearchArgs
 Transaction search criteria More...
 
class  TransactionSearchData
 Results for a transaction search More...
 
class  TransactionSearchResults
 Results returned from a transaction search More...
 
class  TransactionType
 Constants used to specify transaction types More...
 
class  TransArgs
 Arguments used to initiate a transaction on card reader. More...
 
class  TransResults
 Result object returned after performing a transaction. More...
 
class  UpdateKeysResults
 Result object returned after updating the keys in the device. More...
 
class  VersionInfo
 Contains version information about CWS or another library being used. More...
 
class  VersionInfoResults
 Result object after requesting version information on CWS, ConvergeConnect, and Commerce SDK. More...
 

Enumerations

enum  AccountType { AccountType.UNSET, AccountType.UNKNOWN, AccountType.CHECKING, AccountType.SAVINGS }
 Account Type More...
 
enum  CatLevelIndicator {
  CatLevelIndicator.UNSET, CatLevelIndicator.UNKNOWN, CatLevelIndicator.TRANSACTION_NOT_APPLICABLE, CatLevelIndicator.AUTOMATED_DISPENSING_MACHINE,
  CatLevelIndicator.SELF_SERVICE_TERMINAL, CatLevelIndicator.LIMITED_AMOUNT_TERMINAL, CatLevelIndicator.IN_FLIGHT_TERMINAL, CatLevelIndicator.TRANSPONDER,
  CatLevelIndicator.MPOS
}
 CAT (Cardholder Activated Terminal) Level Indicator More...
 
enum  CurrencyCode {
  CurrencyCode.USD, CurrencyCode.CAD, CurrencyCode.EUR, CurrencyCode.GBP,
  CurrencyCode.PLN, CurrencyCode.UNKNOWN
}
 
enum  EncryptionScheme { EncryptionScheme.NONE, EncryptionScheme.TLS_12 }
 Encryption scheme for IP-based communication to card reader. More...
 
enum  ExtraChargeType {
  ExtraChargeType.UNKNOWN, ExtraChargeType.CREDIT_SURCHARGE, ExtraChargeType.SERVICE_FEE, ExtraChargeType.SERVICE_FEE_P,
  ExtraChargeType.SERVICE_FEE_A
}
 Extra charge lookup type More...
 
enum  PaymentAndAccountType { PaymentAndAccountType.CREDIT, PaymentAndAccountType.DEBIT_CHECKING, PaymentAndAccountType.DEBIT_SAVINGS }
 Payment And Account Type More...
 
enum  PaymentType {
  PaymentType.UNSET, PaymentType.UNKNOWN, PaymentType.DEBIT, PaymentType.CREDIT,
  PaymentType.EBT_CASH, PaymentType.EBT_FOOD_STAMP, PaymentType.STORE_CHARGE, PaymentType.LOYALTY,
  PaymentType.PAYPAL
}
 Payment Type More...
 
enum  ServiceFeeType { ServiceFeeType.FIXED_AMOUNT, ServiceFeeType.PERCENTAGE, ServiceFeeType.UNKNOWN }
 
enum  TerminalCardholderInputMode { TerminalCardholderInputMode.UNSET, TerminalCardholderInputMode.UNKNOWN, TerminalCardholderInputMode.IN_POS, TerminalCardholderInputMode.CARD_READER }
 Terminal Cardholder Input Mode More...
 
enum  TerminalDeviceType {
  TerminalDeviceType.UNSET, TerminalDeviceType.UNKNOWN, TerminalDeviceType.ATTENDED_TERMINAL, TerminalDeviceType.LIMITED_AMOUNT_TERMINAL,
  TerminalDeviceType.UNATTENDED_TERMINAL_ATM, TerminalDeviceType.UNATTENDED_TERMINAL_CAT, TerminalDeviceType.NO_TERMINAL, TerminalDeviceType.MPOS,
  TerminalDeviceType.UNRECOGNIZED
}
 Terminal Device Type More...
 

Functions

delegate void OverrideDebitNetworkPreferencesComplete (OverrideDebitNetworkPreferencesResults odr)
 Delegate to be called asynchronously when setting the debit network preferences call completes. More...
 
delegate void PaymentTransactionComplete (PaymentTransactionResults results)
 Delegate to be called asynchronously when a payment transaction completes. More...
 
delegate void OpenPaymentGatewayComplete (OpenPaymentGatewayResults results)
 Delegate to be called asynchronously after an OpenPaymentGateway completes. More...
 
delegate void TransactionSearchComplete (TransactionSearchResults results)
 Delegate to be called asynchronously when a transaction search completes. More...
 
delegate void OverrideCvmOptionsComplete (OverrideCvmOptionsResults ocor)
 Delegate to be called asynchronously when the override cvm options call completes. More...
 
delegate void NotifyCWSEvent (CWSEvent cwsevent)
 Delegate to be called asynchronously as events arrive. More...
 

Enumeration Type Documentation

◆ AccountType

Account Type

Enumerator
UNSET 

UNSET

UNKNOWN 

UNKNOWN

CHECKING 

Checking

SAVINGS 

Savings

◆ CatLevelIndicator

CAT (Cardholder Activated Terminal) Level Indicator

Enumerator
UNSET 

UNSET

UNKNOWN 

UNKNOWN

TRANSACTION_NOT_APPLICABLE 

Transaction Not Applicable (00)

AUTOMATED_DISPENSING_MACHINE 

Automated Dispensing Machine (01)

SELF_SERVICE_TERMINAL 

Self Service Terminal (02)

LIMITED_AMOUNT_TERMINAL 

Limited Amount Terminal (03)

IN_FLIGHT_TERMINAL 

In-Flight Terminal (04)

TRANSPONDER 

Transponder (07)

MPOS 

MPOS (09)

◆ CurrencyCode

Enumerator
USD 

USA

CAD 

Canada

EUR 

Euro

GBP 

Pound

PLN 

Poland

UNKNOWN 

Unknown

◆ EncryptionScheme

Encryption scheme for IP-based communication to card reader.

Enumerator
NONE 

IP-based communication to card reader is not encrypted.

TLS_12 

IP-based communication to card reader is encrypted.

◆ ExtraChargeType

Extra charge lookup type

Enumerator
UNKNOWN 

Extra charge type is undefine.

CREDIT_SURCHARGE 

Extra charge is surcharge.

SERVICE_FEE 

Extra charge is generic service fee.

SERVICE_FEE_P 

Extra charge is service fee percentage.

SERVICE_FEE_A 

Extra charge is service fee flat amount.

◆ PaymentAndAccountType

Payment And Account Type

Enumerator
CREDIT 

Payment type of Credit

DEBIT_CHECKING 

Payment type of Debit with account type of checking

DEBIT_SAVINGS 

Payment type of Debit with account type of savings

◆ PaymentType

Payment Type

Enumerator
UNSET 

UNSET

UNKNOWN 

UNKNOWN

DEBIT 

Debit

CREDIT 

Credit

EBT_CASH 

EBT - Cash

EBT_FOOD_STAMP 

EBT - Food Stamp

STORE_CHARGE 

Store Charge

LOYALTY 

Loyalty

PAYPAL 

Paypal

◆ ServiceFeeType

Enumerator
FIXED_AMOUNT 

Fixed amount based.

PERCENTAGE 

Percentage based, proportional to transaction amount.

UNKNOWN 

Unknown, usually due to failure to get server settings from Converge server.

◆ TerminalCardholderInputMode

Terminal Cardholder Input Mode

Enumerator
UNSET 

UNSET

UNKNOWN 

UNKNOWN

IN_POS 

In-POS

CARD_READER 

Card Reader

◆ TerminalDeviceType

Terminal Device Type

Enumerator
UNSET 

UNSET

UNKNOWN 

UNKNOWN

ATTENDED_TERMINAL 

Attended Terminal (00)

LIMITED_AMOUNT_TERMINAL 

Limited Amount Terminal (01)

UNATTENDED_TERMINAL_ATM 

Unattended Terminal - ATM (02)

UNATTENDED_TERMINAL_CAT 

Unattended Terminal - CAT (03)

NO_TERMINAL 

No Terminal (04)

MPOS 

MPOS (05)

UNRECOGNIZED 

UNRECOGNIZED (09)

Function Documentation

◆ NotifyCWSEvent()

delegate void CWSWrapper.NotifyCWSEvent ( CWSEvent  cwsevent)

Delegate to be called asynchronously as events arrive.

Parameters
cwseventThe event

◆ OpenPaymentGatewayComplete()

delegate void CWSWrapper.OpenPaymentGatewayComplete ( OpenPaymentGatewayResults  results)

Delegate to be called asynchronously after an OpenPaymentGateway completes.

Parameters
resultsOpenPaymentGatewayResuls

◆ OverrideCvmOptionsComplete()

delegate void CWSWrapper.OverrideCvmOptionsComplete ( OverrideCvmOptionsResults  ocor)

Delegate to be called asynchronously when the override cvm options call completes.

Parameters
ocorOverrideCvmOptionsResults

◆ OverrideDebitNetworkPreferencesComplete()

delegate void CWSWrapper.OverrideDebitNetworkPreferencesComplete ( OverrideDebitNetworkPreferencesResults  odr)

Delegate to be called asynchronously when setting the debit network preferences call completes.

Parameters
odrOverrideDebitNetworkPreferencesResults

◆ PaymentTransactionComplete()

delegate void CWSWrapper.PaymentTransactionComplete ( PaymentTransactionResults  results)

Delegate to be called asynchronously when a payment transaction completes.

Parameters
resultsPaymentTransactionResults

◆ TransactionSearchComplete()

delegate void CWSWrapper.TransactionSearchComplete ( TransactionSearchResults  results)

Delegate to be called asynchronously when a transaction search completes.

Parameters
resultsTransactionSearchResults