TSYSHealthCare Control

Properties   Methods   Events   Config Settings   Errors  

The TSYSHEALTHCARE control is designed to be a simple interface for those wishing to add Healthcare Auto- Substantiation (IIAS) support without redesigning their entire payment system. This control is used to authorize FSA cards in a Retail environment, where the customer is purchasing products or services in person. Both full and partial authorizations are supported.

Syntax

TSYSHealthCare

Remarks

This control allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This control can be integrated into web pages or stand-alone Point Of Sale applications. 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 TSYSHealthCare control has the ability to authorize transactions for the Retail, Direct Marketing (including E-Commerce), and Grocery Store IndustryTypes. However, at this time TSYS is only allowing IIAS Auto-Substantiation transactions in the Retail environment.

The TSYSHealthCare control makes authorizing IIAS transactions 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 very similar to that of the TSYSRetail control. The basic steps are outlined below:

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

control.Merchant.BankId = "999995"; //(BIN number) control.Merchant.CategoryCode = "5999"; control.Merchant.Name = "test merchant"; control.Merchant.Number = "123456789012"; control.Merchant.City = "Beverly Hills"; control.Merchant.State = "CA"; control.Merchant.StoreNumber = "5999"; control.Merchant.TerminalNumber = "1515"; control.Merchant.Zip = "90210"; control.IndustryType = itRetail;

Now, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing track1, and for these cards you may use track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with track1 data.

control.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?"; control.Card.EntryDataSource = edsTrack1;

Next set the TransactionAmount, TotalMedicalAmount, and optionally any additional healthcare-related amounts. Up to three additional amounts may be included, but their sums cannot exceed the TotalMedicalAmount. The available amounts include: ClinicAmount, DentalAmount, PrescriptionAmount, and VisionAmount.

control.TransactionAmount = "10000"; // $100.00 control.TotalMedicalAmount = "10000"; // this cannot exceed the TransactionAmount control.PrescriptionAmount = "5000"; // $50.00

There are several additional properties in the TSYSHealthCare control that are specific to healthcare transactions. The PartialAuthorization property indicates whether you allow partial authorizations. If TotalMedicalAmount is less than the TransactionAmount, the transaction will likely be declined as FSA cards are to be used solely for medical expenses. Likewise, if the FSA card does not have enough of a balance to cover the total amount, the card may be declined. However, if you set PartialAuthorization to True the host may authorize the transaction for a lesser amount. In this case the ResponseCode will be "10" instead of "00", and the ResponseAuthorizedAmount will contain the amount that was actually authorized (this amount may or may not be equal to the TotalMedicalAmount). Note: if the cardholder does not have additional funds to cover the remainder of the TransactionAmount and wishes to cancel the transaction, you must use the TSYSReversal control to reverse the authorization and instantly release funds back to the cardholder.

The Visa Merchant Verification Value, or VisaMVV is needed for Visa transactions in order to qualify for the best interchange rate.

Finally, the Substantiated property is a MasterCard-specific property that indicates if the transaction has been substantiated in real-time. Meaning, it tells the host whether the merchant verified the purchased items against an Inventory Information Approval System (IIAS).

After all of these properties are set, simply call the Authorize method to authorize the transaction. 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 ResponseAVSResult indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the 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.

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.

CardType Property (TSYSHealthCare Control)

Type of credit card being used in this transaction.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Indicates the presence of the card verification value.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Expiration month of the credit card specified in Number .

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Expiration year of the credit card specified in Number .

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Customer's credit card number for the transaction.

Syntax

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

CardPresent Property (TSYSHealthCare Control)

Indicates whether the current transaction is a card present transaction.

Syntax

tsyshealthcarecontrol.CardPresent[=boolean]

Default Value

True

Remarks

By default, this control handles only retail card-present transactions. However, there are times at which a retail merchant may need to make a card-not-present transaction. For instance, hotel reservations, pre-orders, and the like. By setting this property to False a merchant may submit a card-not-present transaction. However, merchants that deal primarily in card-not-present transactions (either over the Internet or over the telephone) should use the TSYSECommerce control instead.

Data Type

Boolean

ClinicAmount Property (TSYSHealthCare Control)

Total amount of Clinic or Other qualified medical items for Healthcare auto-substantiation.

Syntax

tsyshealthcarecontrol.ClinicAmount[=string]

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

CustomerAddress Property (TSYSHealthCare Control)

The customer's billing address.

Syntax

tsyshealthcarecontrol.CustomerAddress[=string]

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.

Per TSYS specs, the following rules apply:

• In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
• There must be a (space) between two consecutive data elements that are only numeric.

Note the following examples:

• "1234 56th Street" is equivalent to: "1234 56Street"
• "1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
• "1391 ELM STREET" is equivalent to: "1391ELMSTREET"
• "P.O. BOX 24356" is equivalent to: "POBOX24356"

The length of this property is 19 characters, and any string longer than this fails with an error. If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

Data Type

String

CustomerZip Property (TSYSHealthCare Control)

Customer's zip code (or postal code if outside of the USA).

Syntax

tsyshealthcarecontrol.CustomerZip[=string]

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

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

Data Type

String

DentalAmount Property (TSYSHealthCare Control)

Total amount of Dental items for Healthcare auto-substantiation.

Syntax

tsyshealthcarecontrol.DentalAmount[=string]

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

IndustryType Property (TSYSHealthCare Control)

Code which indicates the industry the merchant is engaged in.

Syntax

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

Data Type

Integer

MerchantBankId Property (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Classifies a merchant by the type of store.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Identifies the country where the merchant is located.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Identifies the type of currency used by the merchant.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Designates the language that response messages will be returned in.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Name of the merchant.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Merchant's phone number.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Merchant's customer service number.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

State or province that the merchant is located in.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Merchant's street address.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Used to identify a unique terminal within a merchant location.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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:

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

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

Syntax

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

PartialAuthorization Property (TSYSHealthCare Control)

Indicates whether partial authorizations are to be supported for Health Care Auto-Substantiation transactions.

Syntax

tsyshealthcarecontrol.PartialAuthorization[=boolean]

Default Value

False

Remarks

If the TotalMedicalAmount is not the same as the TransactionAmount the FSA card may be declined, as FSA cards may only be used for healthcare-related purchases. However, if you set PartialAuthorization to true, the transaction may be authorized for the TotalMedicalAmount. The customer must then make up the difference between the TransactionAmount and TotalMedicalAmount via some other form of payment (cash, credit, check, etc).

The total amount authorized by TSYS will be returned in the ResponseAuthorizedAmount. For instance, if the TransactionAmount is $50, but the TotalMedicalAmount is $42, the card is charged for $42.00 and the ResponseAuthorizedAmount will be "42.00". The merchant may then collect the remaining $8 in cash, check, credit card, or any other acceptable form of payment.

Data Type

Boolean

PrescriptionAmount Property (TSYSHealthCare Control)

Total amount of Prescription/Rx items for Healthcare auto-substantiation.

Syntax

tsyshealthcarecontrol.PrescriptionAmount[=string]

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

ResponseApprovalCode Property (TSYSHealthCare Control)

Contains an authorization code when a transaction has been approved.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

tsyshealthcarecontrol.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:

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

Data Type

String

ResponseAVSResult Property (TSYSHealthCare Control)

Contains the Address Verification System result code.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Available balance remaining on card.

Syntax

tsyshealthcarecontrol.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 an FSA card has a $20.00 balance prior to a $15.00 authorization, then the ResponseBalance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).

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

ResponseCode Property (TSYSHealthCare Control)

Indicates the status of the authorization request.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Contains the returned CVV result code if it was requested.

Syntax

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

ResponseRetrievalNumber Property (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

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

ResponseText Property (TSYSHealthCare Control)

Text information that describes each response code.

Syntax

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

ResponseTransactionDate Property (TSYSHealthCare Control)

Local transaction date returned from the server in MMddyy format.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Check this property against the original Transaction Number.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Local transaction time returned from the server in HHmmss format.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

This optional property contains information generated by the card issuer.

Syntax

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

SSLAcceptServerCertEncoded Property (TSYSHealthCare Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare 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

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

This is the type of certificate store for this certificate.

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

This specifies the SSL/TLS implementation to use.

Syntax

tsyshealthcarecontrol.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:

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

This is the certificate (PEM/Base64 encoded).

Syntax

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

Substantiated Property (TSYSHealthCare Control)

Identifies if the merchant verified the purchased items against an Inventory Information Approval System (IIAS).

Syntax

tsyshealthcarecontrol.Substantiated[=integer]

Default Value

1

Remarks

This Real-Time Substantiation field is only sent for MasterCard transactions.

Data Type

Integer

Timeout Property (TSYSHealthCare Control)

A timeout for the control.

Syntax

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

TotalMedicalAmount Property (TSYSHealthCare Control)

Sum total of all medical item amounts.

Syntax

tsyshealthcarecontrol.TotalMedicalAmount[=string]

Default Value

""

Remarks

This property is required when submitting a Healthcare Auto-substantiation transaction, and should indicate the sum total of all VisionAmounts, PrescriptionAmounts, ClinicAmounts, and DentalAmounts, plus any additional healthcare-related charges that do not fall under those categories. The category-specific amounts are optional, but at the minimum the TotalMedicalAmount must be present for Healthcare auto-substantiation.

If other amounts are present, the TotalMedicalAmount must be greater than or equal to the total of all other amounts. If the TotalMedicalAmount is left blank, the transaction will be sent as a regular Retail transaction, without the healthcare indicator. If you wish to send a transaction with the healthcare indicator, but no TotalMedicalAmount, set TotalMedicalAmount to "0".

If the transaction is only for healthcare related costs, the TotalMedicalAmount should be equal to the TransactionAmount. However, it is possible to authorize a transaction that includes non-healthcare items, where the TransactionAmount is higher than the TotalMedicalAmount. It may be required that you set PartialAuthorization to True in order to support this functionality.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

TransactionAmount Property (TSYSHealthCare Control)

Purchase amount to be authorized.

Syntax

tsyshealthcarecontrol.TransactionAmount[=string]

Default Value

""

Remarks

This field contains the transaction amount to be authorized. The transaction 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 MerchantCurrencyCode. In the United States, 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 (TSYSHealthCare Control)

Sequence number of this transaction.

Syntax

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

VisaMVV Property (TSYSHealthCare Control)

The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program.

Syntax

tsyshealthcarecontrol.VisaMVV[=string]

Default Value

""

Remarks

The maximum length of this property is 10 characters, and it may only contain 0-9 and A-F.

Data Type

String

VisionAmount Property (TSYSHealthCare Control)

Total amount of Vision or Optical items for Healthcare auto-substantiation.

Syntax

tsyshealthcarecontrol.VisionAmount[=string]

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

Authorize Method (TSYSHealthCare Control)

Authorizes a healthcare transaction with IIAS data.

Syntax

tsyshealthcarecontrol.Authorize 

Remarks

This method sends an authorization request to the Vital/TSYS transaction server. If the authorization request was successful, the ResponseCode property will contain "00". If it's a partial authorization the ResponseCode will contain "10".

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement control. For example:

TSYSHealthCare.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailRecordAggregate(0) = TSYSHealthCare.GetDetailAggregate()

Config Method (TSYSHealthCare Control)

Sets or retrieves a configuration setting.

Syntax

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

EligibilityInquiry Method (TSYSHealthCare Control)

Healthcare Eligibility Inquiry (Visa and MasterCard Only).

Syntax

tsyshealthcarecontrol.EligibilityInquiry 

Remarks

This method does not send an authorization, but instead it sends an authentication request.

Note: When calling this method CardPresent must be set to 'True'

GetDetailAggregate Method (TSYSHealthCare Control)

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

Syntax

tsyshealthcarecontrol.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 (TSYSHealthCare Control)

Interrupts the current action.

Syntax

tsyshealthcarecontrol.Interrupt 

Remarks

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

Reset Method (TSYSHealthCare Control)

Clears all properties to their default values.

Syntax

tsyshealthcarecontrol.Reset 

Remarks

This method clears all properties to their default values.

Connected Event (TSYSHealthCare Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

Fired when a connection is closed.

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

Information about errors during data delivery.

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

Fired after the server presents its certificate to the client.

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

Fired when secure connection progress messages are available.

Syntax

Sub tsyshealthcarecontrol_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 (TSYSHealthCare Control)

TSYSHealthCare Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (TSYSHealthCare Control)

TSYSHealthCare Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors