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.

Syntax

nsoftware.InPayDirect.Tsyshclevel3

Remarks

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.

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