TSYSBenefit Control

Properties   Methods   Events   Config Settings   Errors  

The TSYSBenefit control 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 control 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 control 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 control, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSBenefit control 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 control 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 control 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 control 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 control. 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 control with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

AgentBankNumber Property (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.AgentBankNumber[=string]

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 Control)

Identifies a specific chain of an agent organization.

Syntax

tsysbenefitcontrol.AgentChainNumber[=string]

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 Control)

The batch number that this transaction will be included in.

Syntax

tsysbenefitcontrol.BatchNumber[=integer]

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 control's BatchNumber property. The range is from 1 to 999.

Data Type

Integer

CardType Property (TSYSBenefit Control)

Type of credit card being used in this transaction.

Syntax

tsysbenefitcontrol.CardType[=integer]

Possible Values

ctUnknown(0), 
ctVisa(1), 
ctMasterCard(2), 
ctAMEX(3), 
ctDiscover(4), 
ctDiners(5), 
ctJCB(6), 
ctVisaElectron(7), 
ctMaestro(8), 
ctLaser(10)

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 Control)

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

Syntax

tsysbenefitcontrol.CardCVVData[=string]

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 Control)

Indicates the presence of the card verification value.

Syntax

tsysbenefitcontrol.CardCVVPresence[=integer]

Possible Values

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

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The control 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 Control)

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

Syntax

tsysbenefitcontrol.CardEntryDataSource[=integer]

Possible Values

edsTrack1(0), 
edsTrack2(1), 
edsManualEntryTrack1Capable(2), 
edsManualEntryTrack2Capable(3), 
edsManualEntryNoCardReader(4), 
edsTrack1Contactless(5), 
edsTrack2Contactless(6), 
edsManualEntryContactlessCapable(7), 
edsIVR(8), 
edsKiosk(9)

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 Control)

Expiration month of the credit card specified in Number .

Syntax

tsysbenefitcontrol.CardExpMonth[=integer]

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 Control)

Expiration year of the credit card specified in Number .

Syntax

tsysbenefitcontrol.CardExpYear[=integer]

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 Control)

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

Syntax

tsysbenefitcontrol.CardIsEncrypted[=boolean]

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 Control)

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

Syntax

tsysbenefitcontrol.CardMagneticStripe[=string]

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?"

control.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" control.CardEntryDataSource = edsTrack1 or control.CardMagneticStripe = "4788250000028291=05121015432112345678" control.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 Control)

Customer's credit card number for the transaction.

Syntax

tsysbenefitcontrol.CardNumber[=string]

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 Control)

Amount returned to the customer in cash.

Syntax

tsysbenefitcontrol.CashBackAmount[=string]

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 Control)

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

Syntax

tsysbenefitcontrol.DebitKSN[=string]

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 Control)

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

Syntax

tsysbenefitcontrol.DebitPIN[=string]

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 Control)

Code which indicates the industry the merchant is engaged in.

Syntax

tsysbenefitcontrol.IndustryType[=integer]

Possible Values

sitUnknown(0), 
sitRetail(1), 
sitRestaurant(2), 
sitGroceryStore(3), 
sitDirectMarketing(4), 
sitHotel(5), 
sitAutoRental(6), 
sitPassengerTransport(7)

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 control.

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

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

Data Type

Integer

MerchantBankId Property (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.MerchantBankId[=string]

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 Control)

Classifies a merchant by the type of store.

Syntax

tsysbenefitcontrol.MerchantCategoryCode[=string]

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 Control)

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

Syntax

tsysbenefitcontrol.MerchantCity[=string]

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 Control)

Identifies the country where the merchant is located.

Syntax

tsysbenefitcontrol.MerchantCountryCode[=string]

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 Control)

Identifies the type of currency used by the merchant.

Syntax

tsysbenefitcontrol.MerchantCurrencyCode[=string]

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 Control)

Designates the language that response messages will be returned in.

Syntax

tsysbenefitcontrol.MerchantLanguage[=string]

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 Control)

Name of the merchant.

Syntax

tsysbenefitcontrol.MerchantName[=string]

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 Control)

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

Syntax

tsysbenefitcontrol.MerchantNumber[=string]

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 Control)

Merchant's phone number.

Syntax

tsysbenefitcontrol.MerchantPhone[=string]

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 Control)

Merchant's customer service number.

Syntax

tsysbenefitcontrol.MerchantServicePhone[=string]

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 Control)

State or province that the merchant is located in.

Syntax

tsysbenefitcontrol.MerchantState[=string]

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 Control)

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

Syntax

tsysbenefitcontrol.MerchantStoreNumber[=string]

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 Control)

Merchant's street address.

Syntax

tsysbenefitcontrol.MerchantStreetAddress[=string]

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 Control)

Used to identify a unique terminal within a merchant location.

Syntax

tsysbenefitcontrol.MerchantTerminalNumber[=string]

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 Control)

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

Syntax

tsysbenefitcontrol.MerchantTimeZone[=string]

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:

Bytes #2-3:

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 Control)

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

Syntax

tsysbenefitcontrol.MerchantZip[=string]

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 Control)

Merchant's routing number.

Syntax

tsysbenefitcontrol.MerchantABANumber[=string]

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 Control)

Identifies the merchant as an approved Food Stamp merchant.

Syntax

tsysbenefitcontrol.MerchantFCSId[=string]

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 Control)

Merchant's settling agent.

Syntax

tsysbenefitcontrol.MerchantSettlementAgent[=string]

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 Control)

Contains an authorization code when a transaction has been approved.

Syntax

tsysbenefitcontrol.ResponseApprovalCode

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseAuthorizedAmount

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 Control)

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

tsysbenefitcontrol.ResponseAuthSource

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:

* Currently in use by Japan Acquirer Services (JAS).

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

Data Type

String

ResponseAVSResult Property (TSYSBenefit Control)

Contains the Address Verification System result code.

Syntax

tsysbenefitcontrol.ResponseAVSResult

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 Control)

Available balance remaining on card.

Syntax

tsysbenefitcontrol.ResponseBalance

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseCashBenefitAvailableBalance

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseCashBenefitLedgerBalance

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 Control)

Indicates the status of the authorization request.

Syntax

tsysbenefitcontrol.ResponseCode

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 Control)

Contains the returned CVV result code if it was requested.

Syntax

tsysbenefitcontrol.ResponseCVVResult

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseFoodStampAvailableBalance

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseFoodStampLedgerBalance

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 Control)

Unique host message identifier (Reserved for future use).

Syntax

tsysbenefitcontrol.ResponseHostMessageId

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseNetworkId

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 valid for Debit card and EBT card transactions only. It will be ignored for all other TransactionTypes.

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.ResponseRetrievalNumber

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 Control)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

tsysbenefitcontrol.ResponseReturnedACI

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 Control)

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

Syntax

tsysbenefitcontrol.ResponseSettleDate

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 Control)

Text information that describes each response code.

Syntax

tsysbenefitcontrol.ResponseText

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 Control)

System Trace Audit Number returned for Debit transactions.

Syntax

tsysbenefitcontrol.ResponseTrace

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 Control)

Local transaction date returned from the server in MMddyy format.

Syntax

tsysbenefitcontrol.ResponseTransactionDate

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 Control)

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

tsysbenefitcontrol.ResponseTransactionId

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 Control)

Check this property against the original Transaction Number.

Syntax

tsysbenefitcontrol.ResponseTransactionNumber

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 Control)

Local transaction time returned from the server in HHmmss format.

Syntax

tsysbenefitcontrol.ResponseTransactionTime

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 Control)

This optional property contains information generated by the card issuer.

Syntax

tsysbenefitcontrol.ResponseValidationCode

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 Control)

List of Debit and EBT networks that the merchant supports.

Syntax

tsysbenefitcontrol.SharingGroup[=string]

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 Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsysbenefitcontrol.SSLAcceptServerCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (TSYSBenefit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsysbenefitcontrol.SSLCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.SSLCertStore[=string]

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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.SSLCertStorePassword[=string]

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 Control)

This is the type of certificate store for this certificate.

Syntax

tsysbenefitcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.SSLCertSubject[=string]

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 Control)

This specifies the SSL/TLS implementation to use.

Syntax

tsysbenefitcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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:

Additional Notes

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (TSYSBenefit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsysbenefitcontrol.SSLServerCertEncoded

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

Timeout Property (TSYSBenefit Control)

A timeout for the control.

Syntax

tsysbenefitcontrol.Timeout[=integer]

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (TSYSBenefit Control)

Purchase amount to be authorized.

Syntax

tsysbenefitcontrol.TransactionAmount[=string]

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 Control)

Sequence number of this transaction.

Syntax

tsysbenefitcontrol.TransactionNumber[=integer]

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 Control)

Specifies the type of EBT transaction to process.

Syntax

tsysbenefitcontrol.TransactionType[=integer]

Possible Values

ettFoodStampPurchase(8), 
ettFoodStampReturn(9), 
ettFoodStampVoucher(10), 
ettFoodStampBalanceInquiry(11), 
ettCashBenefitWithdrawal(12), 
ettCashBenefitPurchase(13), 
ettCashBenefitBalanceInquiry(14)

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 Control)

Required for Food Stamp Voucher transactions.

Syntax

tsysbenefitcontrol.VoucherCode[=string]

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 Control)

Required for Food Stamp Voucher transactions.

Syntax

tsysbenefitcontrol.VoucherNumber[=string]

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 Control)

Sends a Gift Card transaction.

Syntax

tsysbenefitcontrol.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".

Config Method (TSYSBenefit Control)

Sets or retrieves a configuration setting.

Syntax

tsysbenefitcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

GetDetailAggregate Method (TSYSBenefit Control)

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

Syntax

tsysbenefitcontrol.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 control'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 control 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()

Interrupt Method (TSYSBenefit Control)

Interrupts the current action.

Syntax

tsysbenefitcontrol.Interrupt 

Remarks

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

Reset Method (TSYSBenefit Control)

Clears all properties to their default values.

Syntax

tsysbenefitcontrol.Reset 

Remarks

This method clears all properties to their default values.

Connected Event (TSYSBenefit Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub tsysbenefitcontrol_Connected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

DataPacketIn Event (TSYSBenefit Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub tsysbenefitcontrol_DataPacketIn(DataPacket As String)

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 control.

DataPacketOut Event (TSYSBenefit Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub tsysbenefitcontrol_DataPacketOut(DataPacket As String)

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 control.

Disconnected Event (TSYSBenefit Control)

Fired when a connection is closed.

Syntax

Sub tsysbenefitcontrol_Disconnected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (TSYSBenefit Control)

Information about errors during data delivery.

Syntax

Sub tsysbenefitcontrol_Error(ErrorCode As Integer, Description As String)

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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub tsysbenefitcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 Control)

Fired when secure connection progress messages are available.

Syntax

Sub tsysbenefitcontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (TSYSBenefit Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

TSYSBenefit Config Settings

Base Config Settings

Trappable Errors (TSYSBenefit Control)

TSYSBenefit Errors

	20502    Data field invalid length.
	20503    Data field invalid format.
	20504    Data field out of range.
	20505    Luhn digit check failed.
	20506    Card date invalid.
	20507    Card expired.
	20508    Card type unknown.
	20510    No gateway specified.
	20512    Invalid data entered.
	20513    Truncated response.
	20514    Invalid response.
	20518    Response length mismatch.
	20519    LRC check failed.
	20520    Corrupt response.
	20521    Response packet empty.
	20522    Response truncated.
	20523    Host disconnected.
	20524    No response from host.
	20525    Server error response.
	20527    Invalid timeout value.
	20528    Vital/TSYS returned an error response.
	20536    Signature verification failed.
	20545    Error building packet.
	20594    Missing or erroneous property value. Cannot send transaction.
	20595    Response received before transmission completed.
	20596    Prematurely disconnected (check MerchantNumber and MerchantBankId).
	20597    Pending responses max number exceeded (Interleaved).
	20598    Pending response timeout (Interleaved).

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

TCPClient Errors

	20101    You cannot change the RemotePort at this time. A connection is in progress.
	20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103    The RemoteHost address is invalid (0.0.0.0).
	20105    Already connected. If you want to reconnect, close the current connection first.
	20107    You cannot change the LocalPort at this time. A connection is in progress.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20113    You cannot change MaxLineLength at this time. A connection is in progress.
	20117    RemotePort cannot be zero. Please specify a valid service port number.
	20118    You cannot change the UseConnection option while the control is active.
	20136    Operation would block.
	20202    Timeout.
	20212    Action impossible in control's present state.
	20213    Action impossible while not connected.
	20214    Action impossible while listening.
	20302    Timeout.
	20303    Could not open file.
	20435    Unable to convert string to selected CodePage.
	21106    Already connecting. If you want to reconnect, close the current connection first.
	21118    You need to connect first.
	21120    You cannot change the LocalHost at this time. A connection is in progress.
	21121    Connection dropped by remote host.

SSL Errors

	20271    Cannot load specified security library.
	20272    Cannot open certificate store.
	20273    Cannot find specified certificate.
	20274    Cannot acquire security credentials.
	20275    Cannot find certificate chain.
	20276    Cannot verify certificate chain.
	20277    Error during handshake.
	20281    Error verifying certificate.
	20282    Could not find client certificate.
	20283    Could not find server certificate.
	20284    Error encrypting data.
	20285    Error decrypting data.

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).