FDMSRetail Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRetail class is an advanced tool used to authorize credit cards in a Retail environment, where the customer is purchasing products or services in person. This class makes authorizing these types of transactions very easy. Supported Industry Types include retail stores, restaurants, and grocery or food stores.

Syntax

FDMSRetail

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 FDMSRetail class makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) 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:

First, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSRegister class to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId 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 Service Discovery.

FDMSRetail.MerchantNumber = "000000999990" 'Supplied by FDMS/Datawire FDMSRetail.MerchantTerminalNumber = "555555" 'Supplied by FDMS/Datawire FDMSRetail.DatawireId = "0000B47FFFFFFFFFFFFF" 'Retrieved with the FDMSRegister class. FDMSSettle.URL = "https://staging1.datawire.net/sd/"; 'Retrieved with the FDMSRegister class.

Next, set properties that contain details about the transaction. The TransactionNumber should be incremented for every transaction you authorize. The TransactionAmount must be set, and it should contain the amount to be charged, with an implied decimal point (ie: $1.00 is "100"). The IndustryType will indicate whether the transaction is made for a Retail store, a restaurant, or a grocery store.

FDMSRetail.TransactionNumber = 1 FDMSRetail.TransactionAmount = "100" FDMSRetail.IndustryType = itRetail

Now, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing track1, and for these cards you may use track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with track1 data.

FDMSRetail.CardMagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?" FDMSRetail.CardEntryDataSource = edsTrack1

Finally, submit the transaction by calling the Authorize method.

