TSYSDebit Control

Properties   Methods   Events   Config Settings   Errors  

The TSYSDebit control is an advanced tool used to authorize debit cards in a Retail environment, where the customer is purchasing products or services in person. This control makes authorizing debit card transactions with a customer PIN very easy. Supported Industry Types include retail stores, restaurants, and grocery stores.

Syntax

TSYSDebit

Remarks

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

The TSYSDebit control makes authorizing debit 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, 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:

TSYSDebit1.Reset TSYSDebit1.MerchantBankId = "999995" '(BIN Number) TSYSDebit1.MerchantNumber = "888000002447" TSYSDebit1.MerchantName = "TEST MERCHANT" TSYSDebit1.MerchantTerminalNumber = "1515" TSYSDebit1.MerchantStoreNumber = "5999" TSYSDebit1.MerchantCategoryCode = "5999" TSYSDebit1.MerchantCity = "Durham" TSYSDebit1.MerchantState = "NC" TSYSDebit1.MerchantZip = "27713" TSYSDebit1.MerchantTimeZone = "705" TSYSDebit1.MerchantABANumber = "123456789" TSYSDebit1.MerchantSettlementAgent = "V123" TSYSDebit1.AgentBankNumber = "000000" TSYSDebit1.AgentChainNumber = "111111" TSYSDebit1.ReimbursementAttribute = raStandardRetail TSYSDebit1.SharingGroup = "GWQEV5" TSYSDebit1.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. BatchNumber indicates which batch you will settle this authorization in. It should match the BatchNumber you set in the TSYSSettle control when you settle this transaction. TransactionAmount is the amount of sale, plus any CashBackAmount returned to the customer, formatted with an implicit decimal place. The CardTrack2Data is read from the magnetic stripe on the back of the card, and the DebitPIN and DebitKSN are retrieved from a standard DUKPT Pin Pad device.

TSYSDebit1.TransactionNumber = 1 TSYSDebit1.BatchNumber = 213 TSYSDebit1.TransactionAmount = "1000" TSYSDebit1.CashBackAmount = "300" TSYSDebit1.CardTrack2Data = "9999999800002773=09121015432112345678" TSYSDebit1.CardPIN = "83C33384650827F6" TSYSDebit1.CardKSN = "4A00310459400004"

Finally, submit the transaction by calling one of three authorization methods. Sale, Credit or BalanceInquiry. The following code demonstrates a purchase: TSYSDebit1.Sale()

If wish refund money to a customer's debit card, you must also supply an OriginalPurchaseDate before calling Credit.

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 a debit card Sale or Credit 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 BalanceInquiry transactions can not 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.

AgentBankNumberIdentifies a specific agent entity of the member bank or processor.
AgentChainNumberIdentifies a specific chain of an agent organization.
BatchNumberThe batch number that this transaction will be included in.
CardTrack2DataTrack 2 data for a debit transaction.
CashBackAmountAmount returned to the customer in cash.
DebitKSNClear-text Key Sequence Number, used for Debit and EBT transactions.
DebitPINDUKPT DES encrypted PIN block, used for Debit and EBT transactions.
IndustryTypeCode which indicates the industry the merchant is engaged in.
MerchantBankIdThe number which identifies the merchant's bank or processor.
MerchantCategoryCodeClassifies a merchant by the type of store.
MerchantCityMerchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
MerchantCountryCodeIdentifies the country where the merchant is located.
MerchantCurrencyCodeIdentifies the type of currency used by the merchant.
MerchantLanguageDesignates the language that response messages will be returned in.
MerchantNameName of the merchant.
MerchantNumberA unique number used to identify the merchant within the VisaNet system.
MerchantPhoneMerchant's phone number.
MerchantServicePhoneMerchant's customer service number.
MerchantStateState or province that the merchant is located in.
MerchantStoreNumberUsed to identify a specific merchant's store within the VisaNet system.
MerchantStreetAddressMerchant's street address.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
MerchantTimeZoneSpecifies the GMT offset used to calculate the local time within the VisaNet system.
MerchantZipZip code where the merchant that initiated this transaction is located.
MerchantABANumberMerchant's routing number.
MerchantSettlementAgentMerchant's settling agent.
OriginalPurchaseDateDate and time of original purchase, used for returns.
ReimbursementAttributeIndicates the type of fee applicable to this transaction.
ResponseApprovalCodeContains an authorization code when a transaction has been approved.
ResponseAuthorizedAmountAmount actually used from the card (used when supporting partial redemptions).
ResponseAuthSourceIndicates the source of the authorization code stored in ApprovalCode .
ResponseAVSResultContains the Address Verification System result code.
ResponseBalanceAvailable balance remaining on card.
ResponseCodeIndicates the status of the authorization request.
ResponseCVVResultContains the returned CVV result code if it was requested.
ResponseHostMessageIdUnique host message identifier (Reserved for future use).
ResponseNetworkIdIdentification code of the network on which the transaction was authorized.
ResponseRetrievalNumberThis number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseSettleDateDate at which the Debit, EBT, or Gift Card transaction will settle.
ResponseTextText information that describes each response code.
ResponseTraceSystem Trace Audit Number returned for Debit transactions.
ResponseTransactionDateLocal transaction date returned from the server in MMddyy format.
ResponseTransactionIdContains the Transaction Identifier or MasterCard Reference Number.
ResponseTransactionNumberCheck this property against the original Transaction Number.
ResponseTransactionTimeLocal transaction time returned from the server in HHmmss format.
ResponseValidationCodeThis optional property contains information generated by the card issuer.
SharingGroupList of Debit and EBT networks that the merchant supports.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
TimeoutA timeout for the control.
TransactionAmountPurchase amount to be authorized.
TransactionNumberSequence number of this transaction.

Method List


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

BalanceInquiryRetrieves the current available balance of the debit card.
ConfigSets or retrieves a configuration setting.
CreditCredits a debit card (with a customer-entered PIN).
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for settlement.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
SaleAuthorizes a Debit card (with a customer-entered PIN).

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.

ConnectedFired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.

Config Settings


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

ActivateTerminalAuthenticates a POS device with TSYS.
AllowPartialAuthsIndicates whether partial authorizations are to be supported.
AuthenticationCodeAn alphanumeric code provided to the POS user for input when authenticating a POS device.
AuthorizationIndicatorThe type of authorization request.
CardholderIdSpecifies the method used to verify the identity of the cardholder.
ChipConditionCodeThe condition code of magnetic stripe read transactions of EMV (chip capable) cards.
DeactivateTerminalDeactivates a POS device with TSYS.
EMVDataThe EMV Data returned from a Pin Pad after reading an EMV card.
GatewayIDA unique value to identify a Gateway or Aggregator.
GenKeyA randomly generated string of alphanumeric characters identifying the terminal.
HeartlandDeviceIdSpecifies a device ID to uniquely identify each terminal (card data entry device).
HeartlandEncryptionModeSpecifies the encryption mode to use in Heartland transactions.
HeartlandKeyBlockSpecifies the key block used to encrypt the data.
ISOIdentifierISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover.
LocalRetrievalNumberSpecifies the Retrieval Reference Number to use in a NonConfirm authorization request.
LocalTransactionDateSpecifies the local transaction date to use in a NonConfirm authorization request.
LocalTransactionTimeSpecifies the local transaction time to use in a NonConfirm authorization request.
LocationDetailAddressMerchant's street address.
LocationDetailCityName of the city.
LocationDetailCountryCountry code.
LocationDetailEmailMerchant's e-mail adress.
LocationDetailNameMerchant name.
LocationDetailPhoneMerchant's phone number.
LocationDetailPostalPostal code.
LocationDetailRegionRegion code that corresponds to the state, province, or other country subdivision.
MerchantSellerIDMerchant's Seller ID.
MessageReasonCodeCode used to identify Deferred Authorizations for Visa.
MobileDeviceTypeIdentifies the type of mobile device used by the cardholder to initiate the transaction.
MPGIDMerchant Payment Gateway ID.
PFAcquirerInternalReferenceNumberAcquirer Internal Reference Number (AIRN) (Discover only).
PFForeignRetailerIndicatorThe Payment Facilitator Foreign Retailer Indicator (Visa only).
PFIdentifierThe Payment Facilitator/Marketplace Identifier assigned by Visa, MasterCard, or Discover.
PFNameSubMerchantNameThe Payment Facilitator Name*Sub-Merchant name.
PFSubMerchantCityThe Payment Facilitator Sub-Merchant City.
PFSubMerchantCountryThe Payment Facilitator Sub-Merchant Country Code.
PFSubMerchantIdentifierThe Payment Facilitator Sub-Merchant Identifier.
PFSubMerchantPostalCodeThe Payment Facilitator Sub-Merchant Postal Code.
PFSubMerchantStateThe Payment Facilitator Sub-Merchant State/Province Code.
PortThe port to which transactions are posted.
POSDataCodeSpecifies the condition of the POS device used at the time of the transaction.
ProcessorSpecifies the Processor you are connecting to.
ResponseCardholderVerificationVerification results for cardholder identification data (extended AVS).
ResponseEMVDataThe EMV Data returned in an authorization response.
ResponseStoreNumberCheck this field against the original Merchant StoreNumber.
ResponseTerminalNumberCheck this field against the original Merchant TerminalNumber.
RetrySet this to retry a failed transaction.
SendExtendedAVSSpecifies whether to send extended AVS data.
ServerThe server to which transactions are posted.
SurchargeAmountThe transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
TLIDTransaction Link Identifier.
TsysETBThe Encryption Transmission Block TSYS uses to decrypt encrypted data.
UseConfirmationRequestIndicates whether or not to send a Confirmation Request authorization transaction.
CodePageThe system code page used for Unicode to Multibyte translations.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AgentBankNumber Property (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Identifies a specific chain of an agent organization.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

The batch number that this transaction will be included in.

Syntax

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

CardTrack2Data Property (TSYSDebit Control)

Track 2 data for a debit transaction.

Syntax

tsysdebitcontrol.CardTrack2Data[=string]

Default Value

""

Remarks

This is a variable length field with a maximum data length of 37 characters. For Retail Card Present transactions, this property will contain the entire UNALTERED track as read from a credit card's magnetic stripe. This includes all framing characters. However, the track should be converted to 8-bit ASCII before this property is set (most card readers do this automatically).

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.

Data Type

String

CashBackAmount Property (TSYSDebit Control)

Amount returned to the customer in cash.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Code which indicates the industry the merchant is engaged in.

Syntax

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

sitUnknown (0)Unknown or unsure.
sitRetail (1)Retail store.
sitRestaurant (2)Food / Restaurant.
sitGroceryStore (3)Grocery store or supermarket.
sitDirectMarketing (4)eCommerce or Direct Marketing
sitHotel (5)Hotel / Lodging
sitAutoRental (6)Auto Rental
sitPassengerTransport (7)Passenger Transport

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

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Classifies a merchant by the type of store.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Identifies the country where the merchant is located.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Identifies the type of currency used by the merchant.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Designates the language that response messages will be returned in.

Syntax

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

IndicatorLanguage
00English.
01Spanish.
02Portuguese.
03Reserved for Irish.
04Reserved for French.
05Reserved for German.
06Reserved for Italian.
07Reserved for Dutch.

Data Type

String

MerchantName Property (TSYSDebit Control)

Name of the merchant.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Merchant's phone number.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Merchant's customer service number.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

State or province that the merchant is located in.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Merchant's street address.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Used to identify a unique terminal within a merchant location.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

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

ValueMeaning
0Positive offset, in hours, ahead of GMT.
1Negative offset, in hours, behind GMT.
2Positive offset, in 15 minute increments, ahead of GMT.
3Negative offset, in 15 minute increments, behind GMT.
4Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings.
5Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings.
6Positive offset, in hours, ahead of GMT, in cities participating in daylight savings.
7Negative offset, in hours, behind GMT, in cities participating in daylight savings.
8-9RESERVED.
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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Merchant's routing number.

Syntax

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

MerchantSettlementAgent Property (TSYSDebit Control)

Merchant's settling agent.

Syntax

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

OriginalPurchaseDate Property (TSYSDebit Control)

Date and time of original purchase, used for returns.

Syntax

tsysdebitcontrol.OriginalPurchaseDate[=string]

Default Value

""

Remarks

This property is only applicable for Debit Credit transactions and Gift Card Refund transactions. If supplied, this property must be 8 characters long and formatted as "MMDDhhmm" (month, day, hour, minute).

Data Type

String

ReimbursementAttribute Property (TSYSDebit Control)

Indicates the type of fee applicable to this transaction.

Syntax

tsysdebitcontrol.ReimbursementAttribute[=integer]

Possible Values

raStandardRetail(0), 
raQualifiedGrocery(1), 
raPreExistingRetail(2), 
raPreExistingGrocery(3), 
raNonDebit(4), 
raTaxExempt(5)

Default Value

0

Remarks

This property contains the reimbursement attribute assigned by the signing member or processor. This property designates the Reimbursement Fee applicable to a transaction. The following values are valid for Debit and EBT:

raStandardRetail (0) Standard INTERLINK Retail Merchant.
raQualifiedGrocery (1) Qualified INTERLINK Supermarket/Grocery Merchant.
raPreExistingRetail (2) Pre-existing Qualified INTERLINK Retail Merchant.
raPreExistingGrocery (3) Pre-existing Qualified INTERLINK Supermarket/Grocery Merchant.
raNonDebit (4) EBT, non-debit, or Non-INTERLINK debit.
raTaxExempt (5) Tax exempt organizations.

Data Type

Integer

ResponseApprovalCode Property (TSYSDebit Control)

Contains an authorization code when a transaction has been approved.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

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

CodeDescription
6Off-line approval: POS device generated.
7Acquirer approval.
9Use for non-authorized transactions; such as credit card credits
BResponse provided by Visa Transaction Advisor Service.
EOff-line approval: authorization code manually keyed.
FCAFIS-generated response: Post-Auth.*
GIssuer Approval: Post-Auth.*
HExceeds acquirer settlement risk exposure cap.
NNo authorization required: Below floor limit
LLate clearing - authorization previously obtained (clearing beyond 30 days)
VAuthorization obtained via VisaNet (Issuer or STIP response)
SpaceDefault value, if acquirer cannot define it (MC, D, AX)
* Currently in use by Japan Acquirer Services (JAS).

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

Data Type

String

ResponseAVSResult Property (TSYSDebit Control)

Contains the Address Verification System result code.

Syntax

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

CodeDescription
0Approved/Declined - Address verification was not requested or it was requested but the transaction was declined (Visa, MC, Amex, Discover).
AAddress Match - CustomerAddress matches, CustomerZip does not, or the request does not include the CustomerZip (Visa, Amex, Discover).
I*Ver Unavailable - Address information not verified (Discover).
NNo match - Transaction contained postal/ZIP code only, or street address only, or postal code and street address. Also used when transaction requests AVS but sends no AVS data (Visa, MC, Amex, Discover).
RRetry - System unable to process (Visa, MC, Amex, Discover).
SServ Unavailable - Service not supported (MC, Amex, Discover).
UVer Unavailable - No data from Issuer/Authorization platform (Visa, MC, Amex, Discover).
WZip Match - Nine character CustomerZip matches, CustomerAddress does not (MC, Discover).
XExact Match - Nine character CustomerZip and CustomerAddress match (MC, Discover).
YExact Match - CustomerZip and CustomerAddress match (Visa, MC, Amex, Discover).
ZZip Match - CustomerZip matches; CustomerAddress does not match or street address not included in the request (Visa, MC, Amex, Discover).
1APPROVAL - Cardholder name and ZIP match (Amex only).
2APPROVAL - Cardholder name, address, and ZIP match (Amex only).
3APPROVAL - Cardholder name, address match (Amex only).
4APPROVAL - Cardholder name matches (Amex only).
5APPROVAL - Cardholder name incorrect, ZIP matches (Amex only).
6APPROVAL - Cardholder name incorrect, address and ZIP match (Amex only).
7APPROVAL - Cardholder name incorrect, address matches (Amex only).
8NO MATCH - Cardholder name, address, and ZIP do not match (Amex only).

*AVS Result Code for International addresses only

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

Data Type

String

ResponseBalance Property (TSYSDebit Control)

Available balance remaining on card.

Syntax

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

ResponseCode Property (TSYSDebit Control)

Indicates the status of the authorization request.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Contains the returned CVV result code if it was requested.

Syntax

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

MCVV2 match.
NCVV2 no match.
PNot processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer not certified and/or has not provided Visa encryption keys.

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

Data Type

String

ResponseHostMessageId Property (TSYSDebit Control)

Unique host message identifier (Reserved for future use).

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

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

1 AFFN ATM
5 Visa Check Card II
7 ITS Shazam
8 Maestro
! ATH/Evertec
A Amex ATM
B Plus ATM
C CU24
D Discover ATM
E Accel
F NYCE
G Interlink
H PULSE
J MasterCard ATM
K EBT
L Pulse
M STAR
N STAR
O Cirrus ATM
Q STAR W
S PULSE
T EBT ATM
U AFFN
W STAR SE
Y NYCE
Z STAR NE
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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Text information that describes each response code.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

System Trace Audit Number returned for Debit transactions.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Local transaction date returned from the server in MMddyy format.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Check this property against the original Transaction Number.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Local transaction time returned from the server in HHmmss format.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

This optional property contains information generated by the card issuer.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

List of Debit and EBT networks that the merchant supports.

Syntax

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

1AFFN ATM
5Visa Check Card II
7ITS Shazam
8Maestro
!ATH/Evertec
AAmex ATM
BPlus ATM
CCU24
DDiscover ATM
EAccel
FNYCE
GInterlink
HPULSE
JMastercard ATM
KEBT
LPulse
MSTAR
NSTAR
OCirrus ATM
QSTAR W
SPULSE
TEBT ATM
UAFFN
WSTAR SE
YNYCE
ZSTAR NE

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

This is the certificate (PEM/Base64 encoded).

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

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

Syntax

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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 (TSYSDebit 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

tsysdebitcontrol.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 (TSYSDebit Control)

This is the type of certificate store for this certificate.

Syntax

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (TSYSDebit Control)

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

Syntax

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (TSYSDebit Control)

This specifies the SSL/TLS implementation to use.

Syntax

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

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
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 (TSYSDebit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

A timeout for the control.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Purchase amount to be authorized.

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Sequence number of this transaction.

Syntax

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

BalanceInquiry Method (TSYSDebit Control)

Retrieves the current available balance of the debit card.

Syntax

tsysdebitcontrol.BalanceInquiry 

Remarks

This method sends a balance inquiry request to the Vital/TSYS transaction processor. The CardTrack2Data property must be populated with the data from the magnetic stripe on the back of the card, and both DebitPIN and DebitKSN must contain data from a certified PIN pad device. If the authorization request was successful, the ResponseCode property will contain "00", and the ResponseBalance property will contain the card's current available balance.

Config Method (TSYSDebit Control)

Sets or retrieves a configuration setting.

Syntax

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

Credit Method (TSYSDebit Control)

Credits a debit card (with a customer-entered PIN).

Syntax

tsysdebitcontrol.Credit 

Remarks

This methods sends a Credit request to the Vital/TSYS transaction processor. The CardTrack2Data property must be populated with the data from the magnetic stripe on the back of the card, and both DebitPIN and DebitKSN must contain data from a certified PIN pad device. The OriginalPurchaseDate must also contain the date at which the original Sale transaction was sent. If the authorization request was successful, the ResponseCode property will contain "00".

GetDetailAggregate Method (TSYSDebit Control)

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

Syntax

tsysdebitcontrol.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 (TSYSDebit Control)

Interrupts the current action.

Syntax

tsysdebitcontrol.Interrupt 

Remarks

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

Reset Method (TSYSDebit Control)

Clears all properties to their default values.

Syntax

tsysdebitcontrol.Reset 

Remarks

This method clears all properties to their default values.

Sale Method (TSYSDebit Control)

Authorizes a Debit card (with a customer-entered PIN).

Syntax

tsysdebitcontrol.Sale 

Remarks

This method sends a sale/purchase request to the Vital/TSYS transaction processor. The CardTrack2Data property must be populated with the data from the magnetic stripe on the back of the card, and both DebitPIN and DebitKSN must contain data from a certified PIN pad device. If the authorization request was successful, the ResponseCode property will contain "00".

Connected Event (TSYSDebit Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit Control)

Fired when a connection is closed.

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit Control)

Information about errors during data delivery.

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit Control)

Fired after the server presents its certificate to the client.

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit Control)

Fired when secure connection progress messages are available.

Syntax

Sub tsysdebitcontrol_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 (TSYSDebit 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.

TSYSDebit Config Settings

ActivateTerminal:   Authenticates a POS device with TSYS.

This is an action config which when called will authenticate a POS device with TSYS. Authentication is required when processing transactions using Voltage Encryption or Tokenization. An AuthenticationCode is required to be specified, as is MerchantZip and/or MerchantServicePhone, to perform authentication. After a POS device is successfully authenticated, GenKey will be populated.

AllowPartialAuths:   Indicates whether partial authorizations are to be supported.

When this setting is True, if the debit card being authorized does not contain sufficient funds to cover the TransactionAmount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount. The customer must then use another form of payment to make up the remainder. The total amount authorized by TSYS will be returned in the ResponseAuthorizedAmount configuration setting. For instance, if the TransactionAmount is $100.00, but the card only has a $50.00 balance, the card is charged for $50.00, and the ResponseAuthorizedAmount will be "50.00". The merchant may then collect the remaining $50 in cash, check, credit card, or any other acceptable form of payment. This setting is False by default.

AuthenticationCode:   An alphanumeric code provided to the POS user for input when authenticating a POS device.

This field is used to specify the AuthenticationCode, assigned by TSYS, to authenticate a POS device (made via a call to ActivateTerminal).

AuthorizationIndicator:   The type of authorization request.

This field defines the type of authorization request and must be included on all MasterCard authorization request transactions.

Valid values are:

Code Description
P Pre Authorization
F Final Authorization
U Undefined Authorization

CardholderId:   Specifies the method used to verify the identity of the cardholder.

By default the control automatically computes the CardholderId based on several factors. Changing this config setting will override this automatic calculation. Clear this setting to "" (empty string) to restore automatic calculation. Please see the TSYSDetailRecord control's CardholderId property for more information.

ChipConditionCode:   The condition code of magnetic stripe read transactions of EMV (chip capable) cards.

This config is used to provide information about magnetic stripe read transactions using chip capable cards at chip capable POS devices.

Available values are:

Value Description
0 Service code does not begin with a two or six or fill for subsequent positions that are present.
1 Service code begins with two or six; last CCPS read at the chip capable terminal was successful, or was not a chip transaction, or unknown.
2 Service code begins with two or six; last transaction at the chip capable terminal was unsuccessful chip read.

DeactivateTerminal:   Deactivates a POS device with TSYS.

This is an action config which when called will deactivate the POS device specified via GenKey with TSYS.

EMVData:   The EMV Data returned from a Pin Pad after reading an EMV card.

This configuration setting takes the entire TLV (tag-length-value) response received from a Pin Pad after reading an EMV card. When setting this field, any EMV tags that are not specified within the TSYS specifications, to include in the request, will be removed from the input. The component will send this data in an authorization request. Note that when performing an EMV transaction, POSDataCode is required.

GatewayID:   A unique value to identify a Gateway or Aggregator.

This 10 character field provides a unique value to identify a Gateway or Aggregator. This number is provided by TSYS Acquiring Solutions during the certification process.

GenKey:   A randomly generated string of alphanumeric characters identifying the terminal.

This field is used to specify retrieve or specify a GenKey value for a terminal. This field will be populated after a successful call to ActivateTerminal is made. The Genkey must be stored in the POS device, must be sent with every request to the TSYS Acquiring Solutions host after authentication (by setting this field), and will be checked against the terminal hierarchy. A GenKey value is required when processing transactions using Voltage Encryption or Tokenization.

HeartlandDeviceId:   Specifies a device ID to uniquely identify each terminal (card data entry device).

The specified value must be 4 characters or less. Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.

HeartlandEncryptionMode:   Specifies the encryption mode to use in Heartland transactions.

This field allows you to specify the Heartland E3 encryption mode used when processing Heartland transactions. The available values are (descriptions describe the data that will be encrypted):

0No Encryption (default)
1Merchant ID and Card Data (reserved for future use)
2Merchant ID, Card Data, and Card Security Code (reserved for future use)
3Card Data Only

Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.

HeartlandKeyBlock:   Specifies the key block used to encrypt the data.

This field allows you to specify the key block that was used to encrypt the data specified by HeartlandEncryptionMode. This value will be obtained from an E3 magnetic stripe reader and is used by Heartland to decrypt the encrypted data.

ISOIdentifier:   ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover.

This 11-digit value is assigned to the Service Provider designated as an ISO (Independent Sales Organization) during registration with the card brand and must be included on all MasterCard or Discover transactions where the merchant has a relationship with an ISO.

LocalRetrievalNumber:   Specifies the Retrieval Reference Number to use in a NonConfirm authorization request.

This property is used to specify the Retrieval Reference Number to use in a NonConfirm authorization request (when UseConfirmationRequest = "False"). The specified value must contain a 12-character numeric value. It is suggested that the first 4 characters be the Julian date (yddd) and the remaining 8 characters are a numeric transaction identification number. If this value is set to "" (empty string), the component will generate a Retrieval Reference Number for you when the authorization request is sent.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

LocalTransactionDate:   Specifies the local transaction date to use in a NonConfirm authorization request.

This property is used to specify the local transaction date to use in a NonConfirm authorization request (when UseConfirmationRequest = "False"). The specified value must be in MMDDYY format. If "" (empty string) is specified, the component will generate the local transaction date for you based on the current system time.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

LocalTransactionTime:   Specifies the local transaction time to use in a NonConfirm authorization request.

This property is used to specify the local transaction time to use in a NonConfirm authorization request (when UseConfirmationRequest = "False"). The specified value must be in HHMMSS format. If "" (empty string) is specified, the component will generate the local transaction time for you based on the current system time.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

LocationDetailAddress:   Merchant's street address.

This field is used to identify the merchant's street address where the transaction took place. The maximum length is 38 characters (upper-case). For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 20 characters and if necessary this value should be truncated rather than abbreviated.

LocationDetailCity:   Name of the city.

This field is used to identify the name of the city where the transaction took place. The maximum length is 21 characters (upper-case). For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 13 characters.

LocationDetailCountry:   Country code.

This field is used to identify the country code of the location where the transaction took place. For example, the country code for USA is "840." The maximum length is 3 characters.

LocationDetailEmail:   Merchant's e-mail adress.

This field is used for American Express transactions that are submitted via an Aggregator/Payment Service Provider. It is used to identify the Aggregator's e-mail address. The maximum length is 20 characters and if necessary this value should be truncated rather than abbreviated.

LocationDetailName:   Merchant name.

This field is used to identify the merchant name that appears on the storefront and/or customer receipts and statements. The maximum length is 38 characters (upper-case). For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 30 characters and if necessary this value should be truncated rather than abbreviated.

LocationDetailPhone:   Merchant's phone number.

This field is used for American Express transactions that are submitted via an Aggregator/Payment Service Provider. It is used to identify the Aggregator's phone number. This value should be 10 characters in length and it must include the area code.

LocationDetailPostal:   Postal code.

This field is used to identify the postal / zip code of the location where the transaction took place. The maximum length is 15 characters. For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 10 characters.

LocationDetailRegion:   Region code that corresponds to the state, province, or other country subdivision.

This field is used to identify the region code that corresponds to the state, province, or other country subdivision of the merchant location where the transaction took place. The maximum length is 3 characters.

MerchantSellerID:   Merchant's Seller ID.

This field is used for American Express transactions that are submitted via an Aggregator/Payment Service Provider. It contains a maximum 20-byte numeric code that uniquely identifies an American Express Payment Service Provider's (Aggregator's) seller or vendor code.

