TSYSBenefit Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSBenefit class is an advanced tool used to authorize Electronic Benefits (EBT) cards in a Retail environment, where the customer is purchasing products or services in person. This class makes authorizing EBT Food Stamp and Cash Benefit transactions (with a customer PIN) very easy. Supported Industry Types include retail stores, restaurants, and grocery stores.

Syntax

TSYSBenefit

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSBenefit class makes authorizing EBT card transactions (where the customer's card is swiped through a card reader and a PIN is supplied) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

First, set the merchant properties with setup information acquired from your member bank or processor. For instance:

TSYSBenefit1.MerchantBankId = "999995" TSYSBenefit1.MerchantNumber = "888000002447" TSYSBenefit1.MerchantName = "TEST MERCHANT" TSYSBenefit1.MerchantTerminalNumber = "1515" TSYSBenefit1.MerchantStoreNumber = "5999" TSYSBenefit1.MerchantCategoryCode = "5999" TSYSBenefit1.MerchantCity = "Durham" TSYSBenefit1.MerchantState = "NC" TSYSBenefit1.MerchantZip = "27713" TSYSBenefit1.MerchantTimeZone = "705" TSYSBenefit1.MerchantABANumber = "123456789" TSYSBenefit1.MerchantSettlementAgent = "V123" TSYSBenefit1.MerchantFCSId = "1234567" TSYSBenefit1.AgentBankNumber = "000000" TSYSBenefit1.AgentChainNumber = "111111" TSYSBenefit1.SharingGroup = "8GWK" TSYSBenefit1.IndustryType = itRetail

Next, set properties that contain details about the transaction. The TransactionNumber is a sequence number, and should be incremented for each transaction you send. TransactionAmount is the amount of sale, formatted with an implicit decimal place. The CardMagneticStripe is read from the magnetic stripe on the back of the card, (Track 2 for EBT transactions) and the DebitPIN and DebitKSN are retrieved from a standard DUKPT Pin Pad device.

TSYSBenefit1.TransactionNumber = 1 TSYSBenefit1.TransactionAmount = "1000" TSYSBenefit1.CardMagneticStripe = "9999999800002773=09121015432112345678" TSYSBenefit1.CardPIN = "83C33384650827F6" TSYSBenefit1.CardKSN = "4A00310459400004"

The TSYSBenefit class supports both Food Stamp and Cash Benefit programs on the same card. Make sure to choose the correct TransactionType for the benefit program you wish to use, and then call the Authorize method. For example:

TSYSBenefit1.TransactionType = ttFoodStampPurchase TSYSBenefit1.Authorize()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved, and the remaining properties provide additional information about the transaction.

Once an EBT authorization is approved, the transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day. Note that ttFoodStampBalanceInquiry and ttCashBenefitBalanceInquiry TransactionTypes cannot be settled.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AgentBankNumber Property (TSYSBenefit Class)

Identifies a specific agent entity of the member bank or processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAgentBankNumber();
int SetAgentBankNumber(const char* lpszAgentBankNumber);

Unicode (Windows)
LPWSTR GetAgentBankNumber();
INT SetAgentBankNumber(LPCWSTR lpszAgentBankNumber);

char* dpaymentssdk_tsysbenefit_getagentbanknumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setagentbanknumber(void* lpObj, const char* lpszAgentBankNumber);

QString GetAgentBankNumber();
int SetAgentBankNumber(QString qsAgentBankNumber);

Default Value

"000000"

Remarks

This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.

Data Type

String

AgentChainNumber Property (TSYSBenefit Class)

Identifies a specific chain of an agent organization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAgentChainNumber();
int SetAgentChainNumber(const char* lpszAgentChainNumber);

Unicode (Windows)
LPWSTR GetAgentChainNumber();
INT SetAgentChainNumber(LPCWSTR lpszAgentChainNumber);

char* dpaymentssdk_tsysbenefit_getagentchainnumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setagentchainnumber(void* lpObj, const char* lpszAgentChainNumber);

QString GetAgentChainNumber();
int SetAgentChainNumber(QString qsAgentChainNumber);

Default Value

"000000"

Remarks

This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.

Data Type

String

BatchNumber Property (TSYSBenefit Class)

The batch number that this transaction will be included in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Unicode (Windows)
INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);

int dpaymentssdk_tsysbenefit_getbatchnumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setbatchnumber(void* lpObj, int iBatchNumber);

int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Default Value

1

Remarks

Unlike regular credit card transactions, Debit, EBT, and GiftCard transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSSettle class's BatchNumber property. The range is from 1 to 999.

Data Type

Integer

CardType Property (TSYSBenefit Class)

Type of credit card being used in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardType();
int SetCardType(int iCardType);

Unicode (Windows)
INT GetCardType();
INT SetCardType(INT iCardType);

CT_UNKNOWN(0), 
CT_VISA(1), 
CT_MASTER_CARD(2), 
CT_AMEX(3), 
CT_DISCOVER(4), 
CT_DINERS(5), 
CT_JCB(6), 
CT_VISA_ELECTRON(7), 
CT_MAESTRO(8), 
CT_LASER(10)

