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
nsoftware.InPayDirect.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.
Card | Contains the customer's credit card information. |
CashBackAmount | Amount returned to the customer in cash. |
DebitKSN | Clear-text Key Sequence Number, used for Debit and EBT transactions. |
DebitPIN | DUKPT DES encrypted PIN block, used for Debit and EBT transactions. |
GenKey | The unique GenKey value used to identify a POS device. |
GratuityAmount | The gratuity (tip) amount of the transaction. |
MerchantCategoryCode | Classifies a merchant by the type of store. |
MerchantId | The unique ID that associates the POS device with the merchant account. |
PaymentType | Specifies the type of EBT transaction to process. |
Response | Contains the response to an authorization request. |
RoutingId | The Routing ID assigned to the merchant by TSYS. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | A timeout for the component. |
TransactionAmount | Purchase amount to be authorized. |
TransactionDesc | Soft (Dynamic) Descriptor. |
TransactionNumber | Sequence number of this transaction. |
VoucherCode | Required for Food Stamp Voucher transactions. |
VoucherNumber | Required 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.
BalanceInquiry | Retrieves the current available balance of the debit card. |
Config | Sets or retrieves a configuration setting . |
Credit | Sends a credit request. |
Interrupt | Interrupts the current action. |
Reset | Clears all properties to their default values. |
Sale | Sends a sale/purchase request. |
Withdraw | Sends 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.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows 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.
TsysETB | The Encryption Transmission Block TSYS uses to decrypt encrypted data. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
RawRequest | Returns the request sent to the server for debugging purposes. |
RawResponse | Returns the response received from the server for debugging purposes. |
ServerURL | The server to which transactions are posted. |
Language | Indicates the language to be used in formatting the authorization response text message. |
POSCardholderPresent | Cardholder present data to indicate the circumstances in which card data was entered at the POS. |
POSCardPresent | Card present data to indicate the circumstances in which card data was entered at the POS. |
POSCardInputMode | Card input mode to indicate the circumstances in which card data was entered at the POS. |
POSCardholderAuthMethod | Cardholder authentication method to indicate the circumstances in which card data was entered at the POS. |
POSAuthEntity | The authentication entity to indicate the circumstances in which card data was entered at the POS. |
POSCardInputCapability | Card input capability data to indicate the circumstances in which card data was entered at the POS. |
POSCardholderAuthCapability | Cardholder authentication capability data to indicate the circumstances in which card data was entered at the POS. |
POSCardCaptureCapability | Card capture capability data to indicate the circumstances in which card data was entered at the POS. |
POSOperatingEnvironment | Operating environment data to indicate the circumstances in which card data was entered at the POS. |
POSCardOutputCapability | Card output capability data to indicate the circumstances in which card data was entered at the POS. |
POSTerminalOutputCapability | Terminal output capability data to indicate the circumstances in which card data was entered at the POS. |
POSPINCaptureCapability | PIN capture capability data to indicate the circumstances in which card data was entered at the POS. |
POSChipConditionCode | Chip condition code to indicate the circumstances in which card data was entered at the POS. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |