4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

TSYSHCLevel3 Component

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSHCLevel3 component is used to add Level 3 data to a previously authorized transaction. This component makes adding Level 3 data very easy.




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 TSYSHCLevel3 component makes adding Level 3 data to a transaction 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 and POS specific properties with setup information acquired from your member bank or processor. For instance:

  TSYSHCLevel31.GenKey = "gen_key_value"
  TSYSHCLevel31.MerchantId = "merchant_id"
  TSYSHCLevel31.RoutingId = "routing_id"

Next, set properties that contain details about the transaction. At the minimum, you must set a RetrievalNumber and OriginalAmount.

  TSYSHCLevel31.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber
  TSYSHCLevel31.OriginalAmount = TSYSHCRetail1.TransactionAmount

Now, set the Level 3 enhanced data that you wish to add to the transaction. For example:

	TSYSHCLevel31.CommodityCode = "FAKE"
    TSYSHCLevel31.NationalTax = "0"
	TSYSHCLevel31.MerchantTaxId = "merchantTaxId"
	TSYSHCLevel31.CustomerTaxId = "customerTaxId"
	TSYSHCLevel31.DiscountAmount = "0"
	TSYSHCLevel31.FreightAmount = "0"
	TSYSHCLevel31.DutyAmount = "0"
	TSYSHCLevel31.ShipFromZip = "27709"
	TSYSHCLevel31.DestinationZip = "27709"
	TSYSHCLevel31.DestinationCountry = "840"
	TSYSHCLevel31.InvoiceNumber = "VATInvoiceRefNo"
	TSYSHCLevel31.OrderDate = "111023" // "yyMMdd"
	TSYSHCLevel31.FreightTaxAmount = "0"
	TSYSHCLevel31.FreightTaxRate = "0"

If you have any line item details, you can specify them now. Note that Quantity and Total are required to be set when adding line item details.

	TSYSHCLevel31.LineItems.Add(new TSYSLineItem())
	TSYSHCLevel31.LineItems[0].CommodityCode = "fake"
	TSYSHCLevel31.LineItems[0].Description = "hardware"
	TSYSHCLevel31.LineItems[0].DiscountAmount = "0"
	TSYSHCLevel31.LineItems[0].DiscountRate = "0"
	TSYSHCLevel31.LineItems[0].ProductCode = "1243320"
	TSYSHCLevel31.LineItems[0].Quantity = 1
	TSYSHCLevel31.LineItems[0].TaxAmount = "3"
	TSYSHCLevel31.LineItems[0].TaxRate = "0"
	TSYSHCLevel31.LineItems[0].Total = "53"
	TSYSHCLevel31.LineItems[0].UnitCost = "50"
	TSYSHCLevel31.LineItems[0].Units = "each"

	TSYSHCLevel31.LineItems.Add(new TSYSLineItem())
	TSYSHCLevel31.LineItems[1].CommodityCode = "fake"
	TSYSHCLevel31.LineItems[1].Description = "software"
	TSYSHCLevel31.LineItems[1].DiscountAmount = "0"
	TSYSHCLevel31.LineItems[1].DiscountRate = "0"
	TSYSHCLevel31.LineItems[1].ProductCode = "1243321"
	TSYSHCLevel31.LineItems[1].Quantity = 2
	TSYSHCLevel31.LineItems[1].TaxAmount = "3"
	TSYSHCLevel31.LineItems[1].TaxRate = "0"
	TSYSHCLevel31.LineItems[1].Total = "106"
	TSYSHCLevel31.LineItems[1].UnitCost = "53"
	TSYSHCLevel31.LineItems[1].Units = "each"

Finally, submit the level 3 details by calling AdjustTransaction.


When the component receives a response from the Vital/TSYS servers, the result of the adjustment will be displayed in several Response properties. The Code indicates whether the level 3 details were successfully added to the transaction. The remaining properties provide additional information about the transaction.

Once the level 3 details are successfully added, the transaction will be added to the current batch. 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 automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr component.

Note: If you intend to add Level 3 data to a transaction, the initial authorization (purchase) should have CaptureMode set to Delay (1). This initiates a delay on the capture, thus providing you with time to add the Level 3 details before the transaction is 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.

AlternateTaxAmountSecondary tax amount (only applicable in some countries).
AlternateTaxIdTax Id number of the merchant that reported the AlternateTaxAmount .
CardTypeThe card type for which a Level 3 addendum will be created.
CommodityCodeCode indicating the type of goods or services sold.
CustomerTaxIdCustomer's Value Added Tax registration number.
DestinationCountryCountry the goods are to be shipped to.
DestinationZipZip code the goods are to be shipped to.
DiscountAmountAmount of any discount subtracted from the line item totals.
DutyAmountDuty fees (if any) for imported goods.
FreightAmountShipping charges associated with this transaction.
FreightTaxAmountPortion of the FreightAmount that is tax.
FreightTaxRateRate used to calculate the FreightTaxAmount .
GenKeyThe unique GenKey value used to identify a POS device.
LineItemsA collection of line items to be included in the Level III addendum.
MerchantIdThe unique ID that associates the POS device with the merchant account.
MerchantTaxIdMerchant's government tax Id number.
NationalTaxAmount of federal or national taxes that are a part of this transaction.
OrderDateDate of the order in YYMMDD format.
OriginalAmountThe original authorized amount for the transaction to be adjusted.
ResponseContains the response to an adjustment request.
RetrievalNumberThe retrieval reference number (RRN) used to identify a transaction.
RoutingIdThe Routing ID assigned to the merchant by TSYS.
ShipFromZipZip code the goods are being shipped from.
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.
TaxInvoiceNumberOptional VAT Invoice Number assigned by the merchant.
TimeoutA timeout for the component.

Method List

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

AdjustTransactionSends Level 3 transaction requests.
ConfigSets or retrieves a configuration setting .
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.

ErrorInformation about errors during data delivery.
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.

RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
ServerURLThe server to which transactions are posted.
LanguageIndicates the language to be used in formatting the authorization response text message.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
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.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
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.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
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.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

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