int dpaymentssdk_tsysbenefit_getcardtype(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardtype(void* lpObj, int iCardType);

int GetCardType();
int SetCardType(int iCardType);

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (TSYSBenefit Class)

Three digit security code on back of card (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardCVVData();
int SetCardCVVData(const char* lpszCardCVVData);

Unicode (Windows)
LPWSTR GetCardCVVData();
INT SetCardCVVData(LPCWSTR lpszCardCVVData);

char* dpaymentssdk_tsysbenefit_getcardcvvdata(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (TSYSBenefit Class)

Indicates the presence of the card verification value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Unicode (Windows)
INT GetCardCVVPresence();
INT SetCardCVVPresence(INT iCardCVVPresence);

CVP_NOT_PROVIDED(0), 
CVP_PROVIDED(1), 
CVP_ILLEGIBLE(2), 
CVP_NOT_ON_CARD(3)

int dpaymentssdk_tsysbenefit_getcardcvvpresence(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (TSYSBenefit Class)

This property contains a 1-character code identifying the source of the customer data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

Unicode (Windows)
INT GetCardEntryDataSource();
INT SetCardEntryDataSource(INT iCardEntryDataSource);

EDS_TRACK_1(0), 
EDS_TRACK_2(1), 
EDS_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
EDS_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
EDS_MANUAL_ENTRY_NO_CARD_READER(4), 
EDS_TRACK_1CONTACTLESS(5), 
EDS_TRACK_2CONTACTLESS(6), 
EDS_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
EDS_IVR(8), 
EDS_KIOSK(9)

int dpaymentssdk_tsysbenefit_getcardentrydatasource(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (TSYSBenefit Class)

Expiration month of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Unicode (Windows)
INT GetCardExpMonth();
INT SetCardExpMonth(INT iCardExpMonth);

int dpaymentssdk_tsysbenefit_getcardexpmonth(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardexpmonth(void* lpObj, int iCardExpMonth);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (TSYSBenefit Class)

Expiration year of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Unicode (Windows)
INT GetCardExpYear();
INT SetCardExpYear(INT iCardExpYear);

int dpaymentssdk_tsysbenefit_getcardexpyear(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardexpyear(void* lpObj, int iCardExpYear);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (TSYSBenefit Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardIsEncrypted();
int SetCardIsEncrypted(int bCardIsEncrypted);

Unicode (Windows)
BOOL GetCardIsEncrypted();
INT SetCardIsEncrypted(BOOL bCardIsEncrypted);

int dpaymentssdk_tsysbenefit_getcardisencrypted(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

Default Value

FALSE

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (TSYSBenefit Class)

Track data read off of the card's magnetic stripe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardMagneticStripe();
int SetCardMagneticStripe(const char* lpszCardMagneticStripe);

Unicode (Windows)
LPWSTR GetCardMagneticStripe();
INT SetCardMagneticStripe(LPCWSTR lpszCardMagneticStripe);

char* dpaymentssdk_tsysbenefit_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (TSYSBenefit Class)

Customer's credit card number for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardNumber();
int SetCardNumber(const char* lpszCardNumber);

Unicode (Windows)
LPWSTR GetCardNumber();
INT SetCardNumber(LPCWSTR lpszCardNumber);

char* dpaymentssdk_tsysbenefit_getcardnumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setcardnumber(void* lpObj, const char* lpszCardNumber);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

CashBackAmount Property (TSYSBenefit Class)

Amount returned to the customer in cash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackAmount();
int SetCashBackAmount(const char* lpszCashBackAmount);

Unicode (Windows)
LPWSTR GetCashBackAmount();
INT SetCashBackAmount(LPCWSTR lpszCashBackAmount);

char* dpaymentssdk_tsysbenefit_getcashbackamount(void* lpObj);
int dpaymentssdk_tsysbenefit_setcashbackamount(void* lpObj, const char* lpszCashBackAmount);

QString GetCashBackAmount();
int SetCashBackAmount(QString qsCashBackAmount);

Default Value

""

Remarks

This property may contain an optional cash back amount when authorizing a Debit Purchase transaction, EBT Cash Benefit Purchase, or a Gift Card Purchase transaction. The value of TransactionAmount must reflect the cost of the goods or service purchased plus this CashBackAmount.

Note: CashBackAmount must be empty for Restaurant IndustryType as this is not supported by TSYS.

Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Note: For EBT Withdrawal transactions, CashBackAmount must be empty. However, when creating detail records for the settlement of the transaction, the DebitCashBack in the detail record must match the TransactionAmount for the authorization.

Data Type

String

DebitKSN Property (TSYSBenefit Class)

Clear-text Key Sequence Number, used for Debit and EBT transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitKSN();
int SetDebitKSN(const char* lpszDebitKSN);

Unicode (Windows)
LPWSTR GetDebitKSN();
INT SetDebitKSN(LPCWSTR lpszDebitKSN);

char* dpaymentssdk_tsysbenefit_getdebitksn(void* lpObj);
int dpaymentssdk_tsysbenefit_setdebitksn(void* lpObj, const char* lpszDebitKSN);

QString GetDebitKSN();
int SetDebitKSN(QString qsDebitKSN);

Default Value

""

Remarks

The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. The maximum length is 16 characters.

Data Type

String

DebitPIN Property (TSYSBenefit Class)

DUKPT DES encrypted PIN block, used for Debit and EBT transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitPIN();
int SetDebitPIN(const char* lpszDebitPIN);

Unicode (Windows)
LPWSTR GetDebitPIN();
INT SetDebitPIN(LPCWSTR lpszDebitPIN);

char* dpaymentssdk_tsysbenefit_getdebitpin(void* lpObj);
int dpaymentssdk_tsysbenefit_setdebitpin(void* lpObj, const char* lpszDebitPIN);

QString GetDebitPIN();
int SetDebitPIN(QString qsDebitPIN);

Default Value

""

Remarks

The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. The maximum length is 16 characters.

Data Type

String

IndustryType Property (TSYSBenefit Class)

Code which indicates the industry the merchant is engaged in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

SIT_UNKNOWN(0), 
SIT_RETAIL(1), 
SIT_RESTAURANT(2), 
SIT_GROCERY_STORE(3), 
SIT_DIRECT_MARKETING(4), 
SIT_HOTEL(5), 
SIT_AUTO_RENTAL(6), 
SIT_PASSENGER_TRANSPORT(7)

int dpaymentssdk_tsysbenefit_getindustrytype(void* lpObj);
int dpaymentssdk_tsysbenefit_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Note: itDirectMarketing, itHotel, and itAutoRental are NOT supported for this class All Debit, EBT, and Gift Card transactions must be face-to-face card present transactions.

Data Type

Integer

MerchantBankId Property (TSYSBenefit Class)

The number which identifies the merchant's bank or processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantBankId();
int SetMerchantBankId(const char* lpszMerchantBankId);

Unicode (Windows)
LPWSTR GetMerchantBankId();
INT SetMerchantBankId(LPCWSTR lpszMerchantBankId);

char* dpaymentssdk_tsysbenefit_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);

QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId);

Default Value

""

Remarks

The number which identifies the merchant's bank or processor.

This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantCategoryCode Property (TSYSBenefit Class)

Classifies a merchant by the type of store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCategoryCode();
int SetMerchantCategoryCode(const char* lpszMerchantCategoryCode);

Unicode (Windows)
LPWSTR GetMerchantCategoryCode();
INT SetMerchantCategoryCode(LPCWSTR lpszMerchantCategoryCode);

char* dpaymentssdk_tsysbenefit_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);

QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode);

Default Value

""

Remarks

Classifies a merchant by the type of store.

This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).

Data Type

String

MerchantCity Property (TSYSBenefit Class)

Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCity();
int SetMerchantCity(const char* lpszMerchantCity);

Unicode (Windows)
LPWSTR GetMerchantCity();
INT SetMerchantCity(LPCWSTR lpszMerchantCity);

char* dpaymentssdk_tsysbenefit_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantcity(void* lpObj, const char* lpszMerchantCity);

QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity);

Default Value

""

Remarks

Merchant's City

For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the MerchantName and MerchantState must also be specified.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this property is ignored. MerchantServicePhone is used for those industries instead of MerchantCity (this does not apply to MasterCard).

Note: This property must contain the same data used in the batch settlement. The first character of this property may not be a space. This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.

Data Type

String

MerchantCountryCode Property (TSYSBenefit Class)

Identifies the country where the merchant is located.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCountryCode();
int SetMerchantCountryCode(const char* lpszMerchantCountryCode);

Unicode (Windows)
LPWSTR GetMerchantCountryCode();
INT SetMerchantCountryCode(LPCWSTR lpszMerchantCountryCode);

char* dpaymentssdk_tsysbenefit_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);

QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode);

Default Value

"840"

Remarks

Identifies the country where the merchant is located.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".

Data Type

String

MerchantCurrencyCode Property (TSYSBenefit Class)

Identifies the type of currency used by the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(const char* lpszMerchantCurrencyCode);

Unicode (Windows)
LPWSTR GetMerchantCurrencyCode();
INT SetMerchantCurrencyCode(LPCWSTR lpszMerchantCurrencyCode);

char* dpaymentssdk_tsysbenefit_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);

QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode);

Default Value

"840"

Remarks

Identifies the type of currency used by the merchant.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

Data Type

String

MerchantLanguage Property (TSYSBenefit Class)

Designates the language that response messages will be returned in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantLanguage();
int SetMerchantLanguage(const char* lpszMerchantLanguage);

Unicode (Windows)
LPWSTR GetMerchantLanguage();
INT SetMerchantLanguage(LPCWSTR lpszMerchantLanguage);

char* dpaymentssdk_tsysbenefit_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);

QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage);

Default Value

"00"

Remarks

Designates the language that response messages will be returned in.

This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.

Data Type

String

MerchantName Property (TSYSBenefit Class)

Name of the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantName();
int SetMerchantName(const char* lpszMerchantName);

Unicode (Windows)
LPWSTR GetMerchantName();
INT SetMerchantName(LPCWSTR lpszMerchantName);

char* dpaymentssdk_tsysbenefit_getmerchantname(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantname(void* lpObj, const char* lpszMerchantName);

QString GetMerchantName();
int SetMerchantName(QString qsMerchantName);

Default Value

""

Remarks

Name of the merchant.

This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.

This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.

This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.

Data Type

String

MerchantNumber Property (TSYSBenefit Class)

A unique number used to identify the merchant within the VisaNet system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber);

Unicode (Windows)
LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);

char* dpaymentssdk_tsysbenefit_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

Default Value

""

Remarks

A unique number used to identify the merchant within the VisaNet system.

This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantPhone Property (TSYSBenefit Class)

Merchant's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantPhone();
int SetMerchantPhone(const char* lpszMerchantPhone);

Unicode (Windows)
LPWSTR GetMerchantPhone();
INT SetMerchantPhone(LPCWSTR lpszMerchantPhone);

char* dpaymentssdk_tsysbenefit_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);

QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone);

Default Value

""

Remarks

Merchant's phone number.

This property contains the Merchant's business phone number. This can be the same as the customer service phone number.

Data Type

String

MerchantServicePhone Property (TSYSBenefit Class)

Merchant's customer service number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantServicePhone();
int SetMerchantServicePhone(const char* lpszMerchantServicePhone);

Unicode (Windows)
LPWSTR GetMerchantServicePhone();
INT SetMerchantServicePhone(LPCWSTR lpszMerchantServicePhone);

char* dpaymentssdk_tsysbenefit_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);

QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);

Default Value

""

Remarks

Merchant's customer service number.

This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

Data Type

String

MerchantState Property (TSYSBenefit Class)

State or province that the merchant is located in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantState();
int SetMerchantState(const char* lpszMerchantState);

Unicode (Windows)
LPWSTR GetMerchantState();
INT SetMerchantState(LPCWSTR lpszMerchantState);

char* dpaymentssdk_tsysbenefit_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantstate(void* lpObj, const char* lpszMerchantState);

QString GetMerchantState();
int SetMerchantState(QString qsMerchantState);

Default Value

""

Remarks

State or province that the merchant is located in.

This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.

This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.

Data Type

String

MerchantStoreNumber Property (TSYSBenefit Class)

Used to identify a specific merchant's store within the VisaNet system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantStoreNumber();
int SetMerchantStoreNumber(const char* lpszMerchantStoreNumber);

Unicode (Windows)
LPWSTR GetMerchantStoreNumber();
INT SetMerchantStoreNumber(LPCWSTR lpszMerchantStoreNumber);

char* dpaymentssdk_tsysbenefit_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);

QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber);

Default Value

""

Remarks

Used to identify a specific merchant's store within the VisaNet system.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.

Data Type

String

MerchantStreetAddress Property (TSYSBenefit Class)

Merchant's street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantStreetAddress();
int SetMerchantStreetAddress(const char* lpszMerchantStreetAddress);

Unicode (Windows)
LPWSTR GetMerchantStreetAddress();
INT SetMerchantStreetAddress(LPCWSTR lpszMerchantStreetAddress);

char* dpaymentssdk_tsysbenefit_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);

QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress);

Default Value

""

Remarks

Merchant's street address.

This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.

Data Type

String

MerchantTerminalNumber Property (TSYSBenefit Class)

Used to identify a unique terminal within a merchant location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber);

Unicode (Windows)
LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);

char* dpaymentssdk_tsysbenefit_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

Default Value

""

Remarks

Used to identify a unique terminal within a merchant location.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.

Data Type

String

MerchantTimeZone Property (TSYSBenefit Class)

Specifies the GMT offset used to calculate the local time within the VisaNet system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTimeZone();
int SetMerchantTimeZone(const char* lpszMerchantTimeZone);

Unicode (Windows)
LPWSTR GetMerchantTimeZone();
INT SetMerchantTimeZone(LPCWSTR lpszMerchantTimeZone);

char* dpaymentssdk_tsysbenefit_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);

QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone);

Default Value

"705"

Remarks

Specifies the GMT offset used to calculate the local time within the VisaNet system.

This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.

Byte #1:

If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.

Data Type

String

MerchantZip Property (TSYSBenefit Class)

Zip code where the merchant that initiated this transaction is located.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantZip();
int SetMerchantZip(const char* lpszMerchantZip);

Unicode (Windows)
LPWSTR GetMerchantZip();
INT SetMerchantZip(LPCWSTR lpszMerchantZip);

char* dpaymentssdk_tsysbenefit_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantzip(void* lpObj, const char* lpszMerchantZip);

QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);

Default Value

""

Remarks

Zip code where the merchant that initiated this transaction is located.

This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.

This property is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.

Data Type

String

MerchantABANumber Property (TSYSBenefit Class)

Merchant's routing number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantABANumber();
int SetMerchantABANumber(const char* lpszMerchantABANumber);

Unicode (Windows)
LPWSTR GetMerchantABANumber();
INT SetMerchantABANumber(LPCWSTR lpszMerchantABANumber);

char* dpaymentssdk_tsysbenefit_getmerchantabanumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantabanumber(void* lpObj, const char* lpszMerchantABANumber);

QString GetMerchantABANumber();
int SetMerchantABANumber(QString qsMerchantABANumber);

Default Value

""

Remarks

This property identifies the merchant to a direct debit switch, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 9 digits in length.

Data Type

String

MerchantFCSId Property (TSYSBenefit Class)

Identifies the merchant as an approved Food Stamp merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantFCSId();
int SetMerchantFCSId(const char* lpszMerchantFCSId);

Unicode (Windows)
LPWSTR GetMerchantFCSId();
INT SetMerchantFCSId(LPCWSTR lpszMerchantFCSId);

