TSYSHCRetail Class

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSHCRetail component is 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.

Class Name

InPayDirect_TSYSHCRetail

Procedural Interface

 inpaydirect_tsyshcretail_open();
 inpaydirect_tsyshcretail_close($res);
 inpaydirect_tsyshcretail_register_callback($res, $id, $function);
 inpaydirect_tsyshcretail_get_last_error($res);
 inpaydirect_tsyshcretail_get_last_error_code($res);
 inpaydirect_tsyshcretail_set($res, $id, $index, $value);
 inpaydirect_tsyshcretail_get($res, $id, $index);
 inpaydirect_tsyshcretail_do_adjusttip($res, $retrievalnumber, $originalamount, $tipamount);
 inpaydirect_tsyshcretail_do_authenticatecard($res);
 inpaydirect_tsyshcretail_do_billpayment($res);
 inpaydirect_tsyshcretail_do_config($res, $configurationstring);
 inpaydirect_tsyshcretail_do_credit($res);
 inpaydirect_tsyshcretail_do_force($res, $approvalcode, $transactiondate, $transactiontime);
 inpaydirect_tsyshcretail_do_interrupt($res);
 inpaydirect_tsyshcretail_do_reset($res);
 inpaydirect_tsyshcretail_do_sale($res);
 inpaydirect_tsyshcretail_do_voidtransaction($res, $retrievalnumber, $originalamount);

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHCRetail class 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 class 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:

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

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount and TransactionNumber. 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.

  TSYSHCRetail1.TransactionAmount = "100"
  TSYSHCRetail1.TransactionNumber = 1

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.

  TSYSHCRetail1.CardMagneticStripe = "%B4444333322221111^SMITH/JOHN J         ^031210100000033301000000008000000?"
  TSYSHCRetail1.CardEntryDataSource = edsTrack1  

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

  TSYSHCRetail1.Sale()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved, and the ResponseAVSResult 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 a credit card Sale or Credit is approved and is 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 class.