FDMSRcHealthCare Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcHealthCare class is an advanced tool used to authorize FSA/HSA cards for healthcare transactions in either a retail or e-commerce/moto environment. This class 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

FDMSRcHealthCare

Remarks

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

The FDMSRcHealthCare class 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 class 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:

• MerchantId
• MerchantTerminalNumber
• GroupId

The FDMSRegister class 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 class 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 properties with the customer's cardholder data. When the Credit Card's CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent in card-present retail transactions by filling the CustomerAddress and CustomerZip properties. For any other CardEntryDataSource , the CardMagneticStripe property should be filled. For Debit cards the merchant should set the IsDebit configuration setting to 'True' together with the EncryptedPIN and KSN values. healthcare.CardMagneticStripe = "4788250000028291=21121015432112345678" healthcare.CardEntryDataSource = 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 ResponseCode property 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 ResponseApprovalCode, ResponseAuthorizedAmount, ResponseText, ResponseAVSResult, ResponseCVVResult, 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 classs. Check the method list for applicable transaction types.

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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ApplicationId Property (FDMSRcHealthCare Class)

Identifies the merchant application to the Datawire System.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApplicationId();
int SetApplicationId(const char* lpszApplicationId);

Unicode (Windows)
LPWSTR GetApplicationId();
INT SetApplicationId(LPCWSTR lpszApplicationId);

char* dpaymentssdk_fdmsrchealthcare_getapplicationid(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setapplicationid(void* lpObj, const char* lpszApplicationId);

QString GetApplicationId();
int SetApplicationId(QString qsApplicationId);

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application Id identifies the application that has generated and is sending the transaction. This is a 15 character alphanumeric code that identifies each application and is provided by the Datawire Secure Transport Vendor Integration Team

This property may be validated along with the DatawireId as connection credentials.

The default value of this property is a value used for testing with Rapid Connect. You may be required to have a new ApplicationId assigned for the software you create with this class.

Data Type

String

CardType Property (FDMSRcHealthCare Class)

Type of credit card being used in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardType();
int SetCardType(int iCardType);

Unicode (Windows)
INT GetCardType();
INT SetCardType(INT iCardType);

CT_UNKNOWN(0), 
CT_VISA(1), 
CT_MASTER_CARD(2), 
CT_AMEX(3), 
CT_DISCOVER(4), 
CT_DINERS(5), 
CT_JCB(6), 
CT_VISA_ELECTRON(7), 
CT_MAESTRO(8), 
CT_LASER(10)

int dpaymentssdk_fdmsrchealthcare_getcardtype(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardtype(void* lpObj, int iCardType);

int GetCardType();
int SetCardType(int iCardType);

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (FDMSRcHealthCare Class)

Three digit security code on back of card (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardCVVData();
int SetCardCVVData(const char* lpszCardCVVData);

Unicode (Windows)
LPWSTR GetCardCVVData();
INT SetCardCVVData(LPCWSTR lpszCardCVVData);

char* dpaymentssdk_fdmsrchealthcare_getcardcvvdata(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (FDMSRcHealthCare Class)

Indicates the presence of the card verification value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Unicode (Windows)
INT GetCardCVVPresence();
INT SetCardCVVPresence(INT iCardCVVPresence);

CVP_NOT_PROVIDED(0), 
CVP_PROVIDED(1), 
CVP_ILLEGIBLE(2), 
CVP_NOT_ON_CARD(3)

int dpaymentssdk_fdmsrchealthcare_getcardcvvpresence(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (FDMSRcHealthCare Class)

This property contains a 1-character code identifying the source of the customer data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

Unicode (Windows)
INT GetCardEntryDataSource();
INT SetCardEntryDataSource(INT iCardEntryDataSource);

EDS_TRACK_1(0), 
EDS_TRACK_2(1), 
EDS_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
EDS_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
EDS_MANUAL_ENTRY_NO_CARD_READER(4), 
EDS_TRACK_1CONTACTLESS(5), 
EDS_TRACK_2CONTACTLESS(6), 
EDS_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
EDS_IVR(8), 
EDS_KIOSK(9)

int dpaymentssdk_fdmsrchealthcare_getcardentrydatasource(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (FDMSRcHealthCare Class)

Expiration month of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Unicode (Windows)
INT GetCardExpMonth();
INT SetCardExpMonth(INT iCardExpMonth);

int dpaymentssdk_fdmsrchealthcare_getcardexpmonth(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardexpmonth(void* lpObj, int iCardExpMonth);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (FDMSRcHealthCare Class)

Expiration year of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Unicode (Windows)
INT GetCardExpYear();
INT SetCardExpYear(INT iCardExpYear);

int dpaymentssdk_fdmsrchealthcare_getcardexpyear(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardexpyear(void* lpObj, int iCardExpYear);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (FDMSRcHealthCare Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardIsEncrypted();
int SetCardIsEncrypted(int bCardIsEncrypted);

Unicode (Windows)
BOOL GetCardIsEncrypted();
INT SetCardIsEncrypted(BOOL bCardIsEncrypted);

int dpaymentssdk_fdmsrchealthcare_getcardisencrypted(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

Default Value

FALSE

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (FDMSRcHealthCare Class)

Track data read off of the card's magnetic stripe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardMagneticStripe();
int SetCardMagneticStripe(const char* lpszCardMagneticStripe);

Unicode (Windows)
LPWSTR GetCardMagneticStripe();
INT SetCardMagneticStripe(LPCWSTR lpszCardMagneticStripe);

char* dpaymentssdk_fdmsrchealthcare_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (FDMSRcHealthCare Class)

Customer's credit card number for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardNumber();
int SetCardNumber(const char* lpszCardNumber);

Unicode (Windows)
LPWSTR GetCardNumber();
INT SetCardNumber(LPCWSTR lpszCardNumber);

char* dpaymentssdk_fdmsrchealthcare_getcardnumber(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcardnumber(void* lpObj, const char* lpszCardNumber);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

ClinicAmount Property (FDMSRcHealthCare Class)

Total amount of Clinic or Other qualified medical items/services for Healthcare auto-substantiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClinicAmount();
int SetClinicAmount(const char* lpszClinicAmount);

Unicode (Windows)
LPWSTR GetClinicAmount();
INT SetClinicAmount(LPCWSTR lpszClinicAmount);

char* dpaymentssdk_fdmsrchealthcare_getclinicamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setclinicamount(void* lpObj, const char* lpszClinicAmount);

QString GetClinicAmount();
int SetClinicAmount(QString qsClinicAmount);

Default Value

""

Remarks

The sum of all auto-substantiation items/services cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

CopayAmount Property (FDMSRcHealthCare Class)

Total amount of Co-Payments for Healthcare auto-substantiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCopayAmount();
int SetCopayAmount(const char* lpszCopayAmount);

Unicode (Windows)
LPWSTR GetCopayAmount();
INT SetCopayAmount(LPCWSTR lpszCopayAmount);

char* dpaymentssdk_fdmsrchealthcare_getcopayamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcopayamount(void* lpObj, const char* lpszCopayAmount);

QString GetCopayAmount();
int SetCopayAmount(QString qsCopayAmount);

Default Value

""

Remarks

The sum of all auto-substantiation co-payments cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

CustomerAddress Property (FDMSRcHealthCare Class)

The customer's billing address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAddress();
int SetCustomerAddress(const char* lpszCustomerAddress);

Unicode (Windows)
LPWSTR GetCustomerAddress();
INT SetCustomerAddress(LPCWSTR lpszCustomerAddress);

char* dpaymentssdk_fdmsrchealthcare_getcustomeraddress(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcustomeraddress(void* lpObj, const char* lpszCustomerAddress);

QString GetCustomerAddress();
int SetCustomerAddress(QString qsCustomerAddress);

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

The maximum length of this property is 30 characters.

If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

Data Type

String

CustomerZip Property (FDMSRcHealthCare Class)

Customer's zip code (or postal code if outside of the USA).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerZip();
int SetCustomerZip(const char* lpszCustomerZip);

Unicode (Windows)
LPWSTR GetCustomerZip();
INT SetCustomerZip(LPCWSTR lpszCustomerZip);

char* dpaymentssdk_fdmsrchealthcare_getcustomerzip(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setcustomerzip(void* lpObj, const char* lpszCustomerZip);

QString GetCustomerZip();
int SetCustomerZip(QString qsCustomerZip);

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

The maximum length of this property is 9 characters.

Data Type

String

DatawireId Property (FDMSRcHealthCare Class)

Identifies the merchant to the Datawire System.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDatawireId();
int SetDatawireId(const char* lpszDatawireId);

Unicode (Windows)
LPWSTR GetDatawireId();
INT SetDatawireId(LPCWSTR lpszDatawireId);

char* dpaymentssdk_fdmsrchealthcare_getdatawireid(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setdatawireid(void* lpObj, const char* lpszDatawireId);

QString GetDatawireId();
int SetDatawireId(QString qsDatawireId);

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister class). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Data Type

String

DentalAmount Property (FDMSRcHealthCare Class)

Total amount of Dental items/services for Healthcare auto-substantiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDentalAmount();
int SetDentalAmount(const char* lpszDentalAmount);

Unicode (Windows)
LPWSTR GetDentalAmount();
INT SetDentalAmount(LPCWSTR lpszDentalAmount);

char* dpaymentssdk_fdmsrchealthcare_getdentalamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setdentalamount(void* lpObj, const char* lpszDentalAmount);

QString GetDentalAmount();
int SetDentalAmount(QString qsDentalAmount);

Default Value

""

Remarks

The sum of all auto-substantiation items/services cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

EMVData Property (FDMSRcHealthCare Class)

The EMV Data returned from a Pin Pad after reading an EMV card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEMVData();
int SetEMVData(const char* lpszEMVData);

Unicode (Windows)
LPWSTR GetEMVData();
INT SetEMVData(LPCWSTR lpszEMVData);

char* dpaymentssdk_fdmsrchealthcare_getemvdata(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setemvdata(void* lpObj, const char* lpszEMVData);

QString GetEMVData();
int SetEMVData(QString qsEMVData);

Default Value

""

Remarks

This configuration setting takes the entire TLV (tag-length-value) response received from a Pin Pad after reading an EMV card. The class will send this data in an authorization request.

Retail EMV Example Fdmsrcretail fdmsrcretail = new Fdmsrcretail(); fdmsrcretail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; fdmsrcretail.TPPID = "AAA000"; fdmsrcretail.MerchantTerminalNumber = "00000001"; fdmsrcretail.MerchantId = "1234"; fdmsrcretail.GroupId = "20001"; fdmsrcretail.DatawireId = "00011122233344455566"; fdmsrcretail.VisaIdentifier = "01000000000000"; fdmsrcretail.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcretail.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcretail.STAN = "112"; fdmsrcretail.TransactionNumber = "120013"; fdmsrcretail.ReferenceNumber = "123456"; fdmsrcretail.OrderNumber = "12000503"; fdmsrcretail.Card.MagneticStripe = "4761739001010010=15122011143804489"; fdmsrcretail.Card.EntryDataSource = EntryDataSources.edsTrack2; fdmsrcretail.TransactionAmount = "250"; fdmsrcretail.EMVData = "9F4005F000F0A0019F...F7906123456789012"; fdmsrcretail.Sale();

Data Type

String

EncryptedPIN Property (FDMSRcHealthCare Class)

DUKPT DES encrypted pin block, retrieved from a PIN pad.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptedPIN();
int SetEncryptedPIN(const char* lpszEncryptedPIN);

Unicode (Windows)
LPWSTR GetEncryptedPIN();
INT SetEncryptedPIN(LPCWSTR lpszEncryptedPIN);

char* dpaymentssdk_fdmsrchealthcare_getencryptedpin(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setencryptedpin(void* lpObj, const char* lpszEncryptedPIN);

QString GetEncryptedPIN();
int SetEncryptedPIN(QString qsEncryptedPIN);

Default Value

""

Remarks

A 16-byte encrypted PIN and associated KSN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device.

This value is required for all transactions except Full Reversals.

Debit Sale Example debit.TPPID = "AAA000"; debit.MerchantTerminalNumber = "00000001"; debit.MerchantId = "1234"; debit.GroupId = "20001"; debit.DatawireId = "00011122233344455566"; debit.ApplicationId = "RAPIDCONNECTVXN"; debit.URL = "https://stg.dw.us.fdcnet.biz/rc"; debit.STAN = "112"; debit.TransactionNumber = "1234"; debit.ReferenceNumber = "1212"; debit.OrderNumber = "123"; debit.Card.MagneticStripe = "4003010001234572=17041011234567440"; debit.EncryptedPIN = "7BD8948B328B21E5"; debit.KSN = "876543210F008400029"; debit.TransactionAmount = "1200"; debit.Sale();

Data Type

String

GroupId Property (FDMSRcHealthCare Class)

The Id assigned by FDMS to identify the merchant or group of merchants.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupId();
int SetGroupId(const char* lpszGroupId);

Unicode (Windows)
LPWSTR GetGroupId();
INT SetGroupId(LPCWSTR lpszGroupId);

char* dpaymentssdk_fdmsrchealthcare_getgroupid(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setgroupid(void* lpObj, const char* lpszGroupId);

QString GetGroupId();
int SetGroupId(QString qsGroupId);

Default Value

""

Remarks

This property specifies the FDMS assigned group Id. This Id identifies the merchant or group of merchants. This property is required.

Data Type

String

IndustryType Property (FDMSRcHealthCare Class)

The merchant's industry type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

FHIT_RETAIL(0), 
FHIT_SUPERMARKET(1), 
FHIT_ECOMMERCE(2), 
FHIT_MOTO(3)

int dpaymentssdk_fdmsrchealthcare_getindustrytype(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Data Type

Integer

KSN Property (FDMSRcHealthCare Class)

Clear-text Key Sequence Number retrieved from a PIN pad.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKSN();
int SetKSN(const char* lpszKSN);

Unicode (Windows)
LPWSTR GetKSN();
INT SetKSN(LPCWSTR lpszKSN);

char* dpaymentssdk_fdmsrchealthcare_getksn(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setksn(void* lpObj, const char* lpszKSN);

QString GetKSN();
int SetKSN(QString qsKSN);

Default Value

""

Remarks

A 19 or 20-byte Key Sequence Number (KSN) and associated EncryptedPIN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device. A 20-byte Key Sequence Number consists of a 1-byte pad character ('F'), a 9-byte Base Derivation Key Id (BDK ID), a 5-byte device Id, and a 5-byte transaction counter. If this property is set with a Key Sequence Number less than 20 bytes in length, the class will pad it on the left with 'F' characters.

This value is required for all transactions except Full Reversals.

Debit Sale Example debit.TPPID = "AAA000"; debit.MerchantTerminalNumber = "00000001"; debit.MerchantId = "1234"; debit.GroupId = "20001"; debit.DatawireId = "00011122233344455566"; debit.ApplicationId = "RAPIDCONNECTVXN"; debit.URL = "https://stg.dw.us.fdcnet.biz/rc"; debit.STAN = "112"; debit.TransactionNumber = "1234"; debit.ReferenceNumber = "1212"; debit.OrderNumber = "123"; debit.Card.MagneticStripe = "4003010001234572=17041011234567440"; debit.EncryptedPIN = "7BD8948B328B21E5"; debit.KSN = "876543210F008400029"; debit.TransactionAmount = "1200"; debit.Sale();

Data Type

String

MerchantId Property (FDMSRcHealthCare Class)

A unique Id used to identify the merchant within the FDMS and Datawire systems.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantId();
int SetMerchantId(const char* lpszMerchantId);

Unicode (Windows)
LPWSTR GetMerchantId();
INT SetMerchantId(LPCWSTR lpszMerchantId);

char* dpaymentssdk_fdmsrchealthcare_getmerchantid(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setmerchantid(void* lpObj, const char* lpszMerchantId);

QString GetMerchantId();
int SetMerchantId(QString qsMerchantId);

Default Value

""

Remarks

This property holds the Merchant Id assigned by FDMS. The value is an alphanumeric value up to 16 characters in length.

This property is required.

Data Type

String

MerchantServicePhone Property (FDMSRcHealthCare Class)

The merchant's phone number, used to assist cardholders.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantServicePhone();
int SetMerchantServicePhone(const char* lpszMerchantServicePhone);

Unicode (Windows)
LPWSTR GetMerchantServicePhone();
INT SetMerchantServicePhone(LPCWSTR lpszMerchantServicePhone);

char* dpaymentssdk_fdmsrchealthcare_getmerchantservicephone(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);

QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);

Default Value

""

Remarks

This property specifies a 10 digit phone number which cardholders can call for assistance.

This value is required for MOTO transactions. It is recommended but not required for ecommerce and hotel transactions.

Data Type

String

MerchantTerminalNumber Property (FDMSRcHealthCare Class)

Used to identify a unique terminal within a merchant location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber);

Unicode (Windows)
LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);

char* dpaymentssdk_fdmsrchealthcare_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

Default Value

""

Remarks

This property contains a number assigned by FDMS to uniquely identify a terminal within a merchant location. The value is numeric and may be up to 8 digits in length.

This property is required.

Data Type

String

MerchantURL Property (FDMSRcHealthCare Class)

The URL of the site performing the ECommerce transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantURL();
int SetMerchantURL(const char* lpszMerchantURL);

Unicode (Windows)
LPWSTR GetMerchantURL();
INT SetMerchantURL(LPCWSTR lpszMerchantURL);

char* dpaymentssdk_fdmsrchealthcare_getmerchanturl(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setmerchanturl(void* lpObj, const char* lpszMerchantURL);

QString GetMerchantURL();
int SetMerchantURL(QString qsMerchantURL);

Default Value

""

Remarks

This property specifies the URL of the merchant's site. This value is required for ECommerce and Hotel AuthOnly, Sale, Capture, and Credit transactions.

For Visa and Discover transactions this value is limited to 13 characters. For all other card types this value is limited to 32 characters.

Data Type

String

OrderNumber Property (FDMSRcHealthCare Class)

A merchant assigned order number to uniquely reference the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrderNumber();
int SetOrderNumber(const char* lpszOrderNumber);

Unicode (Windows)
LPWSTR GetOrderNumber();
INT SetOrderNumber(LPCWSTR lpszOrderNumber);

char* dpaymentssdk_fdmsrchealthcare_getordernumber(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setordernumber(void* lpObj, const char* lpszOrderNumber);

QString GetOrderNumber();
int SetOrderNumber(QString qsOrderNumber);

Default Value

""

Remarks

This property holds a merchant assigned order number that uniquely identifies the transaction. This must hold a numeric value up to 8 digits in length. This value cannot be all zeros.

This value is required for ECommerce and MOTO transactions. This value is optional for Retail transactions.

Data Type

String

PrescriptionAmount Property (FDMSRcHealthCare Class)

Total amount of Prescription/Rx items for Healthcare auto-substantiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPrescriptionAmount();
int SetPrescriptionAmount(const char* lpszPrescriptionAmount);

Unicode (Windows)
LPWSTR GetPrescriptionAmount();
INT SetPrescriptionAmount(LPCWSTR lpszPrescriptionAmount);

char* dpaymentssdk_fdmsrchealthcare_getprescriptionamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setprescriptionamount(void* lpObj, const char* lpszPrescriptionAmount);

QString GetPrescriptionAmount();
int SetPrescriptionAmount(QString qsPrescriptionAmount);

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

ProxyAuthScheme Property (FDMSRcHealthCare Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dpaymentssdk_fdmsrchealthcare_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FDMSRcHealthCare Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dpaymentssdk_fdmsrchealthcare_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (FDMSRcHealthCare Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dpaymentssdk_fdmsrchealthcare_getproxypassword(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FDMSRcHealthCare Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dpaymentssdk_fdmsrchealthcare_getproxyport(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FDMSRcHealthCare Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dpaymentssdk_fdmsrchealthcare_getproxyserver(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FDMSRcHealthCare Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dpaymentssdk_fdmsrchealthcare_getproxyssl(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FDMSRcHealthCare Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dpaymentssdk_fdmsrchealthcare_getproxyuser(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ReferenceNumber Property (FDMSRcHealthCare Class)

A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceNumber();
int SetReferenceNumber(const char* lpszReferenceNumber);

Unicode (Windows)
LPWSTR GetReferenceNumber();
INT SetReferenceNumber(LPCWSTR lpszReferenceNumber);

char* dpaymentssdk_fdmsrchealthcare_getreferencenumber(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setreferencenumber(void* lpObj, const char* lpszReferenceNumber);

QString GetReferenceNumber();
int SetReferenceNumber(QString qsReferenceNumber);

Default Value

""

Remarks

This value is a merchant assigned 12 digit value. The value must be unique within a day for a given merchant id and terminal id. When performing a Capture or Reverse transaction this must be the same as the original transaction.

Data Type

String

ResponseApprovalCode Property (FDMSRcHealthCare Class)

The Approval Code returned from the server after a successful authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* dpaymentssdk_fdmsrchealthcare_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

The Approval Code returned from the server after a successful authorization.

This value holds the approval code returned by the authorizer. This value will contain up to 8 characters. Only alphanumeric characters and spaces will be returned.

This property is read-only and not available at design time.

Data Type

String

ResponseAuthorizedAmount Property (FDMSRcHealthCare Class)

The amount actually charged to the card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizedAmount();

Unicode (Windows)
LPWSTR GetResponseAuthorizedAmount();

char* dpaymentssdk_fdmsrchealthcare_getresponseauthorizedamount(void* lpObj);

QString GetResponseAuthorizedAmount();

Default Value

""

Remarks

The amount actually charged to the card.

This value holds the amount charged to the card. In the case of a partial authorization this will be different than the amount specified in TransactionAmount.

You must collect the remainder via another form of payment, or Reverse the authorization if the customer does not have an additional form of payment.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkId Property (FDMSRcHealthCare Class)

This property indicates the network Id as returned by the host, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizingNetworkId();

Unicode (Windows)
LPWSTR GetResponseAuthorizingNetworkId();

char* dpaymentssdk_fdmsrchealthcare_getresponseauthorizingnetworkid(void* lpObj);

QString GetResponseAuthorizingNetworkId();

Default Value

""

Remarks

This field indicates the network Id as returned by the host, if available.

This value is up to 3 alphanumeric characters.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkName Property (FDMSRcHealthCare Class)

This property indicates the authorizing network name as returned by the host, when available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizingNetworkName();

Unicode (Windows)
LPWSTR GetResponseAuthorizingNetworkName();

char* dpaymentssdk_fdmsrchealthcare_getresponseauthorizingnetworkname(void* lpObj);

QString GetResponseAuthorizingNetworkName();

Default Value

""

Remarks

This field indicates the authorizing network name as returned by the host, when available.

This property is read-only.

Data Type

String

ResponseAVSResult Property (FDMSRcHealthCare Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* dpaymentssdk_fdmsrchealthcare_getresponseavsresult(void* lpObj);

QString GetResponseAVSResult();

Default Value

""

Remarks

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. This property is populated if a value is present in the response. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. Possible AVS codes are listed in the table below.

Visa Card AVS Codes

MasterCard AVS Codes

Amex AVS Codes

Discover or JCB

This property is read-only.

Data Type

String

ResponseBalance Property (FDMSRcHealthCare Class)

Contains the remaining available balance left on the card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseBalance();

Unicode (Windows)
LPWSTR GetResponseBalance();

char* dpaymentssdk_fdmsrchealthcare_getresponsebalance(void* lpObj);

QString GetResponseBalance();

Default Value

""

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

This property is read-only and not available at design time.

Data Type

String

ResponseCardLevelResult Property (FDMSRcHealthCare Class)

This property is only applicable to Visa card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCardLevelResult();

Unicode (Windows)
LPWSTR GetResponseCardLevelResult();

char* dpaymentssdk_fdmsrchealthcare_getresponsecardlevelresult(void* lpObj);

QString GetResponseCardLevelResult();

Default Value

""

Remarks

This property is only applicable to Visa card. This property holds a two character value returned by Visa to designate the type of card product used to process the transaction.

This property is read-only and not available at design time.

Data Type

String

ResponseCode Property (FDMSRcHealthCare Class)

Contains the 3 digit response code indicating success or reason of failure.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* dpaymentssdk_fdmsrchealthcare_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

""

Remarks

Contains the 3 digit response code indicating success or reason of failure.

This property contains a 3 digit code indicating success or the reason of failure. A value of 000 indicates approval. For all other values please see the Response Codes section.

This property is read-only.

Data Type

String

ResponseCommercialCard Property (FDMSRcHealthCare Class)

Indicates whether the credit card charged is a corporate commercial card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseCommercialCard();

Unicode (Windows)
INT GetResponseCommercialCard();

RCCT_NOT_COMMERCIAL(0), 
RCCT_PURCHASE_CARD(1), 
RCCT_CORPORATE_CARD(2), 
RCCT_BUSINESS_CARD(3), 
RCCT_UNKNOWN(4)

int dpaymentssdk_fdmsrchealthcare_getresponsecommercialcard(void* lpObj);

int GetResponseCommercialCard();

Default Value

0

Remarks

Indicates whether the credit card charged is a corporate commercial card.

This is only applicable to Visa cards. Visa Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data when calling Capture when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Tax amounts should be included with the Level2 or Level3 data when calling Capture in order to receive the best interchange rate.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (FDMSRcHealthCare Class)

Contains the returned CVV result code (if CVV data was sent in the request).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVVResult();

Unicode (Windows)
LPWSTR GetResponseCVVResult();

char* dpaymentssdk_fdmsrchealthcare_getresponsecvvresult(void* lpObj);

QString GetResponseCVVResult();

Default Value

""

Remarks

Contains the returned CVV result code (if CVV data was sent in the request).

If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. This property is populated if a value is present in the response. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSRcHealthCare Class)

Contains an error code providing more details about the DatawireStatus received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDatawireReturnCode();

Unicode (Windows)
LPWSTR GetResponseDatawireReturnCode();

char* dpaymentssdk_fdmsrchealthcare_getresponsedatawirereturncode(void* lpObj);

QString GetResponseDatawireReturnCode();

Default Value

""

Remarks

Contains an error code providing more details about the ResponseDatawireStatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseApprovalCode contains the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (FDMSRcHealthCare Class)

Status of the communication with Datawire.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDatawireStatus();

Unicode (Windows)
LPWSTR GetResponseDatawireStatus();

char* dpaymentssdk_fdmsrchealthcare_getresponsedatawirestatus(void* lpObj);

QString GetResponseDatawireStatus();

Default Value

""

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseApprovalCode contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

ResponseEMVData Property (FDMSRcHealthCare Class)

Contains the EMV data returns in the response (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseEMVData();

Unicode (Windows)
LPWSTR GetResponseEMVData();

char* dpaymentssdk_fdmsrchealthcare_getresponseemvdata(void* lpObj);

QString GetResponseEMVData();

Default Value

""

Remarks

Contains the EMV data returns in the response (if any).

This property is only applicable to Retail and Debit transactions.

This property is read-only and not available at design time.

Data Type

String

ResponsePOSData Property (FDMSRcHealthCare Class)

This property holds transaction specific information returned by the issuer (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponsePOSData();

Unicode (Windows)
LPWSTR GetResponsePOSData();

char* dpaymentssdk_fdmsrchealthcare_getresponseposdata(void* lpObj);

QString GetResponsePOSData();

Default Value

""

Remarks

This property holds transaction specific information returned by the issuer (if any). This is only applicable to MasterCard, Discover, and AmEx card transactions.

This property is read-only and not available at design time.

Data Type

String

ResponseReturnedACI Property (FDMSRcHealthCare Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseReturnedACI();

Unicode (Windows)
LPWSTR GetResponseReturnedACI();

char* dpaymentssdk_fdmsrchealthcare_getresponsereturnedaci(void* lpObj);

QString GetResponseReturnedACI();

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI) for Visa transactions. This value provides information concerning the transaction's Customer Payment Service (CPS) qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value.

Possible returned ACI values are:

This property is read-only.

Data Type

String

ResponseRoutingIndicator Property (FDMSRcHealthCare Class)

Indicates whether the transaction was processed as Credit or Debit.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseRoutingIndicator();

Unicode (Windows)
LPWSTR GetResponseRoutingIndicator();

char* dpaymentssdk_fdmsrchealthcare_getresponseroutingindicator(void* lpObj);

QString GetResponseRoutingIndicator();

Default Value

""

Remarks

Indicates whether the transaction was processed as Credit or Debit. Possible values are:

This property is read-only.

Data Type

String

ResponseSettlementDate Property (FDMSRcHealthCare Class)

The date the transaction will be settled in the format MMDD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseSettlementDate();

Unicode (Windows)
LPWSTR GetResponseSettlementDate();

char* dpaymentssdk_fdmsrchealthcare_getresponsesettlementdate(void* lpObj);

QString GetResponseSettlementDate();

Default Value

""

Remarks

The date the transaction will be settled in the format MMDD.

This property is read-only.

Data Type

String

ResponseText Property (FDMSRcHealthCare Class)

This property may hold additional text which describes the reason for a decline, the property in error, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* dpaymentssdk_fdmsrchealthcare_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

This property may hold additional text which describes the reason for a decline, the field in error, etc. Applications should not be coded to the text in this property as it is subject to change.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (FDMSRcHealthCare Class)

The transaction date returned from the server in yyyyMMddHHmmss format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionDate();

Unicode (Windows)
LPWSTR GetResponseTransactionDate();

char* dpaymentssdk_fdmsrchealthcare_getresponsetransactiondate(void* lpObj);

QString GetResponseTransactionDate();

Default Value

""

Remarks

The transaction date returned from the server in yyyyMMddHHmmss format.

This 15 digit field contains the transaction date and time returned by the Rapid Connect system. This is not a local datetime, it is the time according the Rapid Connect system.

This property is read-only.

Data Type

String

ResponseTransactionId Property (FDMSRcHealthCare Class)

Card issuer's Transaction Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* dpaymentssdk_fdmsrchealthcare_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet data, American Express Transaction Id, or Discover Network Result Indicator (NRID). If returned in the response, this property should be printed on the receipt.

This property is read-only and not available at design time.

Data Type

String

ReversalTransactionType Property (FDMSRcHealthCare Class)

The type of transaction to reverse.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReversalTransactionType();
int SetReversalTransactionType(int iReversalTransactionType);

Unicode (Windows)
INT GetReversalTransactionType();
INT SetReversalTransactionType(INT iReversalTransactionType);

FRTT_AUTH_ONLY(0), 
FRTT_CAPTURE(1), 
FRTT_CREDIT(2), 
FRTT_SALE(3)

int dpaymentssdk_fdmsrchealthcare_getreversaltransactiontype(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setreversaltransactiontype(void* lpObj, int iReversalTransactionType);

int GetReversalTransactionType();
int SetReversalTransactionType(int iReversalTransactionType);

Default Value

0

Remarks

This property specifies the type of transaction to reverse. Possible values are:

Data Type

Integer

ReversalType Property (FDMSRcHealthCare Class)

The type of reversal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReversalType();
int SetReversalType(int iReversalType);

Unicode (Windows)
INT GetReversalType();
INT SetReversalType(INT iReversalType);

FRT_FULL_REVERSAL(0), 
FRT_TIMEOUT_REVERSAL(1), 
FRT_VOID_FOR_SUSPECTED_FRAUD(2)

int dpaymentssdk_fdmsrchealthcare_getreversaltype(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setreversaltype(void* lpObj, int iReversalType);

int GetReversalType();
int SetReversalType(int iReversalType);

Default Value

0

Remarks

This property specifies the type of reversal. Possible values are:

Timeout Reversals are applicable to the following transaction types:

• AuthOnly
• Capture
• Credit
• Sale

Full Reversals are applicable to the following transaction types:

• AuthOnly
• Sale

Data Type

Integer

SettlementMode Property (FDMSRcHealthCare Class)

Indicates whether the class uses Host Capture (0) or Terminal Capture (1) system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSettlementMode();
int SetSettlementMode(int iSettlementMode);

Unicode (Windows)
INT GetSettlementMode();
INT SetSettlementMode(INT iSettlementMode);

SMI_HOST_CAPTURE(0), 
SMI_TERMINAL_CAPTURE(1)

int dpaymentssdk_fdmsrchealthcare_getsettlementmode(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setsettlementmode(void* lpObj, int iSettlementMode);

int GetSettlementMode();
int SetSettlementMode(int iSettlementMode);

Default Value

0

Remarks

Possible values are:

Host-Capture means that you authorize your transactions using the AuthOnly or Sale methods, and you process refunds and capture outstanding authorizations with the Credit and Capture methods. FDMS Rapid Connect handles all batch management.

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging IndustryType, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types may be processed in Terminal Capture mode. However, Hotel/Lodging transactions MUST be authorized and settled in Terminal Capture mode. Attempting to authorize a Hotel/Lodging transaction with the Host Capture mode will cause the class fails with an error.

Data Type

Integer

SSLAcceptServerCertEncoded Property (FDMSRcHealthCare Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_fdmsrchealthcare_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsrchealthcare_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FDMSRcHealthCare Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_fdmsrchealthcare_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmsrchealthcare_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FDMSRcHealthCare Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_fdmsrchealthcare_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmsrchealthcare_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (FDMSRcHealthCare Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_fdmsrchealthcare_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FDMSRcHealthCare Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_fdmsrchealthcare_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FDMSRcHealthCare Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_fdmsrchealthcare_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (FDMSRcHealthCare Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_fdmsrchealthcare_getsslprovider(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (FDMSRcHealthCare Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dpaymentssdk_fdmsrchealthcare_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

STAN Property (FDMSRcHealthCare Class)

The merchant assigned System Trace Audit Number(STAN).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSTAN();
int SetSTAN(const char* lpszSTAN);

Unicode (Windows)
LPWSTR GetSTAN();
INT SetSTAN(LPCWSTR lpszSTAN);

char* dpaymentssdk_fdmsrchealthcare_getstan(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setstan(void* lpObj, const char* lpszSTAN);

QString GetSTAN();
int SetSTAN(QString qsSTAN);

Default Value

""

Remarks

This property represents a six digit number assigned by the merchant to uniquely reference the transaction. This number must be unique within a day per Merchant ID and Terminal ID.

Valid values are from 000001 to 999999 inclusive.

Data Type

String

Timeout Property (FDMSRcHealthCare Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_fdmsrchealthcare_gettimeout(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TotalMedicalAmount Property (FDMSRcHealthCare Class)

Sum total of all medical item amounts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalMedicalAmount();
int SetTotalMedicalAmount(const char* lpszTotalMedicalAmount);

Unicode (Windows)
LPWSTR GetTotalMedicalAmount();
INT SetTotalMedicalAmount(LPCWSTR lpszTotalMedicalAmount);

char* dpaymentssdk_fdmsrchealthcare_gettotalmedicalamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_settotalmedicalamount(void* lpObj, const char* lpszTotalMedicalAmount);

QString GetTotalMedicalAmount();
int SetTotalMedicalAmount(QString qsTotalMedicalAmount);

Default Value

""

Remarks

This property is required when submitting a Healthcare Auto-substantiation transaction, and should indicate the sum total of all VisionAmounts, PrescriptionAmounts, ClinicAmounts, CopayAmounts, and DentalAmounts, plus any additional healthcare-related charges that do not fall under those categories. The category-specific amounts are optional, but at the minimum the TotalMedicalAmount must be present for Healthcare auto-substantiation (it may be "0", but it may not be left blank). If other amounts are present, the TotalMedicalAmount must be greater than or equal to the total of all other amounts.

If the transaction is only for healthcare related costs, the TotalMedicalAmount should be equal to the TransactionAmount However, it is possible to authorize a transaction that includes non-healthcare items, where the TransactionAmount is higher than the TotalMedicalAmount. if the TotalMedicalAmount exceeds the TransactionAmount the class fails with an error.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

TPPID Property (FDMSRcHealthCare Class)

Third Party Processor Identifier assigned by FDMS.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTPPID();
int SetTPPID(const char* lpszTPPID);

Unicode (Windows)
LPWSTR GetTPPID();
INT SetTPPID(LPCWSTR lpszTPPID);

char* dpaymentssdk_fdmsrchealthcare_gettppid(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_settppid(void* lpObj, const char* lpszTPPID);

QString GetTPPID();
int SetTPPID(QString qsTPPID);

Default Value

""

Remarks

The Third Party Processor Identifier (TPPID. Also sometimes referred to as a "Vendor Id") is assigned by FDMS to each third party who is processing transactions. Each merchant will receive a TPPID from FDMS.

The default value is "" (empty string). This should be set to the FDMS assigned TPPID.

A VisaIdentifier is also required for Visa transactions.

Data Type

String

TransactionAmount Property (FDMSRcHealthCare Class)

The transaction amount to be authorized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount);

Unicode (Windows)
LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);

char* dpaymentssdk_fdmsrchealthcare_gettransactionamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_settransactionamount(void* lpObj, const char* lpszTransactionAmount);

QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);

Default Value

""

Remarks

This property contains the transaction amount to be authorized.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (FDMSRcHealthCare Class)

Uniquely identifies the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionNumber();
int SetTransactionNumber(const char* lpszTransactionNumber);

Unicode (Windows)
LPWSTR GetTransactionNumber();
INT SetTransactionNumber(LPCWSTR lpszTransactionNumber);

char* dpaymentssdk_fdmsrchealthcare_gettransactionnumber(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_settransactionnumber(void* lpObj, const char* lpszTransactionNumber);

QString GetTransactionNumber();
int SetTransactionNumber(QString qsTransactionNumber);

Default Value

""

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

For all classs except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, and nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

Data Type

String

URL Property (FDMSRcHealthCare Class)

Location of the Datawire server to which transactions are sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* dpaymentssdk_fdmsrchealthcare_geturl(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

Default Value

"https://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister class. Once you Register and Activate the merchant using the FDMSRegister class, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister class.

Data Type

String

VisaIdentifier Property (FDMSRcHealthCare Class)

Additional merchant identification field used when authorizing Visa transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVisaIdentifier();
int SetVisaIdentifier(const char* lpszVisaIdentifier);

Unicode (Windows)
LPWSTR GetVisaIdentifier();
INT SetVisaIdentifier(LPCWSTR lpszVisaIdentifier);

char* dpaymentssdk_fdmsrchealthcare_getvisaidentifier(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setvisaidentifier(void* lpObj, const char* lpszVisaIdentifier);

QString GetVisaIdentifier();
int SetVisaIdentifier(QString qsVisaIdentifier);

Default Value

""

Remarks

First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). Each Visa Agent Identifier in the chain is composed of the following pieces:

A VisaIdentifier (Agent Identification Service - AUAR) is required for Visa transactions. A VisaIdentifier value is assigned by Visa as part of their Trusted Agent Program (TAP). Therefore it is suggested that you contact your FDMS certification analyst as they should be able to provide you with further information and put you in contact with the required party at Visa. Unfortunately more specific information on this matter cannot be provided as we do not handle live customer data and thus are not required to register in this particular program. However below is some additional information in regards to the requirements of a Visa Identifier.

Any merchant that transmits, processes, or stores cardholder data on server(s) that you own, manage, or operate on behalf of your clients (who are other merchant account holders) must meet the PCI Data Security Standard and follow additional steps to register as a service provider. Applicable services commonly include webhosting, software as a service, or collecting payment on behalf of a client. Any company providing these services must register with Visa's Third Party Agent (TAP) program.

You can register for the Visa Third Party Agent Program at http://usa.visa.com/merchants/risk_management/third-party-registration.html

If you find that you are not required to register with this program you can send all spaces for the BID and all zeros for the AUAR for instance: " 000000000000"

Data Type

String

VisionAmount Property (FDMSRcHealthCare Class)

Total amount of Vision or Optical care items for Healthcare auto-substantiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVisionAmount();
int SetVisionAmount(const char* lpszVisionAmount);

Unicode (Windows)
LPWSTR GetVisionAmount();
INT SetVisionAmount(LPCWSTR lpszVisionAmount);

char* dpaymentssdk_fdmsrchealthcare_getvisionamount(void* lpObj);
int dpaymentssdk_fdmsrchealthcare_setvisionamount(void* lpObj, const char* lpszVisionAmount);

QString GetVisionAmount();
int SetVisionAmount(QString qsVisionAmount);

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

AuthOnly Method (FDMSRcHealthCare Class)

Performs an authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AuthOnly();

Unicode (Windows)
INT AuthOnly();

int dpaymentssdk_fdmsrchealthcare_authonly(void* lpObj);

int AuthOnly();

Remarks

This method performs an authorization request. This transaction places a hold on the funds. To capture the funds the Capture method must be called.

After calling this method call GetDetailAggregate to generate a detail aggregate. The detail aggregate should be saved for use with Capture or Reverse later.

When ready to Capture or Reverse the transaction call SetDetailAggregate to the previously stored detail aggregate before calling the method.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

Healthcare AuthOnly Example healthcare.TPPID = "AAA000"; healthcare.MerchantTerminalNumber = "00000001"; healthcare.MerchantId = "1234"; healthcare.GroupId = "20001"; healthcare.DatawireId = "00011122233344455566"; healthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; healthcare.ApplicationId = "RAPIDCONNECTSRS"; healthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitSupermarket; healthcare.STAN = "112"; healthcare.TransactionNumber = "1234"; healthcare.OrderNumber = "123"; healthcare.ReferenceNumber = "123"; healthcare.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^210410054321000000000000000 150 A"; healthcare.Card.EntryDataSource = EntryDataSources.edsTrack1; healthcare.TransactionAmount = "1500"; healthcare.TotalMedicalAmount = "1500"; healthcare.ClinicAmount = "1500"; healthcare.AuthOnly();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BalanceInquiry Method (FDMSRcHealthCare Class)

Performs a Balance Inquiry Request using the specified Card data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BalanceInquiry();

Unicode (Windows)
INT BalanceInquiry();

int dpaymentssdk_fdmsrchealthcare_balanceinquiry(void* lpObj);

int BalanceInquiry();

Remarks

This methods allows you to perform a Balance Inquiry Request using the specified Card data. The balance amount will be returned via ResponseBalance. Note that Balance Inquiries do not place a hold on a cardholder's funds and are not captured.

Note: This method is only applicable to swiped transactions.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Capture Method (FDMSRcHealthCare Class)

Captures a previously authorized transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Capture();

Unicode (Windows)
INT Capture();

int dpaymentssdk_fdmsrchealthcare_capture(void* lpObj);

int Capture();

Remarks

This method captures a previously authorized transaction. Before calling this method call SetDetailAggregate to specify the detail aggregate from the original AuthOnly transaction.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

FDMS Recommendations:

Vendors/Gateways, who systematically send all Capture transactions during their end of day processing or at a specific time for their entire chain, must configure/program their systems to send the Capture transactions for all locations or merchants varying times of day based on the MerchantId or MerchantTerminalNumber (whichever provides a more random value).

To assist with implementing this logic, FDMS Rapid Connect recommends sending the Capture transactions based on the MerchantTerminalNumber in each location. For example If the last digit of the MerchantTerminalNumber is 0, set the time for the Capture transactions to be sent as xx:00 (xx=hh:00=mm). The time for the MerchantTerminalNumber ending with 1 would be xx:05. The time for the MerchantTerminalNumber ending with 2 would be xx:10. All remaining MerchantTerminalNumbers would follow this same logic. This logic would be applied across the entire chain or merchant base, to ensure that all Captures for all merchants are not systematically sent to First Data at the same time. FDMS recommends that the software calculate the offset of time based on the MerchantId or MerchantTerminalNumber, and not rely on a user to specify the time as noted above.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

Healthcare AuthOnly and Capture Example fdmsrchealthcare.TPPID = "AAA000"; fdmsrchealthcare.MerchantTerminalNumber = "00000001"; fdmsrchealthcare.MerchantId = "1234"; fdmsrchealthcare.GroupId = "20001"; fdmsrchealthcare.DatawireId = "00011122233344455566"; fdmsrchealthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrchealthcare.ApplicationId = "RAPIDCONNECTSRS"; fdmsrchealthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitMOTO; fdmsrchealthcare.STAN = "112"; fdmsrchealthcare.TransactionNumber = "1234"; fdmsrchealthcare.OrderNumber = "123"; fdmsrchealthcare.ReferenceNumber = "123456"; fdmsrchealthcare.MerchantServicePhone = "1234567890"; fdmsrchealthcare.Card.Number = "4012000033330026"; fdmsrchealthcare.Card.ExpMonth = 4; fdmsrchealthcare.Card.ExpYear = 2020; fdmsrchealthcare.Card.EntryDataSource = EntryDataSources.edsManualEntryNoCardReader; fdmsrchealthcare.Card.CVVPresence = CCCVVPresences.cvpProvided; fdmsrchealthcare.Card.CVVData = "123"; fdmsrchealthcare.TransactionAmount = "1200"; fdmsrchealthcare.CopayAmount = "600"; fdmsrchealthcare.PrescriptionAmount = "600"; fdmsrchealthcare.TotalMedicalAmount = "1200"; fdmsrchealthcare.AuthOnly(); string aggregate = fdmsrchealthcare.GetDetailAggregate(); //Capture fdmsrchealthcare = new Fdmsrchealthcare(); fdmsrchealthcare.TPPID = "AAA000"; fdmsrchealthcare.MerchantTerminalNumber = "00000001"; fdmsrchealthcare.MerchantId = "1234"; fdmsrchealthcare.GroupId = "20001"; fdmsrchealthcare.DatawireId = "00011122233344455566"; fdmsrchealthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrchealthcare.ApplicationId = "RAPIDCONNECTSRS"; fdmsrchealthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitMOTO; fdmsrchealthcare.STAN = "113"; fdmsrchealthcare.TransactionNumber = "1235"; fdmsrchealthcare.SetDetailAggregate(aggregate); fdmsrchealthcare.Capture();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (FDMSRcHealthCare Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_fdmsrchealthcare_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Credit Method (FDMSRcHealthCare Class)

Submits a credit transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Credit();

Unicode (Windows)
INT Credit();

int dpaymentssdk_fdmsrchealthcare_credit(void* lpObj);

int Credit();

Remarks

This method credits funds to the card. This is not based on a previous transaction. This may be used to return funds to a card if a previous transaction has already been settled. To void or cancel a transaction before it has been settled call Reverse instead.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

Healthcare Credit Example healthcare.TPPID = "AAA000"; healthcare.MerchantTerminalNumber = "00000001"; healthcare.MerchantId = "1234"; healthcare.GroupId = "20001"; healthcare.DatawireId = "00011122233344455566"; healthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; healthcare.ApplicationId = "RAPIDCONNECTSRS"; healthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitEcommerce; healthcare.STAN = "112"; healthcare.TransactionNumber = "1234"; healthcare.OrderNumber = "123"; healthcare.ReferenceNumber = "123"; fdmsrchealthcare.MerchantURL = "4dpayments"; fdmsrchealthcare.Card.Number = "4264280001234559"; fdmsrchealthcare.Card.ExpMonth = 4; fdmsrchealthcare.Card.ExpYear = 2020; fdmsrchealthcare.Card.EntryDataSource = EntryDataSources.edsManualEntryNoCardReader; healthcare.TransactionAmount = "2000"; fdmsrchealthcare.ClinicAmount = "2000"; fdmsrchealthcare.DentalAmount = "2000"; fdmsrchealthcare.PrescriptionAmount = "2000"; fdmsrchealthcare.TotalMedicalAmount = "2000"; fdmsrchealthcare.Credit(); ;

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetDetailAggregate Method (FDMSRcHealthCare Class)

Returns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDetailAggregate();

Unicode (Windows)
LPWSTR GetDetailAggregate();

char* dpaymentssdk_fdmsrchealthcare_getdetailaggregate(void* lpObj);

QString GetDetailAggregate();

Remarks

This method will return a detail aggregate representing the transaction. After calling AuthOnly or Sale call this method to obtain a detail aggregate. The aggregate will be required when calling Capture or Reverse.

When using Terminal Capture Settlement Mode this aggregate must be passed to the FDMSRcSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSRcDetailrecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

To set the aggregate before calling Capture Reverse or SendSettlement call SetDetailAggregate. Save this aggregate in a secure location.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (FDMSRcHealthCare Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_fdmsrchealthcare_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts any processing that the class is currently executing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FDMSRcHealthCare Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmsrchealthcare_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reverse Method (FDMSRcHealthCare Class)

Reverses a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reverse();

Unicode (Windows)
INT Reverse();

int dpaymentssdk_fdmsrchealthcare_reverse(void* lpObj);

int Reverse();

Remarks

This method reverses a transaction that has not been settled.

To void/reverse a Sale or AuthOnly transaction first set ReversalTransactionType to specify the type of original transaction that is being reversed. Next set ReversalType to frtFullReversal and call this method.

If the previous transaction did not receive a response and the state of the transaction is uncertain you may perform a Timeout Reversal. To perform a timeout reversal set ReversalTransactionType to specify the type of original transaction that is being reversed. Next set ReversalType to frtTimeoutReversal and call this method.

Timeout Reversals are applicable to the following transaction types:

• AuthOnly
• Capture
• Credit
• Sale

Full Reversals are applicable to the following transaction types:

• AuthOnly
• Sale

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

Healthcare Sale and Reverse Example healthcare.TPPID = "AAA000"; healthcare.MerchantTerminalNumber = "00000001"; healthcare.MerchantId = "1234"; healthcare.GroupId = "20001"; healthcare.DatawireId = "00011122233344455566"; healthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; healthcare.ApplicationId = "RAPIDCONNECTSRS"; healthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitRetail; healthcare.STAN = "112"; healthcare.TransactionNumber = "1234"; healthcare.OrderNumber = "123"; healthcare.ReferenceNumber = "123"; healthcare.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^210410054321000000000000000 150 A"; healthcare.Card.EntryDataSource = EntryDataSources.edsTrack1; healthcare.TransactionAmount = "1200"; healthcare.TotalMedicalAmount = "1200"; healthcare.PrescriptionAmount = "1200"; healthcare.Sale(); string aggregate = healthcare.GetDetailAggregate(); //Reverse healthcare = new Fdmsrchealthcare(); healthcare.TPPID = "AAA000"; healthcare.MerchantTerminalNumber = "00000001"; healthcare.MerchantId = "1234"; healthcare.GroupId = "20001"; healthcare.DatawireId = "00011122233344455566"; healthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; healthcare.ApplicationId = "RAPIDCONNECTSRS"; healthcare.STAN = "113"; healthcare.TransactionNumber = "1235"; healthcare.SetDetailAggregate(aggregate); healthcare.ReversalTransactionType = FdmsrchealthcareReversalTransactionTypes.frttSale; healthcare.ReversalType = FdmsrchealthcareReversalTypes.frtFullReversal; healthcare.Reverse();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sale Method (FDMSRcHealthCare Class)

Performs a sale transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sale();

Unicode (Windows)
INT Sale();

int dpaymentssdk_fdmsrchealthcare_sale(void* lpObj);

int Sale();

Remarks

This method performs a sale transaction. Once a sale is performed no further action is needed, the funds will automatically be captured by FDMS.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

Healthcare Sale Example healthcare.TPPID = "AAA000"; healthcare.MerchantTerminalNumber = "00000001"; healthcare.MerchantId = "1234"; healthcare.GroupId = "20001"; healthcare.DatawireId = "00011122233344455566"; healthcare.URL = "https://stg.dw.us.fdcnet.biz/rc"; healthcare.ApplicationId = "RAPIDCONNECTSRS"; healthcare.IndustryType = FdmsrchealthcareIndustryTypes.fhitRetail; healthcare.STAN = "112"; healthcare.TransactionNumber = "1234"; healthcare.OrderNumber = "123"; healthcare.ReferenceNumber = "123"; healthcare.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^210410054321000000000000000 150 A"; healthcare.Card.EntryDataSource = EntryDataSources.edsTrack1; healthcare.TransactionAmount = "1200"; healthcare.TotalMedicalAmount = "1200"; healthcare.VisionAmount = "1200"; healthcare.Sale();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetDetailAggregate Method (FDMSRcHealthCare Class)

Specifies the detail aggregate before calling Capture or Reverse.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDetailAggregate(const char* lpszaggregate);

Unicode (Windows)
INT SetDetailAggregate(LPCWSTR lpszaggregate);

int dpaymentssdk_fdmsrchealthcare_setdetailaggregate(void* lpObj, const char* lpszaggregate);

int SetDetailAggregate(const QString& qsaggregate);

Remarks

This method specifies the detail aggregate from the original AuthOnly or Sale transaction. This must be set before calling Capture or Reverse.

The aggregate specified here should have been obtained from the GetDetailAggregate method after the original AuthOnly or Sale transaction.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (FDMSRcHealthCare Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(FDMSRcHealthCareConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} FDMSRcHealthCareConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(FDMSRcHealthCareConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FDMSRcHealthCareConnectedEventParams;

#define EID_FDMSRCHEALTHCARE_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class FDMSRcHealthCareConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(FDMSRcHealthCareConnectedEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireConnected(FDMSRcHealthCareConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSRcHealthCare Class)

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketIn(FDMSRcHealthCareDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} FDMSRcHealthCareDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(FDMSRcHealthCareDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} FDMSRcHealthCareDataPacketInEventParams;

#define EID_FDMSRCHEALTHCARE_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class FDMSRcHealthCareDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(FDMSRcHealthCareDataPacketInEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireDataPacketIn(FDMSRcHealthCareDataPacketInEventParams *e) {...}

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (FDMSRcHealthCare Class)

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketOut(FDMSRcHealthCareDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} FDMSRcHealthCareDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(FDMSRcHealthCareDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} FDMSRcHealthCareDataPacketOutEventParams;

#define EID_FDMSRCHEALTHCARE_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class FDMSRcHealthCareDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(FDMSRcHealthCareDataPacketOutEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireDataPacketOut(FDMSRcHealthCareDataPacketOutEventParams *e) {...}

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (FDMSRcHealthCare Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(FDMSRcHealthCareDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} FDMSRcHealthCareDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(FDMSRcHealthCareDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FDMSRcHealthCareDisconnectedEventParams;

#define EID_FDMSRCHEALTHCARE_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class FDMSRcHealthCareDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(FDMSRcHealthCareDisconnectedEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireDisconnected(FDMSRcHealthCareDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (FDMSRcHealthCare Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(FDMSRcHealthCareErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FDMSRcHealthCareErrorEventParams;


Unicode (Windows)
virtual INT FireError(FDMSRcHealthCareErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FDMSRcHealthCareErrorEventParams;

#define EID_FDMSRCHEALTHCARE_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FDMSRcHealthCareErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FDMSRcHealthCareErrorEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireError(FDMSRcHealthCareErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (FDMSRcHealthCare Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FDMSRcHealthCareSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FDMSRcHealthCareSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FDMSRcHealthCareSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FDMSRcHealthCareSSLServerAuthenticationEventParams;

#define EID_FDMSRCHEALTHCARE_SSLSERVERAUTHENTICATION 6

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FDMSRcHealthCareSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FDMSRcHealthCareSSLServerAuthenticationEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireSSLServerAuthentication(FDMSRcHealthCareSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FDMSRcHealthCare Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(FDMSRcHealthCareSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FDMSRcHealthCareSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FDMSRcHealthCareSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FDMSRcHealthCareSSLStatusEventParams;

#define EID_FDMSRCHEALTHCARE_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class FDMSRcHealthCareSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FDMSRcHealthCareSSLStatusEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireSSLStatus(FDMSRcHealthCareSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (FDMSRcHealthCare Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(FDMSRcHealthCareStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FDMSRcHealthCareStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(FDMSRcHealthCareStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FDMSRcHealthCareStatusEventParams;

#define EID_FDMSRCHEALTHCARE_STATUS 8

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

class FDMSRcHealthCareStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(FDMSRcHealthCareStatusEventParams *e);

// Or, subclass FDMSRcHealthCare and override this emitter function.
virtual int FireStatus(FDMSRcHealthCareStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (FDMSRcHealthCare Class)

FDMSRcHealthCare Config Settings