4D Payments SDK 2016 .NET Edition

Questions / Feedback?

FDMSRcHealthCare Component

Properties   Methods   Events   Configuration Settings   Errors  

The FDMSRcHealthCare component is an advanced tool used to authorize FSA/HSA cards for healthcare transactions in either a retail or e-commerce/moto environment. This component makes authorizing these types of transactions very easy. Supported Industry Types include retail stores, direct marketing (e-commerce and mail order/phone order) and grocery or food stores.

Syntax

DPayments.DPaymentsSDK.Fdmsrchealthcare

Remarks

This component connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these components go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the component. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated SSL servers.

The FDMSRcHealthCare component makes authorizing healthcare and FSA/HSA card 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 outlined below:

Datawire Setup

First, you must register and activate your account with Datawire. FDMS Rapid Connect will provide you with the following values:

The FDMSRegister component must be used to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through ServiceDiscovery, you may begin to authorize transactions. For instance:


FDMSRegister.FDMSPlatform = FdmsregisterFDMSPlatforms.fpRapidConnect;
FDMSRegister.MerchantNumber = "000000999990";
FDMSRegister.MerchantTerminalNumber = "555555";
FDMSRegister.Config("GroupId=20001"); //Required for Rapid Connect

FDMSRegister.TransactionNumber = "1"; //any unique number will do.
FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do";
FDMSRegister.Register(); 
FDMSRegister.TransactionNumber = FDMSRegister.TransactionNumber + 1;
FDMSRegister.Activate();
FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL);
for (int i = 0; i < FDMSRegister.ServiceProviders.Length; i++) {
  FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]);
  Console.WriteLine(FDMSRegister.ServiceProviders[i] + " = " + FDMSRegister.PingResponseTime);
}

To authorize a credit, debit, ebt or FSA/HSA card set the MerchantId, MerchantTerminalNumber, and GroupId properties with the values supplied by FDMS Rapid Connect. Set the DatawireId property with the value retrieved by the FDMSRegister component after activating your merchant account. Set the URL property with one of the URLs you retrieved during ServiceDiscovery.

Transaction Processing

To begin processing transactions first set the required merchant values. For instance:

healthcare.TPPID = "AAA000";
healthcare.MerchantId = "1234";
healthcare.MerchantTerminalNumber = "00000001";
healthcare.GroupId = "20001";
healthcare.DatawireId = "00011122233344455566";
healthcare.URL = "https://stg.dw.us.fdcnet.biz/rc";
healthcare.ApplicationId = "RAPIDCONNECTSRS";

Next specify transaction specific information. These values uniquely identify the transaction to Datawire and FDMS.

healthcare.STAN = "112";
healthcare.TransactionNumber = "1234";
healthcare.OrderNumber = "123";
healthcare.ReferenceNumber = "123";

Then set the Card fields with the customer's cardholder data. When the Credit Card's EntryDataSource is Manually Entered, the merchant should fill the Number, ExpMonth, and ExpYear fields. Address Verification Service (AVS) data may be sent in card-present retail transactions by filling the CustomerAddress and CustomerZip properties. For any other EntryDataSource , the MagneticStripe field should be filled. For Debit cards the merchant should set the IsDebit configuration setting to 'True' together with the EncryptedPIN and KSN values.

healthcare.Card.MagneticStripe = "4788250000028291=21121015432112345678";
healthcare.Card.EntryDataSource = edsTrack2;

To perform healthcare transactions you need to set the healthcare-specific properties. At minimum, you should send the TotalMedicalAmount. If TotalMedicalAmount is left empty the component will send a regular (non-healthcare) transaction. In addition to TotalMedicalAmount, you may also set up to five optional amounts such as PrescriptionAmount, ClinicAmount, VisionAmount, CopayAmount and/or DentalAmount properties with the dollar amount of each within this transaction Please note that the TotalMedicalAmount need not equal the TransactionAmount, but it CANNOT be greater than the TransactionAmount. All amounts are set with an implied decimal point (ie: $1.00 is "100"). The IndustryType should also be set at this time, as it will indicate whether this transaction is made for a Retail store, e-commerce, or a grocery store.


healthcare.TransactionAmount = "2500";
healthcare.TotalMedicalAmount = "2500";
healthcare.PrescriptionAmount = "2500";
healthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitRetail;

Finally, submit the transaction via the Sale or Authorize method.


FDMSRcHealthCare.Sale()

The Code field indicates the result of the transaction. A code of 000 indicates success. For all other values please see the Response Codes section. Additional Response properties such as ApprovalCode, AuthorizedAmount, Text, AVSResult, CVVResult, and more, provide further details about the transaction response.

To perform subsequent operations on a transaction, such as calling Reverse to reverse a Sale, or calling Capture to capture a previous AuthOnly transaction the GetDetailAggregate method must be used to get details about the original transaction. This aggregate must be stored securely, it will contain cardholder information that is required for subsequent transactions. For instance:


FDMSRcHealthCare.AuthOnly();

//Save the detail aggregate to use with Capture
string aggregate = FDMSRcHealthCare.GetDetailAggregate();

//The aggregate must then be stored securely.
//At a later time the aggregate is retrieved in order to perform a capture.

//Capture
FDMSRcHealthCare = new Fdmsrchealthcare();
...

//Specify the detail aggregate from the original transaction
FDMSRcHealthCare.SetDetailAggregate(aggregate);

FDMSRcHealthCare.Capture();

Transaction Types

In addition to a basic sale transaction, additional transaction types exist for other common operations. Not all transaction types are applicable for all components. Check the method list for applicable transaction types.

AuthOnly An authorization that must be Captured later.
BalanceInquiry Inquire about available balance.
Capture Captures a previous AuthOnly transaction for settlement.
Credit Credits funds to the cardholder. This is not based on a previous transaction.
Reverse Reverse a previous transaction. This is also used for timeout reversals.
Sale A basic sale, no other steps are required to complete the payment.
VerifyCard Verifies that a card is valid.
HostTotals Requests a Host Totals Report for a particular day.
VoucherClear Performs an online force-post entry of a voice-authorized Food Benefit or eWIC transaction.

Note: FDMS Rapid Connect is a host capture system. No explicit calls are needed to settle or otherwise manage the batch.

Property List


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

ApplicationIdIdentifies the merchant application to the Datawire System.
CardContains the customer's credit card information.
ClinicAmountTotal amount of Clinic or Other qualified medical items/services for Healthcare auto-substantiation.
CopayAmountTotal amount of Co-Payments for Healthcare auto-substantiation.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
DatawireIdIdentifies the merchant to the Datawire System.
DentalAmountTotal amount of Dental items/services for Healthcare auto-substantiation.
EMVDataThe EMV Data returned from a Pin Pad after reading an EMV card.
EncryptedPINDUKPT DES encrypted pin block, retrieved from a PIN pad.
GroupIdThe Id assigned by FDMS to identify the merchant or group of merchants.
IndustryTypeThe merchant's industry type.
KSNClear-text Key Sequence Number retrieved from a PIN pad.
MerchantIdA unique Id used to identify the merchant within the FDMS and Datawire systems.
MerchantServicePhoneThe merchant's phone number, used to assist cardholders.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
MerchantURLThe URL of the site performing the ECommerce transaction.
OrderNumberA merchant assigned order number to uniquely reference the transaction.
PrescriptionAmountTotal amount of Prescription/Rx items for Healthcare auto-substantiation.
ProxyA set of properties related to proxy access.
ReferenceNumberA value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.
ResponseContains the response to an authorization request.
ReversalTransactionTypeThe type of transaction to reverse.
ReversalTypeThe type of reversal.
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.
STANThe merchant assigned System Trace Audit Number(STAN).
TimeoutA timeout for the component.
TotalMedicalAmountSum total of all medical item amounts.
TPPIDThird Party Processor Identifier assigned by FDMS.
TransactionAmountThe transaction amount to be authorized.
TransactionNumberUniquely identifies the transaction.
URLLocation of the Datawire server to which transactions are sent.
VisaIdentifierAdditional merchant identification field used when authorizing Visa transactions.
VisionAmountTotal amount of Vision or Optical care items for Healthcare auto-substantiation.

Method List


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

AuthOnlyPerforms an authorization request.
BalanceInquiryPerforms a Balance Inquiry Request using the specified Card data.
CaptureCaptures a previously authorized transaction.
ConfigSets or retrieves a configuration setting.
CreditSubmits a credit transaction.
GetDetailAggregateReturns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
ReverseReverses a transaction.
SalePerforms a sale transaction.
SetDetailAggregateSpecifies the detail aggregate before calling Capture or Reverse.

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.
StatusShows the progress of the FDMS/Datawire 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 supported.
AltMerchantAddressThe alternative merchant address.
AltMerchantCityThe alternative merchant city.
AltMerchantCountryCodeThe alternative merchant country code.
AltMerchantNameThe alternative merchant name.
AltMerchantStateThe alternative merchant state.
AltMerchantZipThe alternative merchant zip code.
AuthorizationIndicatorIndicates whether the authorization is a final authorization.
AuthSourceIndicates the source of the decision for the Visa transaction.
BillPaymentTypeSpecifies the type of Bill Payment being made.
CardInputModeThe method used to input the card details.
CardTypeSpecifies the type of card.
ClientTimeoutIndicates timeout client application will wait for response.
CurrencyCodeCurrency Code for this transaction.
DebugTraceWhether to enable debug logging.
DeviceTypeIndicatorDefines the form factor used at the POS for MasterCard PayPass transactions.
ECIIdentifies the security level of the ECommerce transaction.
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
GetTransArmorTokenAllows you to retrieve a TransArmor Token for a specified card.
HostTotalsPasswordThe merchant password required in Host Totals requests.
HostTotalsTypeIndicates the Host Totals Report type requested.
IsDebitIndicates that the transaction is a FSA/HSA Debit transaction.
IsOnlineRefundIndicates whether a transaction is Online Refund Authorization.
LocalTransactionDateThe local date of the transaction.
MerchantCategoryCodeThe 4 digit Merchant Category Code (MCC).
POSConditionCodeThe POS condition code.
POSIdIdentifies the specific point of sale device.
SupportPINLessDebitIndicates whether the terminal can support swiped PINLess Debit transactions.
TerminalCardCapabilityThe terminal's card capture capability.
TerminalEntryCapabilityThe terminal's entry mode capability.
TerminalLocationIndicatorThe terminal's location.
TerminalPinCapabilityThe terminal's PIN capability.
TerminalTaxCapabilityThe terminal's ability to prompt for tax.
TransArmorKeySpecifies the TransArmor key used to perform the encryption.
TransArmorKeyIdSpecifies the Id of the TransArmor key used to perform the encryption.
TransArmorModeSpecifies the TransArmor Security Level to use.
TransArmorProviderIdThe Id of the Provider that issued a TransArmorToken.
TransArmorTokenA TransArmor Token used in place of a card number or magnetic stripe data.
TransArmorTokenTypeThe FDMS assigned token type.
TransArmorTokenTypeSpecifies the type of TransArmor token that will be used.
TransArmorUpdateIndicatorIndicates whether your TransArmorKey needs to be updated.
UpdateTransArmorKeyAllows you to update your TransArmor Key.
UTCTransactionDateThe UTC date of the transaction.
VoiceApprovalCodeThe voice approval.
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.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
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.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
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.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
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.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
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.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
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.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
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.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

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