The TSYSHEALTHCARE component is designed to be a simple interface for those wishing to add Healthcare Auto- Substantiation (IIAS) support without redesigning their entire payment system. This component is used to authorize FSA cards in a Retail environment, where the customer is purchasing products or services in person. Both full and partial authorizations are supported.
This component allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. 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 TSYSHealthCare component has the ability to authorize transactions for the Retail, Direct Marketing (including E-Commerce), and Grocery Store IndustryTypes. However, at this time TSYS is only allowing IIAS Auto-Substantiation transactions in the Retail environment.
The TSYSHealthCare component makes authorizing IIAS transactions 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 very similar to that of the TSYSRetail component. The basic steps are outlined below:
First, set the merchant properties with setup information acquired from your member bank or processor. For instance:
component.Merchant.BankId = "999995"; //(BIN number) component.Merchant.CategoryCode = "5999"; component.Merchant.Name = "test merchant"; component.Merchant.Number = "123456789012"; component.Merchant.City = "Beverly Hills"; component.Merchant.State = "CA"; component.Merchant.StoreNumber = "5999"; component.Merchant.TerminalNumber = "1515"; component.Merchant.Zip = "90210"; component.IndustryType = itRetail;
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.
component.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?"; component.Card.EntryDataSource = edsTrack1;
Next set the TransactionAmount, TotalMedicalAmount, and optionally any additional healthcare-related amounts. Up to three additional amounts may be included, but their sums cannot exceed the TotalMedicalAmount. The available amounts include: ClinicAmount, DentalAmount, PrescriptionAmount, and VisionAmount.
component.TransactionAmount = "10000"; // $100.00 component.TotalMedicalAmount = "10000"; // this cannot exceed the TransactionAmount component.PrescriptionAmount = "5000"; // $50.00
There are several additional properties in the TSYSHealthCare component that are specific to healthcare transactions. The PartialAuthorization property indicates whether you allow partial authorizations. If TotalMedicalAmount is less than the TransactionAmount, the transaction will likely be declined as FSA cards are to be used solely for medical expenses. Likewise, if the FSA card does not have enough of a balance to cover the total amount, the card may be declined. However, if you set PartialAuthorization to True the host may authorize the transaction for a lesser amount. In this case the Code will be "10" instead of "00", and the AuthorizedAmount will contain the amount that was actually authorized (this amount may or may not be equal to the TotalMedicalAmount). Note: if the cardholder does not have additional funds to cover the remainder of the TransactionAmount and wishes to cancel the transaction, you must use the TSYSReversal component to reverse the authorization and instantly release funds back to the cardholder.
The Visa Merchant Verification Value, or VisaMVV is needed for Visa transactions in order to qualify for the best interchange rate.
Finally, the Substantiated property is a MasterCard-specific property that indicates if the transaction has been substantiated in real-time. Meaning, it tells the host whether the merchant verified the purchased items against an Inventory Information Approval System (IIAS).
After all of these properties are set, simply call the Authorize method to authorize the transaction. 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 AVSResult 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 an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the 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.
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.|
|CardPresent||Indicates whether the current transaction is a card present transaction.|
|ClinicAmount||Total amount of Clinic or Other qualified medical items for Healthcare auto-substantiation.|
|CustomerAddress||The customer's billing address.|
|CustomerZip||Customer's zip code (or postal code if outside of the USA).|
|DentalAmount||Total amount of Dental items for Healthcare auto-substantiation.|
|IndustryType||Code which indicates the industry the merchant is engaged in.|
|Merchant||Contains the merchant's setup information.|
|PartialAuthorization||Indicates whether partial authorizations are to be supported for Health Care Auto-Substantiation transactions.|
|PrescriptionAmount||Total amount of Prescription/Rx items for Healthcare auto-substantiation.|
|Response||Contains the response to an authorization request.|
|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.|
|Substantiated||Identifies if the merchant verified the purchased items against an Inventory Information Approval System (IIAS).|
|Timeout||A timeout for the component.|
|TotalMedicalAmount||Sum total of all medical item amounts.|
|TransactionAmount||Purchase amount to be authorized.|
|TransactionNumber||Sequence number of this transaction.|
|VisaMVV||The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program.|
|VisionAmount||Total amount of Vision or Optical items for Healthcare auto-substantiation.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Authorize||Authorizes a healthcare transaction with IIAS data.|
|Config||Sets or retrieves a configuration setting .|
|GetDetailAggregate||Returns an aggregate containing details of this transaction, which is then used for settlement.|
|Interrupt||Interrupts the current action.|
|Reset||Clears all properties to their default values.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Connected||Fired immediately after a connection completes (or fails).|
|DataPacketIn||Fired when receiving a data packet from the transaction server.|
|DataPacketOut||Fired when sending a data packet to the transaction server.|
|Disconnected||Fired when a connection is closed.|
|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.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|IsPurchaseReturnAuthorization||Set this to process a Visa Purchase Return Authorization transaction.|
|IsMerchantInitiatedTransaction||Set this to process a Visa Merchant Initiated transaction.|
|MITTransactionId||Transaction Id associated with the original authorization of a Merchant Initiated Transaction.|
|MessageReasonCode||Code used to identify the Merchant Initiated Transactions for Visa.|
|POSEnvironmentIndicator||Provides additional information about the transaction.|
|IncrementalTransId||Transaction Id associated with authorization to increment.|
|IncrementalTransDate||Transaction Date associated with authorization to increment.|
|IncrementalTransTime||Transaction Time associated with authorization to increment.|
|IncrementalApprovalCode||Transaction Approval Code associated with authorization to increment.|
|IncrementalRetrievalNumber||Transaction Retrieval Number associated with authorization to increment.|
|CumulativeAmount||Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only).|
|ECI||Electronic Commerce Indicator.|
|Port||The port to which transactions are posted.|
|Server||The server to which transactions are posted.|
|GenKey||A randomly generated string of alphanumeric characters identifying the terminal.|
|POSDataCode||Specifies the condition of the POS device used at the time of the transaction.|
|AuthorizationIndicator||The type of authorization request.|
|ResponseTransactionIntegrityClass||A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class.|
|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).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|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 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.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|LogSSLPackets||Controls whether SSL packets are logged when using the internal security API.|
|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.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|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.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|UseBackgroundThread||Whether threads created by the component are background threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|