CWS Wrapper Library
5.1.0
|
Root class for C# access to CWS's RESTful API. More...
Public Member Functions | |
CWS () | |
Creates an instance of CWS More... | |
void | Start (String logFile, int level) |
Start the CWSWrapper and initialize a log file and logging level More... | |
void | Stop () |
Undo start. More... | |
OpenPaymentGatewayResults | OpenPaymentGateway (OpenPaymentArgs opargs, NotifyCWSEvent ne) |
C# must perform an "open" before any transaction requests. The integrator will pass information so that Converge can identify the account. This "open" request will return a "paymentGatewayId" that must be passed to all subsequent transactions. More... | |
bool | StartExtraChargeCalculation (CalculateExtraChargeArgs pargs, NotifyCWSEvent ne, PaymentTransactionComplete pc) |
Kick off extra charge calculation process. More... | |
PaymentTransactionResults | CalculateExtraCharge (CalculateExtraChargeArgs pargs, NotifyCWSEvent ne) |
Calculate extra charge. More... | |
bool | StartPaymentTransaction (PaymentArgs pargs, NotifyCWSEvent ne, PaymentTransactionComplete pc) |
Kick off a payment transaction. More... | |
PaymentTransactionResults | PaymentTransaction (PaymentArgs pargs, NotifyCWSEvent ne) |
Start a payment transaction and wait until it completes. More... | |
bool | StartLinkedRefund (String paymentGatewayId, String origTransId, String tenderType, String cardType, Money amount, String note, NotifyCWSEvent ne, PaymentTransactionComplete bec) |
Start a linked refund More... | |
PaymentTransactionResults | LinkedRefund (String paymentGatewayId, String origTransId, String tenderType, String cardType, Money amount, String note, NotifyCWSEvent ne) |
Perform a linked refund and wait until complete More... | |
bool | StartTipAdjust (String paymentGatewayId, String origTransId, Money tipAmount, bool verifyTipAdjustByIssuer, NotifyCWSEvent ne, PaymentTransactionComplete bec) |
Start a tip adjust More... | |
PaymentTransactionResults | TipAdjust (String paymentGatewayId, String origTransId, Money tipAmount, bool verifyTipAdjustByIssuer, NotifyCWSEvent ne) |
Perform a tip adjust and wait until complete More... | |
bool | StartPrintPaymentReceipt (PrintPaymentArgs args, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Start printing a receipt. More... | |
PaymentTransactionResults | PrintPaymentReceipt (PrintPaymentArgs args, NotifyCWSEvent ne) |
Print a receipt and wait for it to complete More... | |
bool | StartEmailPaymentReceipt (EmailPaymentArgs args, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Email a receipt. More... | |
PaymentTransactionResults | EmailPaymentReceipt (EmailPaymentArgs args, NotifyCWSEvent ne) |
Email a receipt and wait until complete. More... | |
bool | StartFilePaymentReceipt (PrintPaymentArgs args, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Start a print receipt to file More... | |
PaymentTransactionResults | FilePaymentReceipt (PrintPaymentArgs args, NotifyCWSEvent ne) |
Print a receipt to file and wait More... | |
bool | StartHandleBinLookupResult (string paymentGatewayId, string chanId, HandleBinLookupResultInfo handleBinLookupResultInfo, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Handle a bin lookup result and continue a payment transaction with relevant information More... | |
PaymentTransactionResults | HandleBinLookupResult (string paymentGatewayId, string chanId, HandleBinLookupResultInfo handleBinLookupResultInfo, NotifyCWSEvent ne) |
Handle a bin lookup result and continue a payment transaction with relevant information and wait More... | |
bool | StartContinuePaymentTransaction (string paymentGatewayId, string chanId, Dictionary< string, string > requiredInfo, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Continue a payment transaction with required information More... | |
PaymentTransactionResults | ContinuePaymentTransaction (string paymentGatewayId, string chanId, Dictionary< string, string > requiredInfo, NotifyCWSEvent ne) |
Continue a payment transaction and wait More... | |
bool | StartCancelPaymentTransaction (string paymentGatewayId, string chanId, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Cancel a payment transaction without waiting. More... | |
PaymentTransactionResults | CancelPaymentTransaction (string paymentGatewayId, string chanId, NotifyCWSEvent ne) |
Cancel a payment transcation and wait More... | |
bool | StartTransactionSearch (TransactionSearchArgs ts_args, NotifyCWSEvent ne, TransactionSearchComplete tsc) |
Search for transactions based on passed in search criteria More... | |
TransactionSearchResults | TransactionSearch (TransactionSearchArgs ts_args, NotifyCWSEvent ne) |
Search for transaction and wait until complete More... | |
bool | StartValidateAccount (String paymentGatewayId, NotifyCWSEvent ne, PaymentTransactionComplete ptc) |
Start a validate account More... | |
PaymentTransactionResults | ValidateAccount (String paymentGatewayId, NotifyCWSEvent ne) |
Validate account and wait until complete More... | |
Properties | |
string | URL [get, set] |
Get/Set URL of CWS More... | |
int | DelayMillis [get, set] |
Get/Set delay between polls to CWS More... | |
int | MaxWaitMillis [get, set] |
Get/Set maximun transaction time, in milliseconds More... | |
Root class for C# access to CWS's RESTful API.
|
inline |
Creates an instance of CWS
|
inline |
Calculate extra charge.
pargs | An object that specifies the required and optional parameters |
ne | A delegate to receive informational messages |
|
inline |
Cancel a payment transcation and wait
paymentGatewayId | PaymentGatewayId returned from OpenPaymentGateway |
chanId | ChanId returned from StartPaymentTransaction |
ne | Delegate to handle notify events |
|
inline |
Continue a payment transaction and wait
paymentGatewayId | PaymentGatewayId returned from OpenPaymentGateway |
chanId | ChanId returned from StartPaymentTransaction |
requiredInfo | Dictionary of names/values of required information |
ne | Delegate to receive notify events |
|
inline |
Email a receipt and wait until complete.
args | EmailPaymentArgs |
ne | Delegate to receive notify events |
|
inline |
Print a receipt to file and wait
args | PrintPaymentArgs |
ne | Delegate to receive notify events |
|
inline |
Handle a bin lookup result and continue a payment transaction with relevant information and wait
paymentGatewayId | PaymentGatewayId returned from OpenPaymentGateway |
chanId | ChanId returned from StartPaymentTransaction |
handleBinLookupResultInfo | Information for continuing the transaction |
ne | Delegate to receive notify events |
|
inline |
Perform a linked refund and wait until complete
paymentGatewayId | Id returned from openPaymentGateway |
origTransId | The transaction id for the transaction you wish to refund |
tenderType | Type of tender |
cardType | Card Type |
amount | Amount to be refunded |
note | Optional note |
ne | Notificaion callback |
|
inline |
C# must perform an "open" before any transaction requests. The integrator will pass information so that Converge can identify the account.
This "open" request will return a "paymentGatewayId" that must be passed to all subsequent transactions.
opargs | Object contains your credentials and other information |
ne | A delegate to receive informational callbacks |
|
inline |
Start a payment transaction and wait until it completes.
pargs | An object that specifies the required and optional parameters |
ne | >A delegate to receive informational messages |
|
inline |
Print a receipt and wait for it to complete
CWS can print the receipt for the most recent transaction or a transaction by transactionId.
If PrintPaymentArgs.transactionId is null, the most recent transaction will be printed.
args | PrintPaymentArgs contaimn optional arguments |
ne | Notification callback |
|
inline |
Start the CWSWrapper and initialize a log file and logging level
logFile | Full path to log file |
level | Level of logging 0: none, 4 maximum |
|
inline |
Cancel a payment transaction without waiting.
paymentGatewayId | PaymentGatewayId returned from OpenPaymentGateway |
chanId | ChanId returned from StartPaymentTransaction |
ne | Delegate to handle notify events |
ptc | Delegate to be called when cancel is complete |
|
inline |
Continue a payment transaction with required information
paymentGatewayId | PaymentGatewayId returned from OpenPaymentGateway |
chanId | ChanId returned from StartPaymentTransaction |
requiredInfo | Dictionary of names/values of required information |
ne | Delegate to receive notify events |
ptc | Delegate to be called when transaction completes |
|
inline |
|
inline |
Kick off extra charge calculation process.
pargs | An object that specifies the required and optional parameters |
ne | A delegate to receive informational messages |
pc | A delegate to be called when the transaction is complete |
|
inline |
Start a print receipt to file
args | PrintPaymentArgs |
ne | Delegate to receive notify events |
ptc | Delegate to be called when complete |
|
inline |
Handle a bin lookup result and continue a payment transaction with relevant information
paymentGatewayId | PaymentGatewayId returned from OpenPaymentGateway |
chanId | ChanId returned from StartPaymentTransaction |
handleBinLookupResultInfo | Information for continuing the transaction |
ne | Delegate to receive notify events |
ptc | Delegate to be called when transaction completes |
|
inline |
Start a linked refund
paymentGatewayId | Id retunred from openPaymentGateway |
origTransId | The transaction id for the transaction you want to refund |
tenderType | Type of tender |
cardType | The card type |
amount | Amount to be refunded |
note | Optional note |
ne | Notifiction callback |
bec | Delegate to be called when complete |
|
inline |
Kick off a payment transaction.
pargs | An object that specifies the required and optional parameters |
ne | A delegate to receive informational messages |
pc | A delegate to be called when the transaction is complete |
|
inline |
Start printing a receipt.
CWS can print the receipt for the most recent transaction or a transaction by transactionId.
If PrintPaymentArgs.transactionId is null, the most recent transaction will be printed.
args | PrintPaymentArgs contain optional arguments |
ne | Notification callback method |
ptc | Delegate to be called when printing is complete |
|
inline |
Start a tip adjust
paymentGatewayId | Id returned from openPaymentGateway |
origTransId | The transaction id for the transaction you want to tip adjust |
tipAmount | Tip amount to be applied to the transaction |
verifyTipAdjustByIssuer | Flag indicating if the transaction should be authorized by issuer |
ne | Notifiction callback |
bec | Delegate to be called when complete |
|
inline |
Search for transactions based on passed in search criteria
ts_args | The search criteria |
ne | Notify callback |
tsc | Delegate to be called when the search is complete |
|
inline |
Start a validate account
paymentGatewayId | PaymentGatewayId |
ne | Delegate to be called for notify events |
ptc | Delegate to be called when complete |
|
inline |
Undo start.
|
inline |
Perform a tip adjust and wait until complete
paymentGatewayId | Id returned from openPaymentGateway |
origTransId | The transaction id for the transaction you want to tip adjust |
tipAmount | Tip amount to be applied to the transaction |
verifyTipAdjustByIssuer | Flag indicating if the transaction should be authorized by issuer |
ne | Notificaion callback |
|
inline |
Search for transaction and wait until complete
ts_args | The search criteria |
ne | Notify callback |
|
inline |
Validate account and wait until complete
paymentGatewayId | PaymentGatewayId |
ne | Delegate to be called for notify events |
|
getset |
Get/Set delay between polls to CWS
|
getset |
Get/Set maximun transaction time, in milliseconds
|
getset |
Get/Set URL of CWS