TSYSDebit Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

nsoftware.InPayDirect.Tsysdebit

Remarks

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

The TSYSDebit component makes authorizing debit card transactions (where the customer's card is swiped through a card reader and a PIN is supplied) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, SSL handshakes, or data packet formatting. The steps to setting up the 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:

  TSYSDebit1.Reset
  TSYSDebit1.MerchantBankId = "999995" '(BIN Number)
  TSYSDebit1.MerchantNumber = "888000002447"
  TSYSDebit1.MerchantName = "TEST MERCHANT"
  TSYSDebit1.MerchantTerminalNumber = "1515"
  TSYSDebit1.MerchantStoreNumber = "5999"
  TSYSDebit1.MerchantCategoryCode = "5999"
  TSYSDebit1.MerchantCity = "Durham"
  TSYSDebit1.MerchantState = "NC"
  TSYSDebit1.MerchantZip = "27713"
  TSYSDebit1.MerchantTimeZone = "705"
  TSYSDebit1.MerchantABANumber = "123456789"
  TSYSDebit1.MerchantSettlementAgent = "V123"
  TSYSDebit1.AgentBankNumber = "000000"
  TSYSDebit1.AgentChainNumber = "111111"
  TSYSDebit1.ReimbursementAttribute = raStandardRetail
  TSYSDebit1.SharingGroup = "GWQEV5" 
  TSYSDebit1.IndustryType = itRetail

Next, set properties that contain details about the transaction. The TransactionNumber is a sequence number, and should be incremented for each transaction you send. BatchNumber indicates which batch you will settle this authorization in. It should match the BatchNumber you set in the TSYSSettle component when you settle this transaction. TransactionAmount is the amount of sale, plus any CashBackAmount returned to the customer, formatted with an implicit decimal place. The CardTrack2Data is read from the magnetic stripe on the back of the card, and the DebitPIN and DebitKSN are retrieved from a standard DUKPT Pin Pad device.

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

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

  TSYSDebit1.Sale()

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

When the 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 a debit card Sale or Credit is approved, the transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle component. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day. Note that BalanceInquiry transactions can not be settled.