TSYSBenefit Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPayments.DPaymentsSDK.Tsysbenefit

Remarks

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

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

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

TSYSBenefit1.Merchant.BankId = "999995"; TSYSBenefit1.Merchant.Number = "888000002447"; TSYSBenefit1.Merchant.Name = "TEST MERCHANT"; TSYSBenefit1.Merchant.TerminalNumber = "1515"; TSYSBenefit1.Merchant.StoreNumber = "5999"; TSYSBenefit1.Merchant.CategoryCode = "5999"; TSYSBenefit1.Merchant.City = "Durham"; TSYSBenefit1.Merchant.State = "NC"; TSYSBenefit1.Merchant.Zip = "27713"; TSYSBenefit1.Merchant.TimeZone = "705"; TSYSBenefit1.MerchantABANumber = "123456789"; TSYSBenefit1.MerchantSettlementAgent = "V123"; TSYSBenefit1.MerchantFCSId = "1234567"; TSYSBenefit1.AgentBankNumber = "000000"; TSYSBenefit1.AgentChainNumber = "111111"; TSYSBenefit1.SharingGroup = "8GWK" TSYSBenefit1.IndustryType = itRetail;

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

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

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

TSYSBenefit1.TransactionType = ttFoodStampPurchase TSYSBenefit1.Authorize()

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

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

Property List


The following is the full list of the properties of the component 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.
CardContains the customer's credit card information.
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.
MerchantContains the merchant's setup information.
MerchantABANumberMerchant's routing number.
MerchantFCSIdIdentifies the merchant as an approved Food Stamp merchant.
MerchantSettlementAgentMerchant's settling agent.
ResponseContains the response to an authorization request.
SharingGroupList of Debit and EBT networks that the merchant supports.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TransactionAmountPurchase amount to be authorized.
TransactionNumberSequence number of this transaction.
TransactionTypeSpecifies the type of EBT transaction to process.
VoucherCodeRequired for Food Stamp Voucher transactions.
VoucherNumberRequired for Food Stamp Voucher transactions.

Method List


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

AuthorizeSends a Gift Card transaction.
ConfigSets or retrieves a configuration setting.
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.

Event List


The following is the full list of the events fired by the component 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 component 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.
DeactivateTerminalDeactivates a POS device with TSYS.
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.
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).
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.
TimeoutA timeout for the component.
TsysETBThe Encryption Transmission Block TSYS uses to decrypt encrypted data.
UseConfirmationRequestIndicates whether or not to send a Confirmation Request authorization transaction.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AgentBankNumber Property (TSYSBenefit Component)

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

Syntax

public string AgentBankNumber { get; set; }
Public Property AgentBankNumber As 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.

AgentChainNumber Property (TSYSBenefit Component)

Identifies a specific chain of an agent organization.

Syntax

public string AgentChainNumber { get; set; }
Public Property AgentChainNumber As 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.

BatchNumber Property (TSYSBenefit Component)

The batch number that this transaction will be included in.

Syntax

public int BatchNumber { get; set; }
Public Property BatchNumber As 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 component's BatchNumber property. The range is from 1 to 999.

Card Property (TSYSBenefit Component)

Contains the customer's credit card information.

Syntax

public CCCard Card { get; set; }
Public Property Card As CCCard

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

Note that you may not send Track1 data in the MagneticStripe field for EBT transactions. You may only submit transactions with Track2 data or manual entry.

This property is not available at design time.

Please refer to the CCCard type for a complete list of fields.

CashBackAmount Property (TSYSBenefit Component)

Amount returned to the customer in cash.

Syntax

public string CashBackAmount { get; set; }
Public Property CashBackAmount As 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.

DebitKSN Property (TSYSBenefit Component)

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

Syntax

public string DebitKSN { get; set; }
Public Property DebitKSN As 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.

DebitPIN Property (TSYSBenefit Component)

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

Syntax

public string DebitPIN { get; set; }
Public Property DebitPIN As 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.

IndustryType Property (TSYSBenefit Component)

Code which indicates the industry the merchant is engaged in.

Syntax

public TsysbenefitIndustryTypes IndustryType { get; set; }

enum TsysbenefitIndustryTypes { sitUnknown, sitRetail, sitRestaurant, sitGroceryStore, sitDirectMarketing, sitHotel, sitAutoRental, sitPassengerTransport }
Public Property IndustryType As TsysbenefitIndustryTypes

Enum TsysbenefitIndustryTypes sitUnknown sitRetail sitRestaurant sitGroceryStore sitDirectMarketing sitHotel sitAutoRental sitPassengerTransport End Enum

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

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 component All Debit, EBT, and Gift Card transactions must be face-to-face card present transactions.

Merchant Property (TSYSBenefit Component)

Contains the merchant's setup information.

Syntax

public TSYSMerchant Merchant { get; set; }
Public Property Merchant As TSYSMerchant

Remarks

This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available fields.

Please refer to the TSYSMerchant type for a complete list of fields.

MerchantABANumber Property (TSYSBenefit Component)

Merchant's routing number.

Syntax

public string MerchantABANumber { get; set; }
Public Property MerchantABANumber As 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.

MerchantFCSId Property (TSYSBenefit Component)

Identifies the merchant as an approved Food Stamp merchant.

Syntax

public string MerchantFCSId { get; set; }
Public Property MerchantFCSId As String

Default Value

""

Remarks

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

MerchantSettlementAgent Property (TSYSBenefit Component)

Merchant's settling agent.

Syntax

public string MerchantSettlementAgent { get; set; }
Public Property MerchantSettlementAgent As 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.

Response Property (TSYSBenefit Component)

Contains the response to an authorization request.

Syntax

public TSYSBenefitResponse Response { get; }
Public ReadOnly Property Response As TSYSBenefitResponse

Remarks

This property will contain the response returned from the TSYS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. This type contains the following fields:

ApprovalCode Contains an authorization code for approved transactions, or a description of the error for declines.
AuthorizedAmount Amount actually used from the card (used when supporting partial redemptions).
AuthSource Indicates the source of the authorization code stored in ApprovalCode.
AVSResult Contains the Address Verification System result code.
CardLevel This field contains a two-character code created by Visa during the authorization process.
Code Indicates the status of the authorization request.
CommercialCardType Indicates whether the credit card charged is a corporate commercial card (and if so the type of commercial card).
CVVResult Contains the returned CVV result code (if CVV data was sent in the request).
RetrievalNumber This number is to be submitted for reversals or at settlement.
ReturnedACI Returned Authorization Characteristics Indicator contains CPS qualification status.
Text Text information that describes each response code.
TransactionDate Local transaction date returned from the server in MMDDYY format.
TransactionId Contains the Transaction Identifier or MasterCard Reference Number.
TransactionNumber Check this field against the TransactionNumber sent in the authorization.
TransactionTime Local transaction time returned from the server in HHMMSS format.
ValidationCode Additional information generated by the card issuer.
Balance Available balance remaining on card.
HostMessageId Unique host message identifier (Reserved for future use).
NetworkId Identification code of the network on which the transaction was authorized.
SettleDate Date at which the Debit, EBT, or Gift Card transaction will settle.
Trace System Trace Audit Number returned for Debit transactions.
CashBenefitLedgerBalance The ledger balance on the cash benefit account (TSYS EIS 1080 account type 96, amount type 01).
CashBenefitAvailableBalance The currently available balance on the cash benefit account (TSYS EIS 1080 account type 96, amount type 02).
FoodStampLedgerBalance The ledger balance on the food stamps account (TSYS EIS 1080 account type 98, amount type 01).
FoodStampAvailableBalance The currently available balance on the food stamps account (TSYS EIS 1080 account type 98, amount type 02).

This property is read-only.

Please refer to the TSYSBenefitResponse type for a complete list of fields.

SharingGroup Property (TSYSBenefit Component)

List of Debit and EBT networks that the merchant supports.

Syntax

public string SharingGroup { get; set; }
Public Property SharingGroup As 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 NetworkId property.

SSLAcceptServerCert Property (TSYSBenefit Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (TSYSBenefit Component)

The certificate to be used during SSL negotiation.

Syntax

public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (TSYSBenefit Component)

This specifies the SSL/TLS implementation to use.

Syntax

public TsysbenefitSSLProviders SSLProvider { get; set; }

enum TsysbenefitSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As TsysbenefitSSLProviders

Enum TsysbenefitSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum

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 component 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 component will select a provider depending on the current platform.

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (TSYSBenefit Component)

The server certificate for the last established connection.

Syntax

public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

Timeout Property (TSYSBenefit Component)

A timeout for the component.

Syntax

public int Timeout { get; set; }
Public Property Timeout As Integer

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

TransactionAmount Property (TSYSBenefit Component)

Purchase amount to be authorized.

Syntax

public string TransactionAmount { get; set; }
Public Property TransactionAmount As 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.

TransactionNumber Property (TSYSBenefit Component)

Sequence number of this transaction.

Syntax

public int TransactionNumber { get; set; }
Public Property TransactionNumber As 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 TransactionNumber 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.

TransactionType Property (TSYSBenefit Component)

Specifies the type of EBT transaction to process.

Syntax

public TsysbenefitTransactionTypes TransactionType { get; set; }

enum TsysbenefitTransactionTypes { ettFoodStampPurchase, ettFoodStampReturn, ettFoodStampVoucher, ettFoodStampBalanceInquiry, ettCashBenefitWithdrawal, ettCashBenefitPurchase, ettCashBenefitBalanceInquiry }
Public Property TransactionType As TsysbenefitTransactionTypes

Enum TsysbenefitTransactionTypes ettFoodStampPurchase ettFoodStampReturn ettFoodStampVoucher ettFoodStampBalanceInquiry ettCashBenefitWithdrawal ettCashBenefitPurchase ettCashBenefitBalanceInquiry End Enum

Default Value

8

Remarks

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

ettFoodStampPurchase (8)this transaction is used to purchase groceries or food items using funds from the Food Stamp account associated with the customer's EBT card. The customer may not receive cash back for this transaction.
ettFoodStampReturn (9)This transaction is used to refund money to a customer's Food Stamp account. This may only be used when a customer returns goods previously purchased using the ttFoodStampPurchase transaction type.
ettFoodStampVoucher (10)This transaction is identical to a ttFoodStampPurchase, but is used when the merchant's point of sale system or the EBT network is offline. The merchant must call the EBT Voice Authorization network and receive a VoucherNumber and VoucherCode to submit with this transaction.
ettFoodStampBalanceInquiry (11)This transaction retrieves the current available balance for the Food Stamp account associated with the customer's EBT card. The balance is returned in the Balance property.
ettCashBenefitWithdrawal (12)This transaction is used to withdraw money from the Cash Benefit account associated with the customer's EBT card. The amount to withdraw is indicated by the TransactionAmount property. The CashBackAmount property must be empty ("") for authorization, but should match the TransactionAmount when this transaction is settled.
ettCashBenefitPurchase (13)This transaction is used to purchase goods or services using funds from the Cash Benefit account associated with the customer's EBT card. The customer may also receive cash back using the CashBackAmount property. (Note that the TransactionAmount must equal the cost of the goods purchased PLUS the CashBackAmount).
ettCashBenefitBalanceInquiry (14)This transaction retrieves the current available balance for the Cash Benefit account associated with the customer's EBT card. The balance is returned in the Balance property.

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

VoucherCode Property (TSYSBenefit Component)

Required for Food Stamp Voucher transactions.

Syntax

public string VoucherCode { get; set; }
Public Property VoucherCode As String

Default Value

""

Remarks

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

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

VoucherNumber Property (TSYSBenefit Component)

Required for Food Stamp Voucher transactions.

Syntax

public string VoucherNumber { get; set; }
Public Property VoucherNumber As String

Default Value

""

Remarks

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

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

Authorize Method (TSYSBenefit Component)

Sends a Gift Card transaction.

Syntax

public void Authorize();
Public Sub Authorize()

Remarks

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

Config Method (TSYSBenefit Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);
Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

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

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

GetDetailAggregate Method (TSYSBenefit Component)

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

Syntax

public string GetDetailAggregate();
Public Function GetDetailAggregate() As String

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 component'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 component to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method throws an exception.

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

TSYSRetail.Authorize() TSYSSettle.DetailRecords.Add(new TSYSRecordType(TSYSRetail.GetDetailAggregate()));

Interrupt Method (TSYSBenefit Component)

Interrupts the current action.

Syntax

public void Interrupt();
Public Sub Interrupt()

Remarks

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

Reset Method (TSYSBenefit Component)

Clears all properties to their default values.

Syntax

public void Reset();
Public Sub Reset()

Remarks

This method clears all properties to their default values.

Connected Event (TSYSBenefit Component)

Fired immediately after a connection completes (or fails).

Syntax

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, TsysbenefitConnectedEventArgs e);

public class TsysbenefitConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As TsysbenefitConnectedEventArgs)

Public Class TsysbenefitConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

Please refer to the Error Codes section for more information.

DataPacketIn Event (TSYSBenefit Component)

Fired when receiving a data packet from the transaction server.

Syntax

public event OnDataPacketInHandler OnDataPacketIn;

public delegate void OnDataPacketInHandler(object sender, TsysbenefitDataPacketInEventArgs e);

public class TsysbenefitDataPacketInEventArgs : EventArgs {
  public string DataPacket { get; }
public byte[] DataPacketB { get; } }
Public Event OnDataPacketIn As OnDataPacketInHandler

Public Delegate Sub OnDataPacketInHandler(sender As Object, e As TsysbenefitDataPacketInEventArgs)

Public Class TsysbenefitDataPacketInEventArgs Inherits EventArgs
  Public ReadOnly Property DataPacket As String
Public ReadOnly Property DataPacketB As Byte() End Class

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

DataPacketOut Event (TSYSBenefit Component)

Fired when sending a data packet to the transaction server.

Syntax

public event OnDataPacketOutHandler OnDataPacketOut;

public delegate void OnDataPacketOutHandler(object sender, TsysbenefitDataPacketOutEventArgs e);

public class TsysbenefitDataPacketOutEventArgs : EventArgs {
  public string DataPacket { get; }
public byte[] DataPacketB { get; } }
Public Event OnDataPacketOut As OnDataPacketOutHandler

Public Delegate Sub OnDataPacketOutHandler(sender As Object, e As TsysbenefitDataPacketOutEventArgs)

Public Class TsysbenefitDataPacketOutEventArgs Inherits EventArgs
  Public ReadOnly Property DataPacket As String
Public ReadOnly Property DataPacketB As Byte() End Class

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

Disconnected Event (TSYSBenefit Component)

Fired when a connection is closed.

Syntax

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, TsysbenefitDisconnectedEventArgs e);

public class TsysbenefitDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As TsysbenefitDisconnectedEventArgs)

Public Class TsysbenefitDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

Please refer to the Error Codes section for more information.

Error Event (TSYSBenefit Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, TsysbenefitErrorEventArgs e);

public class TsysbenefitErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As TsysbenefitErrorEventArgs)

Public Class TsysbenefitErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

SSLServerAuthentication Event (TSYSBenefit Component)

Fired after the server presents its certificate to the client.

Syntax

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, TsysbenefitSSLServerAuthenticationEventArgs e);

public class TsysbenefitSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As TsysbenefitSSLServerAuthenticationEventArgs)

Public Class TsysbenefitSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class

Remarks

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

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

SSLStatus Event (TSYSBenefit Component)

Fired when secure connection progress messages are available.

Syntax

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, TsysbenefitSSLStatusEventArgs e);

public class TsysbenefitSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}
Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As TsysbenefitSSLStatusEventArgs)

Public Class TsysbenefitSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the component are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the component will look for MagneticStripe data when authorizing the transaction, and will throws an exception because none is present.

Fields

CardType
TCardTypes

Default Value: 0

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

ctUnknown (0) Invalid or unknown prefix, card type not known.
ctVisa (1) Visa or Delta Card.
ctMasterCard (2) MasterCard.
ctAMEX (3) American Express Card.
ctDiscover (4) Discover Card.
ctDiners (5) Diners Club or Carte Blanche Card.
ctJCB (6) JCB Card.
ctVisaElectron (7) Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8) Maestro Card
ctLaser (10) Laser Card (Ireland)

CVVData
string

Default Value: ""

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

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

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

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

CVVPresence
CCCVVPresences

Default Value: 0

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

The component will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.

Available values are:

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

EntryDataSource
EntryDataSources

Default Value: 0

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

edsTrack1 (0) Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1) Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2) Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (Number, ExpMonth, and ExpYear are sent).
edsKiosk (9)Automated kiosk transaction. Track1 or Track2 data must be sent in MagneticStripe, the transaction cannot be manually entered.

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

TSYSHCBenefit edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce edsManualEntryNoCardReader
TSYSHCRetail edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

ExpMonth
int

Default Value: 1

Expiration month of the credit card specified in Number.

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

ExpYear
int

Default Value: 2000

Expiration year of the credit card specified in Number.

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

IsEncrypted
bool

Default Value: False

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

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

MagneticStripe
string

Default Value: ""

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

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

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

component.Card = new CCCard("B4788250000028291^TSYS^05121015432112345678", dsTrack1) or component.Card = new CCCard("4788250000028291=05121015432112345678", dsTrack2) or CCCardType Card = new CCCard() Card.MagneticStripe = "B4788250000028291^TSYS^05121015432112345678" Card.EntryDataSource = dsTrack1

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.

Number
string

Default Value: ""

Customer's credit card number for the transaction.

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

Constructors

public CCCard();
Public CCCard()
public CCCard(string number, int expMonth, int expYear);
Public CCCard(ByVal Number As String, ByVal ExpMonth As Integer, ByVal ExpYear As Integer)
public CCCard(string magneticStripe, EntryDataSources entryDataSource);
Public CCCard(ByVal MagneticStripe As String, ByVal EntryDataSource As EntryDataSources)

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate
string (read-only)

Default Value: ""

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
string

Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

EncodedB
byte []

Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

ExpirationDate
string (read-only)

Default Value: ""

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string

Default Value: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
string (read-only)

Default Value: ""

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
string (read-only)

Default Value: ""

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
string (read-only)

Default Value: ""

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
string (read-only)

Default Value: ""

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
string (read-only)

Default Value: ""

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
bool (read-only)

Default Value: False

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)

Default Value: ""

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
string (read-only)

Default Value: ""

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
string

Default Value: ""

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)

Default Value: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
string (read-only)

Default Value: ""

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
string (read-only)

Default Value: ""

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
string

Default Value: "MY"

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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).

StoreB
byte []

Default Value: "MY"

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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).

StorePassword
string

Default Value: ""

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

StoreType
CertStoreTypes

Default Value: 0

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field 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 component. 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 Store and set StorePassword 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.

Subject
string

Default Value: ""

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

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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.

SubjectAltNames
string (read-only)

Default Value: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)

Default Value: ""

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
string (read-only)

Default Value: ""

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
string (read-only)

Default Value: ""

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
string

Default Value: ""

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int

Default Value: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication (Non-Repudiation)
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
string (read-only)

Default Value: ""

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();
Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] certificateData);
Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

TSYSBenefitResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the TSYSBenefit component. The fields contained by this type are listed below.

Fields

ApprovalCode
string (read-only)

Default Value: ""

Contains an authorization code when a transaction has been approved.

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

AuthorizedAmount
string (read-only)

Default Value: ""

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

The AuthorizedAmount 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 AuthorizedAmount 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 AuthorizedAmount will represent the approved amount of $7.50.In this case, the Code will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the AuthorizedAmount 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 field 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.

AuthSource
string (read-only)

Default Value: ""

Indicates the source of the authorization code stored in ApprovalCode.

This field contains a one character code indicating the source of the ApprovalCode. 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).

AVSResult
string (read-only)

Default Value: ""

Contains the Address Verification System result code.

This one character field 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

Balance
string (read-only)

Default Value: ""

Available balance remaining on card.

This field 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 Balance 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.

CashBenefitAvailableBalance
string (read-only)

Default Value: ""

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

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

CashBenefitLedgerBalance
string (read-only)

Default Value: ""

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

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

Code
string (read-only)

Default Value: ""

Indicates the status of the authorization request.

This field 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 Text 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 Codes are listed in the table of contents.

CVVResult
string (read-only)

Default Value: ""

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character field 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 Text 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.

FoodStampAvailableBalance
string (read-only)

Default Value: ""

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

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

FoodStampLedgerBalance
string (read-only)

Default Value: ""

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

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

HostMessageId
string (read-only)

Default Value: ""

Unique host message identifier (Reserved for future use).

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

NetworkId
string (read-only)

Default Value: ""

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

This field indicates the network through which the transaction was authorized. If this field 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 NetworkId 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 field is valid for Debit card and EBT card transactions only. It will be ignored for all other TransactionTypes.

RetrievalNumber
string (read-only)

Default Value: ""

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

This field 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.

ReturnedACI
string (read-only)

Default Value: ""

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field 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 field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the TransactionId or ValidationCode fields.

SettleDate
string (read-only)

Default Value: ""

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

This field 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.

Text
string (read-only)

Default Value: ""

Text information that describes each response code.

This field 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.

Trace
string (read-only)

Default Value: ""

System Trace Audit Number returned for Debit transactions.

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

TransactionDate
string (read-only)

Default Value: ""

Local transaction date returned from the server in MMddyy format.

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

TransactionId
string (read-only)

Default Value: ""

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character field 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 field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

TransactionNumber
string (read-only)

Default Value: ""

Check this field against the original Transaction Number.

This field 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 field should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

TransactionTime
string (read-only)

Default Value: ""

Local transaction time returned from the server in HHmmss format.

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

ValidationCode
string (read-only)

Default Value: ""

This optional field contains information generated by the card issuer.

This optional four character field 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 field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.

Constructors

TSYSMerchant Type

Contains the merchant's setup information.

Remarks

This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other fields that identify the merchant to the TSYS server. Some of the information in these fields will be included on the customer's credit card statement, such as the merchant's Name, State, ServicePhone, etc.

Fields

BankId
string

Default Value: ""

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

This field 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 field may not remain zero-filled.

Note, the TSYS Server uses the Merchant's BankId and Number 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.

CategoryCode
string

Default Value: ""

Classifies a merchant by the type of store.

This four digit field 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).

City
string

Default Value: ""

Merchant's City

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

The first character of this field may not be a space and must contain the same data used in the batch settlement.

Note that this field is ignored for Direct Marketing and E-Commerce transactions. ServicePhone is used for those industries instead of City.

This field may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this field is 13 characters.

CountryCode
string

Default Value: "840"

Identifies the country where the merchant is located.

This field 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".

CurrencyCode
string

Default Value: "840"

Identifies the type of currency used by the merchant.

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

Language
string

Default Value: "00"

Designates the language that response messages will be returned in.

This field contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This field 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.

Name
string

Default Value: ""

Name of the merchant.

This 25 character field 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 field may not be a space. This field must contain the same value in both authorization and batch settlement.

This is an optional field. However if this field is specified, the State and City (Retail) or State and ServicePhone (E-Commerce) must also be specified.

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

Number
string

Default Value: ""

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

This 12 digit field contains a unique number which is assigned by the signing merchant's bank or processor. This field 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 BankId and Number 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.

Phone
string

Default Value: ""

Merchant's phone number.

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

ServicePhone
string

Default Value: ""

Merchant's customer service number.

This field 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 field is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

State
string

Default Value: ""

State or province that the merchant is located in.

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

This is an optional field. However if it is specified the Merchant Name and City (Retail) or Name and ServicePhone (E-Commerce) must also be specified.

StoreNumber
string

Default Value: ""

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

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

StreetAddress
string

Default Value: ""

Merchant's street address.

This 25 character field 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.

TerminalNumber
string

Default Value: ""

Used to identify a unique terminal within a merchant location.

This four digit field 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 field 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 field must be right-justified and zero-filled.

TimeZone
string

Default Value: "705"

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.

Zip
string

Default Value: ""

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

This field 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 field will be assigned by the signing member or processor.

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

Constructors

public TSYSMerchant();
Public TSYSMerchant()

Config Settings (TSYSBenefit Component)

The component 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 component, access to these internal properties is provided through the Config method.

TSYSBenefit 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 Zip and/or ServicePhone, 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 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 component 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 component's CardholderId property for more information.

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.

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.

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 component 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 component 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 component 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

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 StoreNumber. 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 StoreNumber 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 TerminalNumber. 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 TerminalNumber, 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 BankIds and Numbers 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.

Timeout:   A timeout for the component.

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

The default value for Timeout is 30 (seconds).

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 MagneticStripe or Number 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 (RetrievalNumber) and the System Trace Audit Number (Trace). 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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
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 true to mask sensitive data. The default is true.

This setting only works on these components: 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 false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (TSYSBenefit Component)

TSYSBenefit Errors

501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.
504   Luhn digit check failed.
505   Card date invalid.
506   Card expired.
507   Card type unknown.
509   No gateway specified.
511   Invalid data entered.
512   Truncated response.
513   Invalid response.
517   Response length mismatch.
518   LRC check failed.
519   Corrupt response.
520   Response packet empty.
521   Response truncated.
522   Host disconnected.
523   No response from host.
524   Server error response.
526   Invalid timeout value.
527   Vital/TSYS returned an error response.
535   Signature verification failed.
544   Error building packet.
593   Missing or erroneous property value. Cannot send transaction.
594   Response received before transmission completed.
595   Prematurely disconnected (check Number and BankId).
596   Pending responses max number exceeded (Interleaved).
597   Pending response timeout (Interleaved).

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the component is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
303   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).