MessageReasonCode:   Code used to identify Deferred Authorizations for Visa.

This field is used to identify Deferred Authorizations for Visa.

Deferred Authorizations If the merchant's Point-of-Interaction (POI) authorization system is offline and cannot process transactions, the merchant often completes the transaction with the cardholder and will then defer the authorization until their POI system is back online. Valid value is:

Code Description
5206 Deferred Authorization

MobileDeviceType:   Identifies the type of mobile device used by the cardholder to initiate the transaction.

This field is required for all MasterCard PayPass (contactless) transactions. Valid values are:

Value Description
00 Card (default)
01 Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone
02 Key Fob
03 Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO
04 Mobile Tag
05 Wristband
06 Mobile Phone Case or Sleeve
07 Mobile Phone or Smartphone with a fixed (non-removable) secure element controlled by the MNO (such as CDMA)
08 Removable secure element not controlled by the MNO, for example, memory card personalized for use with a mobile phone or smartphone
09 Mobile Phone or Smartphone with a fixed (non-removable) secure element not controlled by the MNO
10 MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book
11 Tablet or E-Book with a fixed (non-removable) secure element controlled by the MNO
12 Removable secure element not controlled by the MNO (such as memory card personalized for use with a tablet or e-book)
13 Tablet or E-Book with fixed (nonremovable) secure element not controlled by the MNO
14 Mobile Phone or Smartphone with a payment application running in a host processor
15 Tablet or E-Book with a payment application running in a host processor
16 Mobile Phone or Smartphone with a payment application running in the TEE of a host processor
17 Tablet or E-Book with a payment application running in the TEE of a host processor
18 Watch with a payment application running in the TEE of a host processor
19 Watch with a payment application running in a host processor
20 Card
21 Phone (i.e. Mobile phone)
22 Tablet/e-reader (i.e. Tablet computer or e-reader)
23 Watch/Wristband (i.e. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band)
24 Sticker
25 PC (i.e. PC or laptop)
26 Device Peripheral (i.e. Mobile phone case or sleeve)
27 Tag (i.e. Key fob or mobile tag)
28 Jewelry (i.e. Ring, bracelet, necklace, and cuff links)
29 Fashion Accessory (i.e. Handbag, bag charm, and glasses)
30 Garment (i.e. Dress)
31 Domestic Appliance (i.e. Refrigerator, washing machine)
32 Vehicle (i.e. Vehicle, including vehicle attached devices)
33 Media/Gaming Device (i.e. Media or gaming device, including a set top box, media player, and television)
34-99 These values reserved for future form factors. Any value in this range may occur within form factors and transaction data without prior notice.
MPGID:   Merchant Payment Gateway ID.

