CWS Wrapper Library  5.1.0
Public Attributes | Properties | List of all members
CWSWrapper.PaymentArgs Class Reference

Object which contains all payment transaction options. It is passed to CWS.StartPaymentTransaction More...

Public Attributes

string[] cardEntryTypes
 CardEntryType More...
 

Properties

string paymentGatewayId [get, set]
 Id returned from OpenPaymentGateway More...
 
string transactionType [get, set]
 The type of transaction. TransactionType More...
 
string tenderType [get, set]
 The type of tender. TenderType More...
 
Money baseTransactionAmount [get, set]
 Amount of sale before tax, tip and discount. More...
 
Money tenderedAmount [get, set]
 Amount tenderered. Required only for CASH transactions. More...
 
Money[] taxAmounts [get, set]
 How much tax to add to base amount More...
 
Money ivuMunicipalTax [get, set]
 IVU Lotto Municipal Tax More...
 
Money ivuStateTax [get, set]
 IVU Lotto State Tax More...
 
Money gratuityAmount [get, set]
 How much tip to add to base amount. More...
 
Money[] discountAmounts [get, set]
 An array of discounts. More...
 
bool forceTransaction [get, set]
 Request Voice Referral More...
 
bool generateToken [get, set]
 Generate a token that can be used on subsequent transactions. More...
 
bool addToken [get, set]
 Store Token. More...
 
string tokenizedCardNumber [get, set]
 Token as returned from a transaction with generateToken=true More...
 
string tokenExpirationDate [get, set]
 Expiration date for the generated tokenized card number, Format MMYY More...
 
string originalTransId [get, set]
 Used with void, linked refund etc More...
 
AvsFields avsFields [get, set]
 A Dictionary of AVS field names and values. Valid names are CARDHOLDER_ADDRESS and CARDHOLDER_ZIP More...
 
string cardType [get, set]
 CardType More...
 
string note [get, set]
 Textual data to be associated with this transaction More...
 
string merchantTransactionReference [get, set]
 Reference to be associated with this transaction, it may be use to search transaction More...
 
string invoiceNumber [get, set]
 An invoice number to be associated with this transaction More...
 
bool isTaxInclusive [get, set]
 You can optionally set if specified tax amount is already included in transaction amount. More...
 
bool verifyTipAdjustByIssuer [get, set]
 You can optionally specify if tip adjust transaction should be reauthorized by issuer, only valid when transaction type is Tip Adjust More...
 
bool skipAmountOnCardEntryPrompt [get, set]
 You can request amount should be skipped on card entry prompt More...
 
bool partialApprovalAllowed [get, set]
 You can request a partial approval for the transaction More...
 
bool gratuityFlowEnabled [get, set]
 You can have the customer enter the tip amount on the reader. More...
 
bool gratuityCustomAmountEntryAllowed [get, set]
 If you have gratuitfyFlowEnabled you can have the reader allow the customer to enter any amount for tip. More...
 
QuickSelection gratuityQuickSelections [get, set]
 The reader will display default tip amounts unless you specify your own. More...
 
string signatureOption [get, set]
 The signature option to use for the transaction. More...
 
string octRefNumber [get, set]
 The unique oct reference number to use for the money transfer oct transaction. More...
 
string laneNumber [get, set]
 The lane number to use for this transaction. Should be an 8-digit number. More...
 
string oarData [get, set]
 The original authorization response data to use for the TOKEN transaction. More...
 
string ps2000Data [get, set]
 The ps2000 data to use for the TOKEN transaction. More...
 
HealthcareAmount healthcareAmount [get, set]
 The healthcare amount which contains amount related to healthcare transactions. More...
 

Detailed Description

Object which contains all payment transaction options. It is passed to CWS.StartPaymentTransaction

Member Data Documentation

◆ cardEntryTypes

string [] CWSWrapper.PaymentArgs.cardEntryTypes

CardEntryType

Optional - default all card entry types

Card entry mode: Swiped, Contactless, Manually Enter, or EMV.

Property Documentation

◆ addToken

bool CWSWrapper.PaymentArgs.addToken
getset

Store Token.

Optional - default false

Stores generated token in Card Manager server.

◆ avsFields

AvsFields CWSWrapper.PaymentArgs.avsFields
getset

A Dictionary of AVS field names and values. Valid names are CARDHOLDER_ADDRESS and CARDHOLDER_ZIP

◆ baseTransactionAmount

Money CWSWrapper.PaymentArgs.baseTransactionAmount
getset

Amount of sale before tax, tip and discount.

Required

The monetary value of this transaction.

◆ cardType

string CWSWrapper.PaymentArgs.cardType
getset

CardType

Optional - default all card types

Card Type Enumeration.

◆ discountAmounts

Money [] CWSWrapper.PaymentArgs.discountAmounts
getset

An array of discounts.

Optional - default 0

◆ forceTransaction

bool CWSWrapper.PaymentArgs.forceTransaction
getset

Request Voice Referral

Optional - default false

Ability to process a transaction utilizing the voice authorization number provided by the creditor.

◆ generateToken

bool CWSWrapper.PaymentArgs.generateToken
getset

Generate a token that can be used on subsequent transactions.

Optional - default false

Generates a token based on passed card data for later use.

◆ gratuityAmount

Money CWSWrapper.PaymentArgs.gratuityAmount
getset

How much tip to add to base amount.

Optional - default 0

Pre-determined gratuity amount (i.e. if the gratuity amount has already been entered into the POS prior to the start of the transaction, OR, if used as part of a callback request for a gratuity amount.

◆ gratuityCustomAmountEntryAllowed

bool CWSWrapper.PaymentArgs.gratuityCustomAmountEntryAllowed
getset

If you have gratuitfyFlowEnabled you can have the reader allow the customer to enter any amount for tip.

Optional - default false

◆ gratuityFlowEnabled

bool CWSWrapper.PaymentArgs.gratuityFlowEnabled
getset

You can have the customer enter the tip amount on the reader.

Optional - default false

◆ gratuityQuickSelections

QuickSelection CWSWrapper.PaymentArgs.gratuityQuickSelections
getset

The reader will display default tip amounts unless you specify your own.

Optional - default null

◆ healthcareAmount

HealthcareAmount CWSWrapper.PaymentArgs.healthcareAmount
getset

The healthcare amount which contains amount related to healthcare transactions.

◆ invoiceNumber

string CWSWrapper.PaymentArgs.invoiceNumber
getset

An invoice number to be associated with this transaction

Optional - default null

◆ isTaxInclusive

bool CWSWrapper.PaymentArgs.isTaxInclusive
getset

You can optionally set if specified tax amount is already included in transaction amount.

Optional - default false

◆ ivuMunicipalTax

Money CWSWrapper.PaymentArgs.ivuMunicipalTax
getset

IVU Lotto Municipal Tax

Optional - default null

The money for IVU Lotto Municipal tax.

◆ ivuStateTax

Money CWSWrapper.PaymentArgs.ivuStateTax
getset

IVU Lotto State Tax

Optional - default null

The money for IVU Lotto State tax.

◆ laneNumber

string CWSWrapper.PaymentArgs.laneNumber
getset

The lane number to use for this transaction. Should be an 8-digit number.

◆ merchantTransactionReference

string CWSWrapper.PaymentArgs.merchantTransactionReference
getset

Reference to be associated with this transaction, it may be use to search transaction

Optional - default null

◆ note

string CWSWrapper.PaymentArgs.note
getset

Textual data to be associated with this transaction

Optional - default null

◆ oarData

string CWSWrapper.PaymentArgs.oarData
getset

The original authorization response data to use for the TOKEN transaction.

◆ octRefNumber

string CWSWrapper.PaymentArgs.octRefNumber
getset

The unique oct reference number to use for the money transfer oct transaction.

◆ originalTransId

string CWSWrapper.PaymentArgs.originalTransId
getset

Used with void, linked refund etc

Optional - default null

◆ partialApprovalAllowed

bool CWSWrapper.PaymentArgs.partialApprovalAllowed
getset

You can request a partial approval for the transaction

Optional - default false

◆ paymentGatewayId

string CWSWrapper.PaymentArgs.paymentGatewayId
getset

Id returned from OpenPaymentGateway

Required

◆ ps2000Data

string CWSWrapper.PaymentArgs.ps2000Data
getset

The ps2000 data to use for the TOKEN transaction.

◆ signatureOption

string CWSWrapper.PaymentArgs.signatureOption
getset

The signature option to use for the transaction.

◆ skipAmountOnCardEntryPrompt

bool CWSWrapper.PaymentArgs.skipAmountOnCardEntryPrompt
getset

You can request amount should be skipped on card entry prompt

Optional - default false

◆ taxAmounts

Money [] CWSWrapper.PaymentArgs.taxAmounts
getset

How much tax to add to base amount

Optional

Sales tax amount applied to this transaction.

◆ tenderedAmount

Money CWSWrapper.PaymentArgs.tenderedAmount
getset

Amount tenderered. Required only for CASH transactions.

Optional - default 0

The a sum of money given in payment.

◆ tenderType

string CWSWrapper.PaymentArgs.tenderType
getset

The type of tender. TenderType

Required


Tender Type Enumeration - CASH or CARD.

◆ tokenExpirationDate

string CWSWrapper.PaymentArgs.tokenExpirationDate
getset

Expiration date for the generated tokenized card number, Format MMYY

Optional - default null

The expiration date (MMYY) for the tokenized card number.

◆ tokenizedCardNumber

string CWSWrapper.PaymentArgs.tokenizedCardNumber
getset

Token as returned from a transaction with generateToken=true

Optional - default null

The token number used as a substitute for a card number.

◆ transactionType

string CWSWrapper.PaymentArgs.transactionType
getset

The type of transaction. TransactionType

Required

Transaction Type Enumeration.

◆ verifyTipAdjustByIssuer

bool CWSWrapper.PaymentArgs.verifyTipAdjustByIssuer
getset

You can optionally specify if tip adjust transaction should be reauthorized by issuer, only valid when transaction type is Tip Adjust

Optional - default false


The documentation for this class was generated from the following file: