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

TSYSBenefit Component

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSBenefit component is an advanced tool used to authorize Electronic Benefits (EBT) cards in a Retail environment, where the customer is purchasing products or services in person. This component makes authorizing EBT Food Stamp and Cash Benefit transactions (with a customer PIN) very easy. Supported Industry Types include retail stores, restaurants, and grocery stores.




This component allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. 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 TSYSBenefit component makes authorizing EBT 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, 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:

  TSYSBenefit1.Merchant.BankId = "999995";
  TSYSBenefit1.Merchant.Number = "888000002447";
  TSYSBenefit1.Merchant.Name = "TEST MERCHANT";
  TSYSBenefit1.Merchant.TerminalNumber = "1515";
  TSYSBenefit1.Merchant.StoreNumber = "5999";
  TSYSBenefit1.Merchant.CategoryCode = "5999";
  TSYSBenefit1.Merchant.City = "Durham";
  TSYSBenefit1.Merchant.State = "NC";
  TSYSBenefit1.Merchant.Zip = "27713";
  TSYSBenefit1.Merchant.TimeZone = "705";

  TSYSBenefit1.MerchantABANumber = "123456789";
  TSYSBenefit1.MerchantSettlementAgent = "V123";
  TSYSBenefit1.MerchantFCSId = "1234567";
  TSYSBenefit1.AgentBankNumber = "000000";
  TSYSBenefit1.AgentChainNumber = "111111";
  TSYSBenefit1.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. TransactionAmount is the amount of sale, formatted with an implicit decimal place. The MagneticStripe is read from the magnetic stripe on the back of the card, (Track 2 for EBT transactions) and the DebitPIN and DebitKSN are retrieved from a standard DUKPT Pin Pad device.

  TSYSBenefit1.TransactionNumber = 1
  TSYSBenefit1.TransactionAmount = "1000"
  TSYSBenefit1.CardMagneticStripe = "9999999800002773=09121015432112345678"
  TSYSBenefit1.CardPIN = "83C33384650827F6"
  TSYSBenefit1.CardKSN = "4A00310459400004"

The TSYSBenefit component supports both Food Stamp and Cash Benefit programs on the same card. Make sure to choose the correct TransactionType for the benefit program you wish to use, and then call the Authorize method. For example:

  TSYSBenefit1.TransactionType = ttFoodStampPurchase

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 an EBT authorization 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 ttFoodStampBalanceInquiry and ttCashBenefitBalanceInquiry TransactionTypes cannot be 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.

AgentBankNumberIdentifies a specific agent entity of the member bank or processor.
AgentChainNumberIdentifies a specific chain of an agent organization.
BatchNumberThe batch number that this transaction will be included in.
CardContains the customer's credit card information.
CashBackAmountAmount returned to the customer in cash.
DebitKSNClear-text Key Sequence Number, used for Debit and EBT transactions.
DebitPINDUKPT DES encrypted PIN block, used for Debit and EBT transactions.
IndustryTypeCode which indicates the industry the merchant is engaged in.
MerchantContains the merchant's setup information.
MerchantABANumberMerchant's routing number.
MerchantFCSIdIdentifies the merchant as an approved Food Stamp merchant.
MerchantSettlementAgentMerchant's settling agent.
ResponseContains the response to a debit authorization request.
TransactionAmountPurchase amount to be authorized.
TransactionNumberSequence number of this transaction.
TransactionTypeSpecifies the type of EBT transaction to process.
VoucherCodeRequired for Food Stamp Voucher transactions.
VoucherNumberRequired for Food Stamp Voucher transactions.

Method List

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

AuthorizeSends a Gift Card transaction.
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.
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.

AllowPartialAuthsIndicates whether partial authorizations are to be supported.
SurchargeAmountThe transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
AuthorizationIndicatorThe type of authorization request.
RetrySet this to retry a failed transaction.
IsPurchaseReturnAuthorizationSet this to process a Visa Purchase Return Authorization transaction.
SendExtendedAVSSpecifies whether to send extended AVS data.
ResponseStoreNumberCheck this field against the original Merchant StoreNumber.
ResponseTerminalNumberCheck this field against the original Merchant TerminalNumber.
ResponseCardholderVerificationVerification results for cardholder identification data (extended AVS).
PortThe port to which transactions are posted.
ServerThe server to which transactions are posted.
AuthenticationCodeAn alphanumeric code provided to the POS user for input when authenticating a POS device.
ActivateTerminalAuthenticates a POS device with TSYS.
DeactivateTerminalDeactivates a POS device with TSYS.
GenKeyA randomly generated string of alphanumeric characters identifying the terminal.
TsysETBThe Encryption Transmission Block TSYS uses to decrypt encrypted data.
UseConfirmationRequestIndicates whether or not to send a Confirmation Request authorization transaction.
LocalRetrievalNumberSpecifies the Retrieval Reference Number to use in a NonConfirm authorization request.
LocalDateSpecifies the local transaction date to use in a NonConfirm authorization request.
LocalTimeSpecifies the local transaction time to use in a NonConfirm authorization request.
ProcessorSpecifies the Processor you are connecting to.
HeartlandEncryptionModeSpecifies the encryption mode to use in Heartland transactions.
HeartlandDeviceIdSpecifies a device ID to uniquely identify each terminal (card data entry device).
HeartlandKeyBlockSpecifies the key block used to encrypt the data.
TimeoutA timeout for the component.
CodePageThe system code page used for Unicode to Multibyte translations.

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