The Merchant Payment Gateway Identifier (MPGID) is a unique value that is generated and provisioned by Mastercard. Payment gateways must register directly with Mastercard to obtain a unique value, and include it on the incoming authorization message. Maximum length for this field is 11 digits.

PFAcquirerInternalReferenceNumber:   Acquirer Internal Reference Number (AIRN) (Discover only).

This unique digit internal identification code is assigned by the Acquirer to it's merchant. Discover assigns this 20-character field during registration via the Discover Network.

PFForeignRetailerIndicator:   The Payment Facilitator Foreign Retailer Indicator (Visa only).

This 3-character field is used by marketplaces to uniquely identify domestic transactions in which the retailer is in a different country than the marketplace. Visa classifies an entity as a marketplace if it handles payments on behalf of retailers through an online marketplace that brings together multiple buyers and retailers. This field must be sent when the retailer is foreign.

Valid values are:

Code Description
(Space) (default) Space indicates the retailer is not foreign.
F This value indicates the retailer is located in a different country than the marketplace.
Note: This field will be automatically left-justified, space-filled to 3 characters.

PFIdentifier:   The Payment Facilitator/Marketplace Identifier assigned by Visa, MasterCard, or Discover.

This 11-digit value is assigned to the Service Provider during registration with the card brand and must be included on all Visa, MasterCard, or Discover transactions where the merchant has a relationship with a Payment Facilitator/Service Provider.

Note: For Visa Marketplaces, the Marketplace ID must be included in this field.

PFNameSubMerchantName:   The Payment Facilitator Name*Sub-Merchant name.

This 25-character field is a subfield of Payment Facilitator and must be included on all transactions where the merchant has a relationship with a Payment Facilitator. It has two usages:

Usage 1 - Payment Facilitator Name*Sub-Merchant Name

This usage is valid for Visa, Mastercard, and Discover.

For Payment Facilitators, the field contains two parts in a concatenation of two fields separated by an asterisk (*). For Visa, Mastercard, and Discover the name submitted should match what the PayFac registered with each brand and should follow the requirements defined by each brand.

Usage 2 - Marketplace Name

For Visa Marketplaces, the field should contain the name of the Marketplace.

PFSubMerchantCity:   The Payment Facilitator Sub-Merchant City.

This 13-character field is a subfield of Payment Facilitator.

For Visa and Mastercard transactions, enter the city of the sub-merchant location (not the Payment Facilitator location).

For Discover transactions, enter the location where the transaction took place; this may or may not be the sub-merchant location.

For Direct Marketing merchants and preferred customer/passenger transport and card not present transactions, this field must contain a phone number for merchant customer service in format XXX-XXXXXXX. The dash is required. This field can also be used for e-mail or a URL.

PFSubMerchantCountry:   The Payment Facilitator Sub-Merchant Country Code.

This 3-digit field indicates the country of the Sub-Merchant location (not the Payment Facilitator location) using ISO-specified numeric codes. It is used for Visa, Mastercard, and Discover transactions and must be included on all transactions where the merchant has a relationship with a Payment Facilitator.

PFSubMerchantIdentifier:   The Payment Facilitator Sub-Merchant Identifier.

This 15-character field, assigned by the Payment Facilitator or the Acquirer, must be provided on all Visa, Mastercard, or Discover transactions where the merchant has a relationship with a Payment Facilitator.

PFSubMerchantPostalCode:   The Payment Facilitator Sub-Merchant Postal Code.

This 9-character field indicates the postal code of the Sub-Merchant location (not the Payment Facilitator location). This field must be included on all transactions where the merchant has a relationship with a Payment Facilitator. It is used for Visa, Mastercard, and Discover transactions.

PFSubMerchantState:   The Payment Facilitator Sub-Merchant State/Province Code.

This 2-character field indicates the state or province code of the Sub-Merchant location (not the Payment Facilitator location). If the Sub-Merchant is non-U.S. and non-Canadian, this field should be '00'. This field must be included on all Visa, Mastercard, and Discover transactions where the merchant has a relationship with a Payment Facilitator.

Port:   The port to which transactions are posted.

This is port that this control connects to on the server. The default value for TSYS is 5003 for the live server, and 5004 for the test server. The default live server values for Heartland is 22341 for Authorization and 22342 for Settlement. The Heartland test server values are 12341 for Authorization and 12342 for Settlement.

POSDataCode:   Specifies the condition of the POS device used at the time of the transaction.

This configuration setting takes a semi-colon separated list of name-value pairs. The available field names and their applicable values can be found below. The fields can be set in any order and not all fields are required to be set (unless you wish to change their default values).

Code Example: TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");

CardInputCap (Terminal card data input capability)

0 (default) Unspecified, data not available
1 Manual; no terminal; Voice auth/ARU
2 Magnetic stripe reader capability
3 Bar code/ Payment code
4 Optical character reader (OCR) capability, [MC, AX]
5 Integrated circuit card (ICC) capability and magnetic stripe reader
6 Key entry only capability; Mastercard recurring and installment transactions
A PAN auto-entry via contactless magnetic stripe
B Magnetic stripe reader and key entry capability
C Magnetic stripe reader, ICC, and key entry capability
D Magnetic stripe reader and ICC capability
E ICC entry capability
H ICC Reader and Contactless Capability; Magnetic stripe & manual entry implied
M PAN auto-entry via contactless chip
V Other capability, [MC]
X Reserved for private use

CardholderAuthCap (Terminal cardholder authentication capability)

0 No electronic authentication capability
1 PIN entry capability
2 Electronic signature analysis capability
3 mPOS software-based PIN entry capability
5 Electronic authentication capability is inoperative
6 Other
9 (default) Unspecified, data not available

CardCaptureCap (Terminal card-capture capability)

0 No capture capability
1 Card capture capability
9 (default) Unspecified, data not available

TerminalOpEnv (Terminal operating environment)

0 No terminal used; Voice auth/ARU; Mastercard recurring/installment transactions
1 On card acceptor premises; attended terminal
2 On card acceptor premises; unattended terminal
3 Off card acceptor premises; attended
4 Off card acceptor premises; unattended
5 On cardholder premises; unattended
6 Off cardholder premises; unattended
9 (default) Unspecified, data not available
M Off card acceptor premises; merchant mobile POS environment, including mPOS
P On card acceptor premises; merchant mobile POS environment, including mPOS
Q Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA
R On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA
S Electronic delivery of product, [AX]
T Physical delivery of product, [AX]

CardholderPresent (Cardholder present data)

0 Cardholder present
1 Cardholder not present; unspecified reason
2 Cardholder not present; mail transaction
3 Cardholder not present; phone transaction
4 Cardholder not present; standing (recurring) transaction
5 Cardholder not present; electronic commerce
8 Cardholder not present; recurrent billing such as a loan or installment payment
R Recurring purchase transaction (original transaction was token-based with valid cryptogram)
T PayButton (Discover only)

CardPresent (Card present data)

0 Card not present
1 Card present
W Transponder, [AX]
X Contactless Chip Transactions, including AMEX Expresspay
Z Digital Wallet [AX]

CardInputMode (Card data input mode)

0 (default) Unspecified, data not available
1 Manual input; no terminal; Voice auth/ARU
2 Magnetic stripe reader input
3 Bar code/Payment code
6 Key entered input
7 Payment Credential stored on file. NOTE: This value is required for all Mastercard recurring transactions.
A PAN auto-entry via contactless magnetic stripe
B Magnetic stripe reader input; track data captured and passed unaltered
C Online Chip
F Offline Chip
M PAN auto-entry via contactless Chip Card (EMV Mode)
N Track data read and sent unaltered, chip capable terminal, chip data could not be read
P Empty candidate list fallback
R PAN Entry via electronic commerce, including remote chip
S Electronic commerce, no security, channel encrypted, or SET without cardholder certificate
V Manually entered with keyed CID, [AX, JCB Canada]
W Swiped transaction with keyed CID, [AX, JCB Canada]
X Reserved for private use
Y Reserved for private use
Z Contactless Interface Change Identifies when a Chip Card Transaction with a dualinterface card switches from a contactless to a contact chip card transaction [Discover]

NOTE: AMEX defines ApplePay with value C - Online Chip

CardholderAuthMethod (Cardholder authentication method)

0 Not authenticated
1 PIN
2 Electronic signature analysis
5 Manual signature verification
6 Other manual verification (such as a driver's license number)
9 (default) Unspecified, data not available
S Other systematic verification
T Electronic ticket environment, [AX]

CardholderAuthEntity (Cardholder authentication entity)

0 Not authenticated
1 ICC - Offline PIN
2 Card acceptance device (CAD)
3 Authorizing agent - Online PIN
4 Merchant/card acceptor - signature
5 Other
9 (default) Unspecified, data not available

CardOutputCap (Card data output capability)

0 (default) Unspecified, data not available
1 None
2 Magnetic stripe write
3 ICC
S Other

TerminalOutputCap (Terminal data output capability)

0 (default) Unspecified, data not available
1 None
2 Printing capability only
3 Display capability only
4 Printing and display capability

PINCaptureCap (PIN capture capability)

0 No PIN capture capability
1 (default) Unspecified, data not available
2 Reserved
3 Reserved
4 PIN capture capability four characters maximum
5 PIN capture capability five characters maximum
6 PIN capture capability six characters maximum
7 PIN capture capability seven characters maximum
8 PIN capture capability eight characters maximum
9 PIN capture capability nine characters maximum
A PIN capture capability 10 characters maximum
B PIN capture capability 11 characters maximum
C PIN capture capability 12 characters maximum

Note: Setting this configuration setting in TSYSDetailRecord control will not update the POSDataCode tag in the detail aggregate of the original transaction.

Processor:   Specifies the Processor you are connecting to.

This field allows you to specify the processor that you are connecting to (thus allowing the control to correctly generate the request and parse the response). The available values are:

0TSYS (default)
1Heartland

Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting Card to ensure the card data is formatted correctly.

ResponseCardholderVerification:   Verification results for cardholder identification data (extended AVS).

This response data is returned when SendExtendedAVS is set to 'True' and is only available for American Express and Discover cards. This data is arranged in order of 5 bytes, one for each result of a cardholder identification data element:

Byte Number Description
Byte 1 Billing ZIP Code
Byte 2 Billing Street Match Code
Byte 3 Billing Name Match Code
Byte 4 Telephone Number Match Code
Byte 5 E-mail Address Match Code

The possible values for each byte are:

Value Description
Y Data Matches
U Data Unchecked
N No Match
S Service not allowed
R Retry
' ' (Space) Data not sent

For Discover transactions, byte 3 will be populated with the following values:

Value Description
B No response due to blank input
K Unknown
P Not processed
M First Name and Last Name match
F First Name Matches, Last Name does not match
L First Name does not match, Last Name matches
N Nothing matches
W No data from Issuer/Authorization system
U Retry, system unable to process

ResponseEMVData:   The EMV Data returned in an authorization response.

This configuration setting contains the EMV Data in TLV (tag-length-value) format. This field will only be populated if an EMV transaction was performed and EMV Data was received in the authorization response.

ResponseStoreNumber:   Check this field against the original Merchant StoreNumber.

The value of this field is used to correctly match responses with transactions by comparing its value to that of the MerchantStoreNumber. This is particularly useful when making a multi-merchant or multi-store routing system. If the system that originally made the transaction receives a response where the ResponseStoreNumber is not identical to the MerchantStoreNumber the transaction should not be stored for batch settlement. This field is read-only.

ResponseTerminalNumber:   Check this field against the original Merchant TerminalNumber.

The value of this field is used to correctly match responses with transactions by comparing its value to that of MerchantTerminalNumber. This is particularly useful when making a multi-terminal routing system within a merchant location. If the terminal that originally made the transaction receives a response where the ResponseTerminalNumber is not identical to the MerchantTerminalNumber, the transaction should not be stored for batch settlement. This field is read-only.

Retry:   Set this to retry a failed transaction.

If an authorization returns ambiguously or times out without receiving a response, you may send the same transaction over again with this Retry flag set to True. This will prevent you from double-charging your customers in the case of a communications error (only available for credit card transactions. Does not apply to Debit, Gift Card, or EBT transactions).

SendExtendedAVS:   Specifies whether to send extended AVS data.

When set to 'True', AVS data will be sent in the extended AVS field for the transaction. ResponseCardholderVerification will contain the extended AVS verification results. When set to 'False' (default value), the CustomerAddress and CustomerZip values will be sent using the simple AVS data fields.

Server:   The server to which transactions are posted.

This is name of the server to which all transactions are posted. Do not use an IP address, use the actual name, as a server's IP address may change. The default (Live) TSYS server is "ssl2.vitalps.net", but you may use "ssltest.tsysacquiring.net" for testing. The default (Live) Heartland server is "txns.secureexchange.net", but you may use "test.txns.secureexchange.net" for testing. Note that there are several MerchantBankIds and MerchantNumbers that will always run in test mode regardless of whether you are using the live server. See the included demos for examples.

SurchargeAmount:   The transaction fee amount charged to the customer to account for acquirer-assessed surcharge.

This configuration setting is for informational purposes only and any surcharge amounts charged to the customer should be included in the TransactionAmount.

The format of this field is 'annnnnnnn' where 'a' is either 'D' for debit or 'C' for credit. 'nnnnnnnn' is the numeric fee amount with the decimal implied. For example: 'D00000150' is a $1.50 transaction fee amount debited to the cardholder's account.

Note: If an amount is only specified, the component will generate the format above by prepending a 'D' and the necessary number of 0's.

TLID:   Transaction Link Identifier.

The Transaction Link Identifier (TLID) is used to track the life cycle of activity occurring after the original transaction and other related transactions. The TLID will be returned by Mastercard in the authorization response message. The returned value will also be present in the aggregate returned from the GetDetailAggregate method and for all subsequent transactions that utilize the aggregate (such as reversals, incrementals, settlement) the value will be automatically included in the request. When not utilizing the aggregate, you may explicitly set this config with the TLID value that was saved when the original transaction was performed.

TsysETB:   The Encryption Transmission Block TSYS uses to decrypt encrypted data.

This field is used to specify the Base-64 encoded ETB (Encryption Transmission Block) used by TSYS to decrypt Voltage encrypted data. The value is retrieved from the POS device containing the Voltage encryption software. When specified, the transaction will be sent as a Voltage encrypted transaction. The encrypted card data will be specified as normal via the CardMagneticStripe or CardNumber fields.

UseConfirmationRequest:   Indicates whether or not to send a Confirmation Request authorization transaction.

When set to "True", a confirmation authorization transaction will be sent. In a confirmation request, TSYS will generate the Retrieval Reference Number (ResponseRetrievalNumber) and the System Trace Audit Number (ResponseTrace). When setting this property to "False" (default value), a NonConfirm authorization transaction will be sent. In these transactions, a Retrieval Reference Number, System Trace Audit Number, Local Date, and Local Time are NOT generated by TSYS and must be manually specified by the POS application. By default, the component will automatically generate these values for you. However you can override them by setting the following properties: LocalRetrievalNumber, LocalTransactionDate, , and LocalTransactionTime. Note the System Trace Audit Number is required to be the last 6 characters of the LocalRetrievalNumber and thus the component will automatically obtain and send this value for you.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

Base Config Settings

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (TSYSDebit Control)

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