char* dpaymentssdk_tsysbenefit_getmerchantfcsid(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantfcsid(void* lpObj, const char* lpszMerchantFCSId);

QString GetMerchantFCSId();
int SetMerchantFCSId(QString qsMerchantFCSId);

Default Value

""

Remarks

This property contains the Food and Consumer Identifier, which identifies the merchant as being certified and approved to accept Food Stamps.

Data Type

String

MerchantSettlementAgent Property (TSYSBenefit Class)

Merchant's settling agent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantSettlementAgent();
int SetMerchantSettlementAgent(const char* lpszMerchantSettlementAgent);

Unicode (Windows)
LPWSTR GetMerchantSettlementAgent();
INT SetMerchantSettlementAgent(LPCWSTR lpszMerchantSettlementAgent);

char* dpaymentssdk_tsysbenefit_getmerchantsettlementagent(void* lpObj);
int dpaymentssdk_tsysbenefit_setmerchantsettlementagent(void* lpObj, const char* lpszMerchantSettlementAgent);

QString GetMerchantSettlementAgent();
int SetMerchantSettlementAgent(QString qsMerchantSettlementAgent);

Default Value

""

Remarks

This property identifies the merchant settling agent, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 4 digits in length.

Data Type

String

ResponseApprovalCode Property (TSYSBenefit Class)

Contains an authorization code when a transaction has been approved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* dpaymentssdk_tsysbenefit_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved.

This six character property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The ResponseApprovalCode must be stored and submitted in the settlement data capture record.

This property is read-only and not available at design time.

Data Type

String

ResponseAuthorizedAmount Property (TSYSBenefit Class)

Amount actually used from the card (used when supporting partial redemptions).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizedAmount();

Unicode (Windows)
LPWSTR GetResponseAuthorizedAmount();

char* dpaymentssdk_tsysbenefit_getresponseauthorizedamount(void* lpObj);

QString GetResponseAuthorizedAmount();

Default Value

""

Remarks

Amount actually used from the card (used when supporting partial redemptions).

The ResponseAuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then ResponseAuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.

For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the ResponseAuthorizedAmount will represent the approved amount of $7.50.In this case, the ResponseCode will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the ResponseAuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this property will be "0" or "".

If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.

This property is read-only.

Data Type

String

ResponseAuthSource Property (TSYSBenefit Class)

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthSource();

Unicode (Windows)
LPWSTR GetResponseAuthSource();

char* dpaymentssdk_tsysbenefit_getresponseauthsource(void* lpObj);

QString GetResponseAuthSource();

Default Value

""

Remarks

Indicates the source of the authorization code stored in ResponseApprovalCode.

This property contains a one character code indicating the source of the ResponseApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:

This property is read-only and not available at design time.

Data Type

String

ResponseAVSResult Property (TSYSBenefit Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* dpaymentssdk_tsysbenefit_getresponseavsresult(void* lpObj);

QString GetResponseAVSResult();

Default Value

""

Remarks

Contains the Address Verification System result code.

This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:

*AVS Result Code for International addresses only

This property is read-only and not available at design time.

Data Type

String

ResponseBalance Property (TSYSBenefit Class)

Available balance remaining on card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseBalance();

Unicode (Windows)
LPWSTR GetResponseBalance();

char* dpaymentssdk_tsysbenefit_getresponsebalance(void* lpObj);

QString GetResponseBalance();

Default Value

""

Remarks

Available balance remaining on card.

This property contains the Available Balance remaining on the card following the transaction that was just authorized. It represents the balance on the card prior to the transaction, minus the TransactionAmount from this transaction. For example, if a card has a $20.00 balance prior to a $15.00 ttGiftCardPurchase authorization, then the ResponseBalance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).

Note that this balance will be returned for all TransactionTypes, not just Balance Inquiries.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is read-only.

Data Type

String

ResponseCashBenefitAvailableBalance Property (TSYSBenefit Class)

The currently available balance on the cash benefit account (TSYS EIS 1080 account type 96, amount type 02).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCashBenefitAvailableBalance();

Unicode (Windows)
LPWSTR GetResponseCashBenefitAvailableBalance();

char* dpaymentssdk_tsysbenefit_getresponsecashbenefitavailablebalance(void* lpObj);

QString GetResponseCashBenefitAvailableBalance();

Default Value

""

Remarks

The currently available balance on the cash benefit account (TSYS EIS 1080 account type 96, amount type 02).

This read-only field is populated after a successful balance inquiry request (to send a balance inquiry set the TransactionType property to ettCashBenefitBalanceInquiry and call the Authorize method).

This property is read-only.

Data Type

String

ResponseCashBenefitLedgerBalance Property (TSYSBenefit Class)

The ledger balance on the cash benefit account (TSYS EIS 1080 account type 96, amount type 01).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCashBenefitLedgerBalance();

Unicode (Windows)
LPWSTR GetResponseCashBenefitLedgerBalance();

char* dpaymentssdk_tsysbenefit_getresponsecashbenefitledgerbalance(void* lpObj);

QString GetResponseCashBenefitLedgerBalance();

Default Value

""

Remarks

The ledger balance on the cash benefit account (TSYS EIS 1080 account type 96, amount type 01).

This read-only field is populated after a successful balance inquiry request (to send a balance inquiry set the TransactionType property to ettCashBenefitBalanceInquiry and call the Authorize method).

This property is read-only.

Data Type

String

ResponseCode Property (TSYSBenefit Class)

Indicates the status of the authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* dpaymentssdk_tsysbenefit_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

""

Remarks

Indicates the status of the authorization request.

This property contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

A list of valid result ResponseCodes are listed in the table of contents.

This property is read-only and not available at design time.

Data Type

String

ResponseCVVResult Property (TSYSBenefit Class)

Contains the returned CVV result code if it was requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVVResult();

Unicode (Windows)
LPWSTR GetResponseCVVResult();

char* dpaymentssdk_tsysbenefit_getresponsecvvresult(void* lpObj);

QString GetResponseCVVResult();

Default Value

""

Remarks

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an ResponseText indicating such. The following is a list of current result codes:

This property is read-only and not available at design time.

Data Type

String

ResponseFoodStampAvailableBalance Property (TSYSBenefit Class)

The currently available balance on the food stamps account (TSYS EIS 1080 account type 98, amount type 02).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseFoodStampAvailableBalance();

Unicode (Windows)
LPWSTR GetResponseFoodStampAvailableBalance();

char* dpaymentssdk_tsysbenefit_getresponsefoodstampavailablebalance(void* lpObj);

QString GetResponseFoodStampAvailableBalance();

Default Value

""

Remarks

The currently available balance on the food stamps account (TSYS EIS 1080 account type 98, amount type 02).

This read-only field is populated after a successful balance inquiry request (to send a balance inquiry set the TransactionType property to ettFoodStampBalanceInquiry and call the Authorize method).

This property is read-only.

Data Type

String

ResponseFoodStampLedgerBalance Property (TSYSBenefit Class)

The ledger balance on the food stamps account (TSYS EIS 1080 account type 98, amount type 01).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseFoodStampLedgerBalance();

Unicode (Windows)
LPWSTR GetResponseFoodStampLedgerBalance();

char* dpaymentssdk_tsysbenefit_getresponsefoodstampledgerbalance(void* lpObj);

QString GetResponseFoodStampLedgerBalance();

Default Value

""

Remarks

The ledger balance on the food stamps account (TSYS EIS 1080 account type 98, amount type 01).

This read-only field is populated after a successful balance inquiry request (to send a balance inquiry set the TransactionType property to ettFoodStampBalanceInquiry and call the Authorize method).

This property is read-only.

Data Type

String

ResponseHostMessageId Property (TSYSBenefit Class)

Unique host message identifier (Reserved for future use).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseHostMessageId();

Unicode (Windows)
LPWSTR GetResponseHostMessageId();

char* dpaymentssdk_tsysbenefit_getresponsehostmessageid(void* lpObj);

QString GetResponseHostMessageId();

Default Value

""

Remarks

Unique host message identifier (Reserved for future use).

This property will contain a unique host message identifier assigned by the authorizing system and returned in Debit, EBT, and Gift card response messages. This property is reserved for future use and will most likely contain spaces.

This property is read-only.

Data Type

String

ResponseNetworkId Property (TSYSBenefit Class)

Identification code of the network on which the transaction was authorized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseNetworkId();

Unicode (Windows)
LPWSTR GetResponseNetworkId();

char* dpaymentssdk_tsysbenefit_getresponsenetworkid(void* lpObj);

QString GetResponseNetworkId();

Default Value

""

Remarks

Identification code of the network on which the transaction was authorized.

This property indicates the network through which the transaction was authorized. If this property contains a "V" or a "5", this indicates the transaction was processed as a credit card purchase transaction even though it was originally submitted as a debit transaction. When these values ("V" or "5") are returned, the transaction must be settled as a credit card (non-debit) transaction.

The ResponseNetworkId must be printed on the customer's receipt.

The following values may be returned by the TSYS host:

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (TSYSBenefit Class)

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseRetrievalNumber();

Unicode (Windows)
LPWSTR GetResponseRetrievalNumber();

char* dpaymentssdk_tsysbenefit_getresponseretrievalnumber(void* lpObj);

QString GetResponseRetrievalNumber();

Default Value

""

Remarks

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.

This property is read-only and not available at design time.

Data Type

String

ResponseReturnedACI Property (TSYSBenefit Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseReturnedACI();

Unicode (Windows)
LPWSTR GetResponseReturnedACI();

char* dpaymentssdk_tsysbenefit_getresponsereturnedaci(void* lpObj);

QString GetResponseReturnedACI();

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character property contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the ResponseTransactionId or ResponseValidationCode properties.

This property is read-only and not available at design time.

Data Type

String

ResponseSettleDate Property (TSYSBenefit Class)

Date at which the Debit, EBT, or Gift Card transaction will settle.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseSettleDate();

Unicode (Windows)
LPWSTR GetResponseSettleDate();

char* dpaymentssdk_tsysbenefit_getresponsesettledate(void* lpObj);

QString GetResponseSettleDate();

Default Value

""

Remarks

Date at which the Debit, EBT, or Gift Card transaction will settle.

This property contains a four-character transaction settlement date as returned by the TSYS Acquiring Solutions authorization system. This date is in "MMDD" format, and indicates the date at which this transaction will settle. This date does not have to match the date you actually submit this transaction in a batch settlement.

This property is read-only.

Data Type

String

ResponseText Property (TSYSBenefit Class)

Text information that describes each response code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* dpaymentssdk_tsysbenefit_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

Text information that describes each response code.

This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.

The English-language response text messages are listed in the table of contents.

This property is read-only and not available at design time.

Data Type

String

ResponseTrace Property (TSYSBenefit Class)

System Trace Audit Number returned for Debit transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTrace();

Unicode (Windows)
LPWSTR GetResponseTrace();

char* dpaymentssdk_tsysbenefit_getresponsetrace(void* lpObj);

QString GetResponseTrace();

Default Value

""

Remarks

System Trace Audit Number returned for Debit transactions.

This property contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (TSYSBenefit Class)

Local transaction date returned from the server in MMddyy format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionDate();

Unicode (Windows)
LPWSTR GetResponseTransactionDate();

char* dpaymentssdk_tsysbenefit_getresponsetransactiondate(void* lpObj);

QString GetResponseTransactionDate();

Default Value

""

Remarks

Local transaction date returned from the server in MMddyy format.

This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionId Property (TSYSBenefit Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* dpaymentssdk_tsysbenefit_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and submitted in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionNumber Property (TSYSBenefit Class)

Check this property against the original Transaction Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionNumber();

Unicode (Windows)
LPWSTR GetResponseTransactionNumber();

char* dpaymentssdk_tsysbenefit_getresponsetransactionnumber(void* lpObj);

QString GetResponseTransactionNumber();

Default Value

""

Remarks

Check this property against the original Transaction Number.

This property should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionTime Property (TSYSBenefit Class)

Local transaction time returned from the server in HHmmss format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionTime();

Unicode (Windows)
LPWSTR GetResponseTransactionTime();

char* dpaymentssdk_tsysbenefit_getresponsetransactiontime(void* lpObj);

QString GetResponseTransactionTime();

Default Value

""

Remarks

Local transaction time returned from the server in HHmmss format.

This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseValidationCode Property (TSYSBenefit Class)

This optional property contains information generated by the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseValidationCode();

Unicode (Windows)
LPWSTR GetResponseValidationCode();

char* dpaymentssdk_tsysbenefit_getresponsevalidationcode(void* lpObj);

QString GetResponseValidationCode();

Default Value

""

Remarks

This optional property contains information generated by the card issuer.

This optional four character property contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

SharingGroup Property (TSYSBenefit Class)

List of Debit and EBT networks that the merchant supports.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSharingGroup();
int SetSharingGroup(const char* lpszSharingGroup);

Unicode (Windows)
LPWSTR GetSharingGroup();
INT SetSharingGroup(LPCWSTR lpszSharingGroup);

char* dpaymentssdk_tsysbenefit_getsharinggroup(void* lpObj);
int dpaymentssdk_tsysbenefit_setsharinggroup(void* lpObj, const char* lpszSharingGroup);

QString GetSharingGroup();
int SetSharingGroup(QString qsSharingGroup);

Default Value

""

Remarks

This one to 30-character property contains a listing of direct debit and EBT networks that a Point of Sale (POS) device can access. This property is provided by the signing member or processor, and the values must correspond to one of the Visa assigned direct debit network types. The following table shows the currently supported sharing groups:

The value of the SharingGroup property is constructed by concatenating these values together. For instance, a value of "GWQEV5" indicates support for Interlink, STAR Southeast, Star West, Accel, Visa, and Visa Check Card II. Of these, the actual network which was used to authorize this transaction will be indicated by the ResponseNetworkId property.

Data Type

String

SSLAcceptServerCertEncoded Property (TSYSBenefit Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_tsysbenefit_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysbenefit_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (TSYSBenefit Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_tsysbenefit_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysbenefit_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (TSYSBenefit Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_tsysbenefit_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysbenefit_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (TSYSBenefit Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_tsysbenefit_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysbenefit_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (TSYSBenefit Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_tsysbenefit_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysbenefit_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (TSYSBenefit Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_tsysbenefit_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysbenefit_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (TSYSBenefit Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_tsysbenefit_getsslprovider(void* lpObj);
int dpaymentssdk_tsysbenefit_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (TSYSBenefit Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dpaymentssdk_tsysbenefit_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (TSYSBenefit Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_tsysbenefit_gettimeout(void* lpObj);
int dpaymentssdk_tsysbenefit_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (TSYSBenefit Class)

Purchase amount to be authorized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount);

Unicode (Windows)
LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);

char* dpaymentssdk_tsysbenefit_gettransactionamount(void* lpObj);
int dpaymentssdk_tsysbenefit_settransactionamount(void* lpObj, const char* lpszTransactionAmount);

QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);

Default Value

""

Remarks

This field contains the transaction amount to be authorized.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (TSYSBenefit Class)

Sequence number of this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Unicode (Windows)
INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);

int dpaymentssdk_tsysbenefit_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsysbenefit_settransactionnumber(void* lpObj, int iTransactionNumber);

int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

0

Remarks

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

Data Type

Integer

TransactionType Property (TSYSBenefit Class)

Specifies the type of EBT transaction to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionType();
int SetTransactionType(int iTransactionType);

Unicode (Windows)
INT GetTransactionType();
INT SetTransactionType(INT iTransactionType);

ETT_FOOD_STAMP_PURCHASE(8), 
ETT_FOOD_STAMP_RETURN(9), 
ETT_FOOD_STAMP_VOUCHER(10), 
ETT_FOOD_STAMP_BALANCE_INQUIRY(11), 
ETT_CASH_BENEFIT_WITHDRAWAL(12), 
ETT_CASH_BENEFIT_PURCHASE(13), 
ETT_CASH_BENEFIT_BALANCE_INQUIRY(14)

int dpaymentssdk_tsysbenefit_gettransactiontype(void* lpObj);
int dpaymentssdk_tsysbenefit_settransactiontype(void* lpObj, int iTransactionType);

int GetTransactionType();
int SetTransactionType(int iTransactionType);

Default Value

8

Remarks

This property indicates the type of EBT transaction to send. The following table explains the transaction types in detail:

The DebitPIN and DebitKSN properties are required for all transaction types except ttFoodStampVoucher. For most transactions, the CardTrack2Data property should be set with the magnetic stripe data from the card. If the magnetic stripe cannot be read, set CardTrack2Data to "" and set the CardNumber, CardExpMonth, and CardExpYear properties to send a manually-keyed transaction.

Data Type

Integer

VoucherCode Property (TSYSBenefit Class)

Required for Food Stamp Voucher transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVoucherCode();
int SetVoucherCode(const char* lpszVoucherCode);

Unicode (Windows)
LPWSTR GetVoucherCode();
INT SetVoucherCode(LPCWSTR lpszVoucherCode);

char* dpaymentssdk_tsysbenefit_getvouchercode(void* lpObj);
int dpaymentssdk_tsysbenefit_setvouchercode(void* lpObj, const char* lpszVoucherCode);

QString GetVoucherCode();
int SetVoucherCode(QString qsVoucherCode);

Default Value

""

Remarks

This property is used when sending an EBT authorization request with the TransactionType set to ttFoodStampVoucher. This property should contain a 6-character Electronic Voucher Approval Code provided by the Electronic Benefits Transfer (EBT) voice authorization system.

Note: Voucher transactions are only sent because of a POS System or EBT Network unavailable condition.

Data Type

String

VoucherNumber Property (TSYSBenefit Class)

Required for Food Stamp Voucher transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVoucherNumber();
int SetVoucherNumber(const char* lpszVoucherNumber);

Unicode (Windows)
LPWSTR GetVoucherNumber();
INT SetVoucherNumber(LPCWSTR lpszVoucherNumber);

char* dpaymentssdk_tsysbenefit_getvouchernumber(void* lpObj);
int dpaymentssdk_tsysbenefit_setvouchernumber(void* lpObj, const char* lpszVoucherNumber);

QString GetVoucherNumber();
int SetVoucherNumber(QString qsVoucherNumber);

Default Value

""

Remarks

This property is used when sending an EBT authorization request with the TransactionType set to ttFoodStampVoucher. This property should contain a 15-character Electronic Voucher Serial Number provided by the Electronic Benefits Transfer (EBT) voice authorization system.

Note: Voucher transactions are only sent because of a POS System or EBT Network unavailable condition.

Data Type

String

Authorize Method (TSYSBenefit Class)

Sends a Gift Card transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int dpaymentssdk_tsysbenefit_authorize(void* lpObj);

int Authorize();

Remarks

This method sends an Electronic Benefits (EBT) authorization request to the Vital/TSYS host. The type of transaction sent is based upon the value of the TransactionType property. If the request was successful, the ResponseCode property will contain "00" or "85".

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (TSYSBenefit Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_tsysbenefit_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetDetailAggregate Method (TSYSBenefit Class)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDetailAggregate();

Unicode (Windows)
LPWSTR GetDetailAggregate();

char* dpaymentssdk_tsysbenefit_getdetailaggregate(void* lpObj);

QString GetDetailAggregate();

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

TSYSRetail.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (TSYSBenefit Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_tsysbenefit_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts any processing that the class is currently executing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (TSYSBenefit Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsysbenefit_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (TSYSBenefit Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(TSYSBenefitConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} TSYSBenefitConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(TSYSBenefitConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} TSYSBenefitConnectedEventParams;

#define EID_TSYSBENEFIT_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class TSYSBenefitConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(TSYSBenefitConnectedEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireConnected(TSYSBenefitConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DataPacketIn Event (TSYSBenefit Class)

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketIn(TSYSBenefitDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} TSYSBenefitDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(TSYSBenefitDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} TSYSBenefitDataPacketInEventParams;

#define EID_TSYSBENEFIT_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class TSYSBenefitDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(TSYSBenefitDataPacketInEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireDataPacketIn(TSYSBenefitDataPacketInEventParams *e) {...}

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (TSYSBenefit Class)

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketOut(TSYSBenefitDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} TSYSBenefitDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(TSYSBenefitDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} TSYSBenefitDataPacketOutEventParams;

#define EID_TSYSBENEFIT_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class TSYSBenefitDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(TSYSBenefitDataPacketOutEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireDataPacketOut(TSYSBenefitDataPacketOutEventParams *e) {...}

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (TSYSBenefit Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(TSYSBenefitDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} TSYSBenefitDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(TSYSBenefitDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} TSYSBenefitDisconnectedEventParams;

#define EID_TSYSBENEFIT_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class TSYSBenefitDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(TSYSBenefitDisconnectedEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireDisconnected(TSYSBenefitDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.

Please refer to the Error Codes section for more information.

Error Event (TSYSBenefit Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(TSYSBenefitErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TSYSBenefitErrorEventParams;


Unicode (Windows)
virtual INT FireError(TSYSBenefitErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TSYSBenefitErrorEventParams;

#define EID_TSYSBENEFIT_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TSYSBenefitErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TSYSBenefitErrorEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireError(TSYSBenefitErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (TSYSBenefit Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(TSYSBenefitSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} TSYSBenefitSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(TSYSBenefitSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} TSYSBenefitSSLServerAuthenticationEventParams;

#define EID_TSYSBENEFIT_SSLSERVERAUTHENTICATION 6

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class TSYSBenefitSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(TSYSBenefitSSLServerAuthenticationEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireSSLServerAuthentication(TSYSBenefitSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (TSYSBenefit Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(TSYSBenefitSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} TSYSBenefitSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(TSYSBenefitSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} TSYSBenefitSSLStatusEventParams;

#define EID_TSYSBENEFIT_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class TSYSBenefitSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(TSYSBenefitSSLStatusEventParams *e);

// Or, subclass TSYSBenefit and override this emitter function.
virtual int FireSSLStatus(TSYSBenefitSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (TSYSBenefit Class)

TSYSBenefit Config Settings

Base Config Settings

Trappable Errors (TSYSBenefit Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

TSYSBenefit Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors