4D Payments SDK 2016 .NET Edition

Questions / Feedback?

TSYSRetail Component

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSRetail component is an advanced tool used to authorize credit cards in a Retail environment, where the customer is purchasing products or services in person. This component makes authorizing these types of transactions very easy. Supported Industry Types include retail stores, restaurants, grocery or food stores, Hotels, Auto Rental businesses and Passenger Transport.




This component allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. 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 TSYSRetail component makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) 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:

  component.MerchantBankId = "999995"  '(BIN number)
  component.MerchantCategoryCode = "5999"
  component.MerchantName = "test merchant"
  component.MerchantNumber = "123456789012" 
  component.MerchantCity = "Beverly Hills"
  component.MerchantState = "CA"
  component.MerchantStoreNumber = "5999"
  component.MerchantTerminalNumber = "1515"
  component.MerchantZip = "90210"

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount, TransactionNumber, and IndustryType.

  component.TransactionAmount = "100"
  component.TransactionNumber = 1
  component.IndustryType = itRetail

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

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

Finally, submit the transaction by calling the Authorize method.

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 AVSResult indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle component. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

Property List

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

CardContains the customer's credit card information.
CardPresentIndicates whether the current transaction is a card present transaction.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
IndustryTypeCode which indicates the industry the merchant is engaged in.
MerchantContains the merchant's setup information.
PrestigiousIndicatorPrestigious Lodging Program indicator for the Hotel Industry Type.
RentalDurationDuration of an auto rental or hotel stay.
ResponseContains the response to an authorization request.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TransactionAmountPurchase amount to be authorized.
TransactionNumberSequence number of this transaction.

Method List

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

AuthenticateCardDetermines only if a card has been lost or stolen.
AuthorizeSends an authorization request.
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.
ResponseUsed with Interleaved Transaction Mode.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings

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

AcceptanceDeviceTypeIdentifies the type of device used to accept mobile Point of Sale (mPOS) transactions (Mastercard and Amex only).
AccountDataSourceIdentifies the source of the customer card data entered.
ACIRequested Authorization Characteristics Indicator (ACI).
ActivateTerminalAuthenticates a POS device with TSYS.
AllowPartialAuthsIndicates whether partial authorizations are to be supported.
AmexAggregatorNameAmex Payment Service Provider/Aggregator Name.
AmexAirlinePassengerDataUsed by Merchants that are in the airline industry to submit information for Passenger Transport transactions.
AmexCNPInternetPhoneDataUsed by Merchants in mail-, telephone- and internet-order industries to submit additional data for Card Not Present transactions.
AmexCPGoodsSoldDataIdentifies merchandise such as gift cards, computers, and other electronics that can be resold for cash.
AuthenticationCodeAn alphanumeric code provided to the POS user for input when authenticating a POS device.
AuthorizationIndicatorThe type of authorization request.
BusinessApplicationIdBusiness Application Identifier (BAI). Visa only.
CanadaDomesticIndicatorCanada Domestic Indicator.
CardholderIdSpecifies the method used to verify the identity of the cardholder.
CashOverAmountThe Cash Over amount requested.
ChipConditionCodeThe condition code of magnetic stripe read transactions of EMV (chip capable) cards.
CountryCodeIdentifies the country where the merchant is located.
CumulativeAmountTotal cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only).
CurrencyCodeIdentifies the type of currency used by the merchant.
CurrentPendingResponseCountCurrent number of pending response packets.
CustomerAddressCustomer's billing address, used for Manually Keyed transactions.
CustomerZipZip code portion of the customer's billing address, used for Manually Keyed transactions.
CVV2OptionVerification code.
DeactivateTerminalDeactivates a POS device with TSYS.
DeviceCodeA 1-character value used to identify the device and type of the merchant submitting the settlement batch.
DisconnectInterleavedTo explicitly terminate the connection.
DoEventsProcesses events from the internal message queue.
DomainServerRemote domain server indicator.
EMVDataThe EMV Data returned from a Pin Pad after reading an EMV card.
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
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.
IncrementalApprovalCodeTransaction Approval Code associated with authorization to increment.
IncrementalRetrievalNumberTransaction Retrieval Number associated with authorization to increment.
IncrementalTransDateTransaction Date associated with authorization to increment.
IncrementalTransIdTransaction Id associated with authorization to increment.
IncrementalTransTimeTransaction Time associated with authorization to increment.
InterleavedModeDetermines whether to use Interleaved Transaction Mode for authorization requests.
InterleavedTimeoutTimeout value to wait for a response from TSYS.
IsBalanceInquiryIndicates that the transaction is a Balance Inquiry transaction.
IsBillPaymentIndicates that the transaction is a bill payment transaction.
IsEstimatedAmountSpecifies whether the amount is an estimate. Visa transactions only.
IsExistingDebtPaymentSpecifies whether the transaction is a payment on an existing debt transaction.
IsMerchantInitiatedTransactionSet this to process a Merchant Initiated transaction.
IsPurchaseReturnAuthorizationSet this to process a Purchase Return Authorization transaction.
IsQuasiCashSpecifies whether the transaction is Quasi-Cash transaction.
LaneIdIdentifies a terminal at the card acceptor location of acquiring institutions or merchant POS systems.
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.
MastercardWalletIdMastercard Wallet Identifier used to identify the Wallet Provider.
MaxPendingResponseCountMaximum number of pending response packets.
MerchantLanguageDesignates the language that response messages will be returned in.
MerchantSellerIDMerchant's Seller ID.
MessageReasonCodeCode used to identify MIT or Deferred Authorizations for Visa.
MITTransactionIdTransaction Id associated with the original authorization of a Merchant Initiated Transaction.
MobileDeviceTypeIdentifies the type of mobile device used by the cardholder to initiate the transaction.
MSDIMarket Specific Data Indicator.
OriginalAmountThe Original Amount related to a previous Consumer Initiated Transaction (Discover only).
OriginalAmountAccountTypeThe Account Type of the Original Amount (Discover only).
PFIdentifierThe Payment Facilitator Identifier value assigned by MasterCard.
PFNameSubMerchantNameThe Payment Facilitator Name and 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.
POSEnvironmentIndicatorProvides additional information about the transaction for Visa.
ProcessorSpecifies the Processor you are connecting to.
RequestTokenIndicates whether to request a token for the specified card data sent in an Authorize request.
ResponseAvailableBalanceResponse Available Balance.
ResponseCardholderVerificationVerification results for cardholder identification data (extended AVS).
ResponseCashOverAmountThe Cash Over amount approved.
ResponseEMVDataThe EMV Data returned in an authorization response.
ResponseLedgerBalanceResponse Ledger Balance.
ResponseMerchantAdviceCodeThe Merchant Advice Code returned by Mastercard MIP for declined CNP transactions.
ResponseStoreNumberCheck this field against the original Merchant StoreNumber.
ResponseTerminalNumberCheck this field against the original Merchant TerminalNumber.
ResponseTokenStatusThe status of retrieval of the token.
ResponseTransactionIntegrityClassA 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class.
RetailDepartmentNameDepartment name.
RetrieveTokenSends a Token Only request.
RetrySet this to retry a failed transaction.
SendCommCardIndIndicates whether to send Commercial Card Request Indicator.
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.
TokenThe token received from the TSYS host when a token request is sent.
TransactionStatusA 1-character value used to indicate the purpose or status of the request.
TsysETBThe Encryption Transmission Block TSYS uses to decrypt encrypted data.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 8017]