When the class receives a response, the result of the authorization will be available in several Response properties. The ResponseDatawireStatus and ResponseDatawireReturnCode indicate whether any errors occurred while passing the transaction through the Datawire VXN system. These two properties alone do not indicate a successful transaction, they only tell whether or not there were any problems transporting the authorization request and response through the Datawire system. If the transaction was successfully authorized by FDMS, then the ResponseCaptureFlag will be True, and the ResponseApprovalCode will contain an approval code that beings with "AP". (or "AL" for classs that support partially-approved/split-tender transactions). The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the FDMSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

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 (FDMSRetail 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_fdmsretail_getapplicationid(void* lpObj);
int dpaymentssdk_fdmsretail_setapplicationid(void* lpObj, const char* lpszApplicationId);

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

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this class.

Data Type

String

CardType Property (FDMSRetail 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_fdmsretail_getcardtype(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardcvvdata(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardcvvpresence(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardentrydatasource(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardexpmonth(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardexpyear(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardisencrypted(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getcardnumber(void* lpObj);
int dpaymentssdk_fdmsretail_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

CustomerAddress Property (FDMSRetail 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_fdmsretail_getcustomeraddress(void* lpObj);
int dpaymentssdk_fdmsretail_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 20 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 (FDMSRetail 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_fdmsretail_getcustomerzip(void* lpObj);
int dpaymentssdk_fdmsretail_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 10 characters.

Data Type

String

DatawireId Property (FDMSRetail 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_fdmsretail_getdatawireid(void* lpObj);
int dpaymentssdk_fdmsretail_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

FDMSPlatform Property (FDMSRetail Class)

Specifies the FDMS platform that the transactions will be processed on.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFDMSPlatform();
int SetFDMSPlatform(int iFDMSPlatform);

Unicode (Windows)
INT GetFDMSPlatform();
INT SetFDMSPlatform(INT iFDMSPlatform);

FP_NORTH(0), 
FP_NASHVILLE(1)

int dpaymentssdk_fdmsretail_getfdmsplatform(void* lpObj);
int dpaymentssdk_fdmsretail_setfdmsplatform(void* lpObj, int iFDMSPlatform);

int GetFDMSPlatform();
int SetFDMSPlatform(int iFDMSPlatform);

Default Value

0

Remarks

This property is used to identify the FDMS platform that the transactions will be sent to and processed on. The following table lists the platforms supported by this class.

Data Type

Integer

IndustryType Property (FDMSRetail Class)

Code which indicates the industry the merchant is engaged in.

Syntax

• C++
• C
• Qt

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

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

FIT_UNKNOWN(0), 
FIT_RETAIL(1), 
FIT_RESTAURANT(2), 
FIT_GROCERY_STORE(3), 
FIT_DIRECT_MARKETING(4), 
FIT_HOTEL(5)

int dpaymentssdk_fdmsretail_getindustrytype(void* lpObj);
int dpaymentssdk_fdmsretail_setindustrytype(void* lpObj, int iIndustryType);

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

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: fitDirectMarketing is NOT supported for this class Please use the FDMSECommerce class for Direct Marketing transactions.

Data Type

Integer

MerchantNumber Property (FDMSRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber);

Unicode (Windows)
LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);

char* dpaymentssdk_fdmsretail_getmerchantnumber(void* lpObj);
int dpaymentssdk_fdmsretail_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

Default Value

""

Remarks

This property contains a unique number (typically 12 digits) which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS and Datawire systems, and is used along with the MerchantTerminalNumber and DatawireId as connection credentials.

Data Type

String

MerchantTerminalNumber Property (FDMSRetail 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_fdmsretail_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_fdmsretail_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

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

Default Value

""

Remarks

This property contains a number (typically 6 digits) assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber and DatawireId as connection credentials.

Data Type

String

ProxyAuthScheme Property (FDMSRetail 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_fdmsretail_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getproxypassword(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getproxyport(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getproxyserver(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getproxyssl(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getproxyuser(void* lpObj);
int dpaymentssdk_fdmsretail_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

ResponseApprovalCode Property (FDMSRetail Class)

Contains an authorization code when a transaction has been approved, or an error message if declined.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* dpaymentssdk_fdmsretail_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved, or an error message if declined.

This property contains an authorization code when a transaction has been approved. The code will begin with "AP" and will be 8 characters in length. If the transaction was partially approved, it will begin with "AL" (approved for lesser amount), and the actual amount approved will be contained in the ResponseAuthorizedAmount property. If the transaction was declined ResponseApprovalCode will contain one of the response messages listed in the table below:

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (FDMSRetail Class)

When supporting partial authorizations, this is the amount actually charged to the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizedAmount();

Unicode (Windows)
LPWSTR GetResponseAuthorizedAmount();

char* dpaymentssdk_fdmsretail_getresponseauthorizedamount(void* lpObj);

QString GetResponseAuthorizedAmount();

Default Value

""

Remarks

When supporting partial authorizations, this is the amount actually charged to the credit card.

This is only used when supporting partial authorizations (currently only supported for healthcare transactions). If the ResponseApprovalCode begins with "AL" this property will contain the amount actually charged to the credit card. This will be less than the original 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 property is read-only.

Data Type

String

ResponseAVSResult Property (FDMSRetail Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* dpaymentssdk_fdmsretail_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. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below.

Valid AVS Codes:

If supporting international transactions, four additional International Address Verification Service (IAVS) codes are introduced:

This property is read-only.

Data Type

String

ResponseBalance Property (FDMSRetail 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_fdmsretail_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

ResponseCaptureFlag Property (FDMSRetail Class)

Indicates whether the authorization was successful, and whether it can be settled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseCaptureFlag();

Unicode (Windows)
BOOL GetResponseCaptureFlag();

int dpaymentssdk_fdmsretail_getresponsecaptureflag(void* lpObj);

bool GetResponseCaptureFlag();

Default Value

FALSE

Remarks

Indicates whether the authorization was successful, and whether it can be settled.

After an authorization request, the ResponseCaptureFlag will be set to True if the request was successfully processed. This indicates that you may send the transaction on for batch settlement using the FDMSSettle class. If this property is False you should consider the transaction as Declined, and it may not be settled.

This property is read-only.

Data Type

Boolean

ResponseCardLevelResult Property (FDMSRetail Class)

Two character card level results property returned in the response to Visa authorizations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCardLevelResult();

Unicode (Windows)
LPWSTR GetResponseCardLevelResult();

char* dpaymentssdk_fdmsretail_getresponsecardlevelresult(void* lpObj);

QString GetResponseCardLevelResult();

Default Value

""

Remarks

Two character card level results field returned in the response to Visa authorizations.

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

Data Type

String

ResponseCommercialCard Property (FDMSRetail 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();

CCT_NOT_COMMERCIAL(0), 
CCT_PURCHASE_CARD(1), 
CCT_CORPORATE_CARD(2), 
CCT_BUSINESS_CARD(3), 
CCT_UNKNOWN(4)

int dpaymentssdk_fdmsretail_getresponsecommercialcard(void* lpObj);

int GetResponseCommercialCard();

Default Value

0

Remarks

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

Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data in the settlement when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Commercial card transactions settled with Level 2 or Level 3 data must include tax amounts to receive the best interchange rate.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (FDMSRetail 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_fdmsretail_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. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSRetail 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_fdmsretail_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 ResponseCaptureFlag and ResponseApprovalCode properties contain 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 (FDMSRetail Class)

Status of the communication with Datawire.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDatawireStatus();

Unicode (Windows)
LPWSTR GetResponseDatawireStatus();

char* dpaymentssdk_fdmsretail_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 ResponseCaptureFlag and ResponseApprovalCode properties 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

ResponseReturnedACI Property (FDMSRetail Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseReturnedACI();

Unicode (Windows)
LPWSTR GetResponseReturnedACI();

char* dpaymentssdk_fdmsretail_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). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the ResponseTransactionId or ResponseValidationCode fields.

The following is a list of all returned ACI values. Please note that many of these return values result from features not available in any of the currently supported Industry Types.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (FDMSRetail Class)

Local transaction date returned from the server in MMDDYY format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionDate();

Unicode (Windows)
LPWSTR GetResponseTransactionDate();

char* dpaymentssdk_fdmsretail_getresponsetransactiondate(void* lpObj);

QString GetResponseTransactionDate();

Default Value

""

Remarks

Local transaction date returned from the server in MMDDYY format.

This six digit field contains a local transaction date calculated by the authorization center. This field should be recorded and submitted in the Batch Settlement.

This property is read-only.

Data Type

String

ResponseTransactionId Property (FDMSRetail Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* dpaymentssdk_fdmsretail_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

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

Data Type

String

ResponseValidationCode Property (FDMSRetail Class)

Additional information generated by the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseValidationCode();

Unicode (Windows)
LPWSTR GetResponseValidationCode();

char* dpaymentssdk_fdmsretail_getresponsevalidationcode(void* lpObj);

QString GetResponseValidationCode();

Default Value

""

Remarks

Additional information generated by the card issuer.

This four character field may contain specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.

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

Data Type

String

SSLAcceptServerCertEncoded Property (FDMSRetail 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_fdmsretail_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getsslprovider(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_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

Timeout Property (FDMSRetail 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_fdmsretail_gettimeout(void* lpObj);
int dpaymentssdk_fdmsretail_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

TPPID Property (FDMSRetail 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_fdmsretail_gettppid(void* lpObj);
int dpaymentssdk_fdmsretail_settppid(void* lpObj, const char* lpszTPPID);

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

Default Value

"V4D001"

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 his own TPPID from FDMS. If there are multiple third parties involved in the transaction flow, additional TPPID's are required. These may be added by setting the TPPID property with a comma-delimited list. The first entry should always be the servicer that sends the transaction to FDMS. Each subsequent servicer should be identified where they are in the chain. There can be a maximum of three entries in this list.

The default value for 4D Payments, Inc. on the North and Nashville platforms is "V4D001".

Note: This value will be reset to the default value when FDMSPlatform is set.

A VisaIdentifier is also required for Visa transactions.

Data Type

String

TransactionAmount Property (FDMSRetail Class)

Purchase 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_fdmsretail_gettransactionamount(void* lpObj);
int dpaymentssdk_fdmsretail_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 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

TransactionNumber Property (FDMSRetail 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_fdmsretail_gettransactionnumber(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_geturl(void* lpObj);
int dpaymentssdk_fdmsretail_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 (FDMSRetail 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_fdmsretail_getvisaidentifier(void* lpObj);
int dpaymentssdk_fdmsretail_setvisaidentifier(void* lpObj, const char* lpszVisaIdentifier);

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

Default Value

""

Remarks

In conjunction with Visa regulatory change(s), First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). Each 19-byte 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 the following value for VisaIdentifier: 0B 000000000000

Data Type

String

Authorize Method (FDMSRetail Class)

Authorizes a credit card using track1, track2, or manually entered card data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int dpaymentssdk_fdmsretail_authorize(void* lpObj);

int Authorize();

Remarks

This method sends an authorization request through Datawire to the FDMS transaction processor. The CardEntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, the ResponseCaptureFlag property will be True, and the ResponseApprovalCode will contain an approval code.

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement class. For example:

FDMSRetail.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000" FDMSRetail.CardEntryDataSource = edsTrack1 FDMSRetail.Authorize() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailAggregate[0] = FDMSRetail.GetDetailAggregate() End If 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.

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

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

AVSAndCVVOnly Method (FDMSRetail Class)

Performs an AVS/CVV only check using the specified Card data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AVSAndCVVOnly();

Unicode (Windows)
INT AVSAndCVVOnly();

int dpaymentssdk_fdmsretail_avsandcvvonly(void* lpObj);

int AVSAndCVVOnly();

Remarks

This methods allows you to perform an AVS/CVV only request for verification purposes using the specified Card data. This does not authorize any funds on the card and only performs an AVS and CVV check. The TransactionAmount must be 0 for this transaction.

Note: For Retail transactions the CardEntryDataSource must be set to a manual entry value for this transaction.

FDMSRetail.CardEntryDataSource = edsManualEntryTrack1Capable FDMSRetail.CardNumber = "4444333322221111" FDMSRetail.CardExpMonth = 9 FDMSRetail.CardExpYear = 2015 FDMSRetail.CardCVVData = "999" FDMSRetail.CustomerAddress = "123 Nowhere Ln" FDMSRetail.CustomerZip = "90210" FDMSRetail.TransactionAmount = "0" FDMSRetail.AVSAndCVVOnly()

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 (FDMSRetail 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_fdmsretail_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.

FDMSRetail.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000" FDMSRetail.CardEntryDataSource = edsTrack1 FDMSRetail.BalanceInquiry() 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.

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 (FDMSRetail 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_fdmsretail_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.

GetDetailAggregate Method (FDMSRetail Class)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDetailAggregate();

Unicode (Windows)
LPWSTR GetDetailAggregate();

char* dpaymentssdk_fdmsretail_getdetailaggregate(void* lpObj);

QString GetDetailAggregate();

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSSettle 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 FDMSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseCaptureFlag is false) the method fails with an error.

An example of how this method is used is shown below:

FDMSRetail.AuthorizeTrack1() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1 FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate() End If

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 (FDMSRetail Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_fdmsretail_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 (FDMSRetail Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmsretail_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.)

Connected Event (FDMSRetail Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_CONNECTED 1

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

class FDMSRetailConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass FDMSRetail and override this emitter function.
virtual int FireConnected(FDMSRetailConnectedEventParams *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 (FDMSRetail Class)

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_DATAPACKETIN 2

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

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

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

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

// Or, subclass FDMSRetail and override this emitter function.
virtual int FireDataPacketIn(FDMSRetailDataPacketInEventParams *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 (FDMSRetail Class)

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_DATAPACKETOUT 3

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

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

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

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

// Or, subclass FDMSRetail and override this emitter function.
virtual int FireDataPacketOut(FDMSRetailDataPacketOutEventParams *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 (FDMSRetail Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_DISCONNECTED 4

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

class FDMSRetailDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass FDMSRetail and override this emitter function.
virtual int FireDisconnected(FDMSRetailDisconnectedEventParams *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 (FDMSRetail Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_ERROR 5

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

class FDMSRetailErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass FDMSRetail and override this emitter function.
virtual int FireError(FDMSRetailErrorEventParams *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 (FDMSRetail Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_SSLSERVERAUTHENTICATION 6

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

class FDMSRetailSSLServerAuthenticationEventParams {
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(FDMSRetailSSLServerAuthenticationEventParams *e);

// Or, subclass FDMSRetail and override this emitter function.
virtual int FireSSLServerAuthentication(FDMSRetailSSLServerAuthenticationEventParams *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 (FDMSRetail Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (FDMSRetail Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRETAIL_STATUS 8

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Config Settings (FDMSRetail Class)

FDMSRetail Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSRetail Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FDMSRetail Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors