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

TSYSHCBenefit Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DPaymentsSDK.Tsyshcbenefit

Remarks

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 TSYSHCBenefit 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 and POS specific properties with setup information acquired from your member bank or processor. For instance:


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

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.


  TSYSHCBenefit1.TransactionNumber = 1
  TSYSHCBenefit1.TransactionAmount = "1000"
  TSYSHCBenefit1.Card.EntryDataSource = edsTrack2
  TSYSHCBenefit1.CardMagneticStripe = "9999999800002773=09121015432112345678"
  TSYSHCBenefit1.CardPIN = "83C33384650827F6"
  TSYSHCBenefit1.CardKSN = "4A00310459400004"

The TSYSHCBenefit component supports both Food Stamp and Cash Benefit programs on the same card. Make sure to choose the correct PaymentType for the benefit program you wish to use, and then call the corresponding method of the transaction you wish to send. For example (to perform a purchase/authorization transaction):


  TSYSHCBenefit1.PaymentType = ptFoodStamp
  TSYSHCBenefit1.Sale()

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

Property List


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

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.
GenKeyThe unique GenKey value used to identify a POS device.
GratuityAmountThe gratuity (tip) amount of the transaction.
MerchantCategoryCodeClassifies a merchant by the type of store.
MerchantIdThe unique ID that associates the POS device with the merchant account.
PaymentTypeSpecifies the type of EBT transaction to process.
ResponseContains the response to an authorization request.
RoutingIdThe Routing ID assigned to the merchant by TSYS.
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.
TimeoutA timeout for the component.
TransactionAmountPurchase amount to be authorized.
TransactionDescSoft (Dynamic) Descriptor.
TransactionNumberSequence number of this transaction.
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.

BalanceInquiryRetrieves the current available balance of the debit card.
ConfigSets or retrieves a configuration setting .
CreditSends a credit request.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
SaleSends a sale/purchase request.
WithdrawSends a withdrawal request.

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.

TsysETBThe Encryption Transmission Block TSYS uses to decrypt encrypted data.
SurchargeAmountThe transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
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.
POSCardholderPresentCardholder present data to indicate the circumstances in which card data was entered at the POS.
POSCardPresentCard present data to indicate the circumstances in which card data was entered at the POS.
POSCardInputModeCard input mode to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthMethodCardholder authentication method to indicate the circumstances in which card data was entered at the POS.
POSAuthEntityThe authentication entity to indicate the circumstances in which card data was entered at the POS.
POSCardInputCapabilityCard input capability data to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthCapabilityCardholder authentication capability data to indicate the circumstances in which card data was entered at the POS.
POSCardCaptureCapabilityCard capture capability data to indicate the circumstances in which card data was entered at the POS.
POSOperatingEnvironmentOperating environment data to indicate the circumstances in which card data was entered at the POS.
POSCardOutputCapabilityCard output capability data to indicate the circumstances in which card data was entered at the POS.
POSTerminalOutputCapabilityTerminal output capability data to indicate the circumstances in which card data was entered at the POS.
POSPINCaptureCapabilityPIN capture capability data to indicate the circumstances in which card data was entered at the POS.
POSChipConditionCodeChip condition code to indicate the circumstances in which card data was entered at the POS.
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.
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.
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.
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.
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).
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.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
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.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
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]