FDMSRcRetail Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcRetail 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 and restaurants.

Syntax

FDMSRcRetail

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 FDMSRcRetail 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:

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:

 
 Copy
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:

 
 Copy
retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;
retail.TPPID = "AAA000";
retail.MerchantTerminalNumber = "00000001";
retail.MerchantId = "1234";
retail.GroupId = "20001";
retail.DatawireId = "00011122233344455566";
retail.URL = "https://stg.dw.us.fdcnet.biz/rc";
retail.ApplicationId = "RAPIDCONNECTVXN";

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

 
 Copy
retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.OrderNumber = "123";
retail.ReferenceNumber = "123";

 
 Copy
retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.TransactionAmount = "1200"; //$12.00

Finally, submit the transaction by calling the Sale method.

 
 Copy
retail.Sale();

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

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

 
 Copy
retail.AuthOnly();

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

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

//Capture
retail = new Fdmsrcretail();
...

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

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

Gratuity for Restaurant Transactions:

In order to add gratuity the transaction may be authorized using AuthOnly and then Captured for a different amount that includes the tip. Gratuity cannot be added later to a Sale transaction. Consult FDMS for any applicable limits on the additional amount being captured.

Level 2 Transactions

The values required for Level 2 transaction depend on the card type. The following tables indicate which properties are valid for what card type:

American Express

• CustomerReferenceNumber (required if TaxAmount specified)
• DestinationPostalCode (required)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• ProductDescription (required)
• PurchaseIdentifier (required)
• MerchantTaxId
• ShipFromPostalCode
• TaxAmount
• TaxIndicator

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode
• MerchantTaxId

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• MerchantTaxId (required)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode

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 (FDMSRcRetail 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_fdmsrcretail_getapplicationid(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

BillPay Property (FDMSRcRetail Class)

Specifies information used in a bill payment or MIT transaction.

Syntax

• C++
• C
• Qt

DPaymentsSDKFDMSRcBillPay* GetBillPay();
int SetBillPay(DPaymentsSDKFDMSRcBillPay* val);

char* dpaymentssdk_fdmsrcretail_getinstallmentdescription(void* lpObj);
int dpaymentssdk_fdmsrcretail_setinstallmentdescription(void* lpObj, const char* lpszInstallmentDescription);

char* dpaymentssdk_fdmsrcretail_getinstallmentinvoicenumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_setinstallmentinvoicenumber(void* lpObj, const char* lpszInstallmentInvoiceNumber);

int dpaymentssdk_fdmsrcretail_getinstallmenttype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setinstallmenttype(void* lpObj, int iInstallmentType);

char* dpaymentssdk_fdmsrcretail_getmerchantadvicecode(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getmitamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitamount(void* lpObj, const char* lpszMITAmount);

int dpaymentssdk_fdmsrcretail_getmitamounttype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitamounttype(void* lpObj, int iMITAmountType);

int dpaymentssdk_fdmsrcretail_getmitfrequency(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitfrequency(void* lpObj, int iMITFrequency);

char* dpaymentssdk_fdmsrcretail_getmitpaymentcurrency(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitpaymentcurrency(void* lpObj, const char* lpszMITPaymentCurrency);

int dpaymentssdk_fdmsrcretail_getmitrecurringpaymenttype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitrecurringpaymenttype(void* lpObj, int iMITRecurringPaymentType);

char* dpaymentssdk_fdmsrcretail_getmitregistrationrefnum(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitregistrationrefnum(void* lpObj, const char* lpszMITRegistrationRefNum);

int dpaymentssdk_fdmsrcretail_getmitsequenceindicator(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitsequenceindicator(void* lpObj, int iMITSequenceIndicator);

char* dpaymentssdk_fdmsrcretail_getmittotalpaymentamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmittotalpaymentamount(void* lpObj, const char* lpszMITTotalPaymentAmount);

char* dpaymentssdk_fdmsrcretail_getmittotalpaymentcount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmittotalpaymentcount(void* lpObj, const char* lpszMITTotalPaymentCount);

char* dpaymentssdk_fdmsrcretail_getmituniqueid(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmituniqueid(void* lpObj, const char* lpszMITUniqueID);

int dpaymentssdk_fdmsrcretail_getmitvalidationflag(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitvalidationflag(void* lpObj, int iMITValidationFlag);

char* dpaymentssdk_fdmsrcretail_getmitvalidationref(void* lpObj);
int dpaymentssdk_fdmsrcretail_setmitvalidationref(void* lpObj, const char* lpszMITValidationRef);

int dpaymentssdk_fdmsrcretail_gettransactionindicator(void* lpObj);
int dpaymentssdk_fdmsrcretail_settransactionindicator(void* lpObj, int iTransactionIndicator);

QString GetInstallmentDescription();
int SetInstallmentDescription(QString qsInstallmentDescription);

QString GetInstallmentInvoiceNumber();
int SetInstallmentInvoiceNumber(QString qsInstallmentInvoiceNumber);

int GetInstallmentType();
int SetInstallmentType(int iInstallmentType);

QString GetMerchantAdviceCode();

QString GetMITAmount();
int SetMITAmount(QString qsMITAmount);

int GetMITAmountType();
int SetMITAmountType(int iMITAmountType);

int GetMITFrequency();
int SetMITFrequency(int iMITFrequency);

QString GetMITPaymentCurrency();
int SetMITPaymentCurrency(QString qsMITPaymentCurrency);

int GetMITRecurringPaymentType();
int SetMITRecurringPaymentType(int iMITRecurringPaymentType);

QString GetMITRegistrationRefNum();
int SetMITRegistrationRefNum(QString qsMITRegistrationRefNum);

int GetMITSequenceIndicator();
int SetMITSequenceIndicator(int iMITSequenceIndicator);

QString GetMITTotalPaymentAmount();
int SetMITTotalPaymentAmount(QString qsMITTotalPaymentAmount);

QString GetMITTotalPaymentCount();
int SetMITTotalPaymentCount(QString qsMITTotalPaymentCount);

QString GetMITUniqueID();
int SetMITUniqueID(QString qsMITUniqueID);

int GetMITValidationFlag();
int SetMITValidationFlag(int iMITValidationFlag);

QString GetMITValidationRef();
int SetMITValidationRef(QString qsMITValidationRef);

int GetTransactionIndicator();
int SetTransactionIndicator(int iTransactionIndicator);

Remarks

This property specifies information used in processing a bill payment or MIT transaction.

Data Type

DPaymentsSDKFDMSRcBillPay

Card Property (FDMSRcRetail Class)

Contains the customer's credit card information.

Syntax

• C++
• C
• Qt

DPaymentsSDKCCCard* GetCard();
int SetCard(DPaymentsSDKCCCard* val);

int dpaymentssdk_fdmsrcretail_getcardtype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardtype(void* lpObj, int iCardType);

char* dpaymentssdk_fdmsrcretail_getcardcvvdata(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

int dpaymentssdk_fdmsrcretail_getcardcvvpresence(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int dpaymentssdk_fdmsrcretail_getcardentrydatasource(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int dpaymentssdk_fdmsrcretail_getcardexpmonth(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardexpmonth(void* lpObj, int iCardExpMonth);

int dpaymentssdk_fdmsrcretail_getcardexpyear(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardexpyear(void* lpObj, int iCardExpYear);

int dpaymentssdk_fdmsrcretail_getcardisencrypted(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

char* dpaymentssdk_fdmsrcretail_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

char* dpaymentssdk_fdmsrcretail_getcardnumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcardnumber(void* lpObj, const char* lpszCardNumber);

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

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

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

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

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

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

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

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

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

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

Data Type

DPaymentsSDKCCCard

CashBack Property (FDMSRcRetail Class)

Optional cash back amount to return to the customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBack();
int SetCashBack(const char* lpszCashBack);

Unicode (Windows)
LPWSTR GetCashBack();
INT SetCashBack(LPCWSTR lpszCashBack);

char* dpaymentssdk_fdmsrcretail_getcashback(void* lpObj);
int dpaymentssdk_fdmsrcretail_setcashback(void* lpObj, const char* lpszCashBack);

QString GetCashBack();
int SetCashBack(QString qsCashBack);

Default Value

""

Remarks

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 largest possible CashBack amount is "99999", yielding a maximum US dollar amount of $999.99. This field may not contain a negative number.

For cash back transactions, the TransactionAmount must contain the sum total of the purchase amount PLUS the CashBack amount. If the purchase is for $10 and the customer requests $20 cash back, CashBack should be set to "2000" and TransactionAmount must contain "3000".

Note that only US currency is supported for debit transactions.

Data Type

String

CustomerAddress Property (FDMSRcRetail 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_fdmsrcretail_getcustomeraddress(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getcustomerzip(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getdatawireid(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

DigitalWalletType Property (FDMSRcRetail Class)

Identifies the brand of digital wallet or tokenization program used in a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDigitalWalletType();
int SetDigitalWalletType(int iDigitalWalletType);

Unicode (Windows)
INT GetDigitalWalletType();
INT SetDigitalWalletType(INT iDigitalWalletType);

FRDW_NOT_USED(0), 
FRDW_ANDROID_PAY(1), 
FRDW_APPLE_PAY(2), 
FRDW_MERCHANT_TOKENIZATION(3), 
FRDW_SAMSUNG_PAY(4), 
FRDW_DISCOVER_CLICK_TO_PAY(5)

int dpaymentssdk_fdmsrcretail_getdigitalwallettype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setdigitalwallettype(void* lpObj, int iDigitalWalletType);

int GetDigitalWalletType();
int SetDigitalWalletType(int iDigitalWalletType);

Default Value

0

Remarks

Digital Wallet Program Type. Possible values are:

Data Type

Integer

EMVData Property (FDMSRcRetail 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_fdmsrcretail_getemvdata(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

 
 Copy
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

GroupId Property (FDMSRcRetail 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_fdmsrcretail_getgroupid(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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);

FRIT_RETAIL(0), 
FRIT_RESTAURANT(1), 
FRIT_HOTEL(2)

int dpaymentssdk_fdmsrcretail_getindustrytype(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

Level2 Property (FDMSRcRetail Class)

Specifies Level 2 (purchasing card information).

Syntax

• C++
• C
• Qt

DPaymentsSDKFDMSRcLevel2* GetLevel2();
int SetLevel2(DPaymentsSDKFDMSRcLevel2* val);

char* dpaymentssdk_fdmsrcretail_getlevel2customerreferencenumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2customerreferencenumber(void* lpObj, const char* lpszLevel2CustomerReferenceNumber);

char* dpaymentssdk_fdmsrcretail_getlevel2destinationcountrycode(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2destinationcountrycode(void* lpObj, const char* lpszLevel2DestinationCountryCode);

char* dpaymentssdk_fdmsrcretail_getlevel2destinationpostalcode(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2destinationpostalcode(void* lpObj, const char* lpszLevel2DestinationPostalCode);

char* dpaymentssdk_fdmsrcretail_getlevel2discountamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2discountamount(void* lpObj, const char* lpszLevel2DiscountAmount);

char* dpaymentssdk_fdmsrcretail_getlevel2dutyamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2dutyamount(void* lpObj, const char* lpszLevel2DutyAmount);

char* dpaymentssdk_fdmsrcretail_getlevel2freightamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2freightamount(void* lpObj, const char* lpszLevel2FreightAmount);

char* dpaymentssdk_fdmsrcretail_getlevel2merchanttaxid(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2merchanttaxid(void* lpObj, const char* lpszLevel2MerchantTaxId);

char* dpaymentssdk_fdmsrcretail_getlevel2productdescription(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2productdescription(void* lpObj, const char* lpszLevel2ProductDescription);

char* dpaymentssdk_fdmsrcretail_getlevel2purchaseidentifier(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2purchaseidentifier(void* lpObj, const char* lpszLevel2PurchaseIdentifier);

char* dpaymentssdk_fdmsrcretail_getlevel2shipfrompostalcode(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2shipfrompostalcode(void* lpObj, const char* lpszLevel2ShipFromPostalCode);

char* dpaymentssdk_fdmsrcretail_getlevel2taxamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2taxamount(void* lpObj, const char* lpszLevel2TaxAmount);

int dpaymentssdk_fdmsrcretail_getlevel2taxindicator(void* lpObj);
int dpaymentssdk_fdmsrcretail_setlevel2taxindicator(void* lpObj, int iLevel2TaxIndicator);

QString GetLevel2CustomerReferenceNumber();
int SetLevel2CustomerReferenceNumber(QString qsLevel2CustomerReferenceNumber);

QString GetLevel2DestinationCountryCode();
int SetLevel2DestinationCountryCode(QString qsLevel2DestinationCountryCode);

QString GetLevel2DestinationPostalCode();
int SetLevel2DestinationPostalCode(QString qsLevel2DestinationPostalCode);

QString GetLevel2DiscountAmount();
int SetLevel2DiscountAmount(QString qsLevel2DiscountAmount);

QString GetLevel2DutyAmount();
int SetLevel2DutyAmount(QString qsLevel2DutyAmount);

QString GetLevel2FreightAmount();
int SetLevel2FreightAmount(QString qsLevel2FreightAmount);

QString GetLevel2MerchantTaxId();
int SetLevel2MerchantTaxId(QString qsLevel2MerchantTaxId);

QString GetLevel2ProductDescription();
int SetLevel2ProductDescription(QString qsLevel2ProductDescription);

QString GetLevel2PurchaseIdentifier();
int SetLevel2PurchaseIdentifier(QString qsLevel2PurchaseIdentifier);

QString GetLevel2ShipFromPostalCode();
int SetLevel2ShipFromPostalCode(QString qsLevel2ShipFromPostalCode);

QString GetLevel2TaxAmount();
int SetLevel2TaxAmount(QString qsLevel2TaxAmount);

int GetLevel2TaxIndicator();
int SetLevel2TaxIndicator(int iLevel2TaxIndicator);

Remarks

This property specifies Level 2 (purchasing card information).

The values required for Level 2 transaction depend on the card type. The following tables indicate which properties are valid for what card type:

American Express

• CustomerReferenceNumber (required if TaxAmount specified)
• DestinationPostalCode (required)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• ProductDescription (required)
• PurchaseIdentifier (required)
• MerchantTaxId
• ShipFromPostalCode
• TaxAmount
• TaxIndicator

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode
• MerchantTaxId

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• MerchantTaxId (required)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode

Data Type

DPaymentsSDKFDMSRcLevel2

MerchantId Property (FDMSRcRetail 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_fdmsrcretail_getmerchantid(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getmerchantservicephone(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getmerchanturl(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getordernumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

Proxy Property (FDMSRcRetail Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

DPaymentsSDKProxy* GetProxy();
int SetProxy(DPaymentsSDKProxy* val);

int dpaymentssdk_fdmsrcretail_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int dpaymentssdk_fdmsrcretail_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* dpaymentssdk_fdmsrcretail_getproxypassword(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int dpaymentssdk_fdmsrcretail_getproxyport(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxyport(void* lpObj, int iProxyPort);

char* dpaymentssdk_fdmsrcretail_getproxyserver(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxyserver(void* lpObj, const char* lpszProxyServer);

int dpaymentssdk_fdmsrcretail_getproxyssl(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxyssl(void* lpObj, int iProxySSL);

char* dpaymentssdk_fdmsrcretail_getproxyuser(void* lpObj);
int dpaymentssdk_fdmsrcretail_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

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

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

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

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

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

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

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

DPaymentsSDKProxy

ReferenceNumber Property (FDMSRcRetail 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_fdmsrcretail_getreferencenumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

Response Property (FDMSRcRetail Class)

Contains the response to an authorization request.

Syntax

• C++
• C
• Qt

DPaymentsSDKFDMSRcResponse* GetResponse();

char* dpaymentssdk_fdmsrcretail_getresponseapprovalcode(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseauthorizedamount(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseauthorizingnetworkid(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseauthorizingnetworkname(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseavsresult(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsebalance(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsecardlevelresult(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsecode(void* lpObj);

int dpaymentssdk_fdmsrcretail_getresponsecommercialcard(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsecvvresult(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsedatawirereturncode(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsedatawirestatus(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseemvdata(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseposdata(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsereturnedaci(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponseroutingindicator(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsesettlementdate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsetext(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsetransactiondate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getresponsetransactionid(void* lpObj);

QString GetResponseApprovalCode();

QString GetResponseAuthorizedAmount();

QString GetResponseAuthorizingNetworkId();

QString GetResponseAuthorizingNetworkName();

QString GetResponseAVSResult();

QString GetResponseBalance();

QString GetResponseCardLevelResult();

QString GetResponseCode();

int GetResponseCommercialCard();

QString GetResponseCVVResult();

QString GetResponseDatawireReturnCode();

QString GetResponseDatawireStatus();

QString GetResponseEMVData();

QString GetResponsePOSData();

QString GetResponseReturnedACI();

QString GetResponseRoutingIndicator();

QString GetResponseSettlementDate();

QString GetResponseText();

QString GetResponseTransactionDate();

QString GetResponseTransactionId();

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSRcResponse type contains the following fields:

This property is read-only.

Data Type

DPaymentsSDKFDMSRcResponse

ReversalTransactionType Property (FDMSRcRetail 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_fdmsrcretail_getreversaltransactiontype(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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), 
FRT_PARTIAL_REVERSAL(3)

int dpaymentssdk_fdmsrcretail_getreversaltype(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getsettlementmode(void* lpObj);
int dpaymentssdk_fdmsrcretail_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

SSLAcceptServerCert Property (FDMSRcRetail Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_fdmsrcretail_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_fdmsrcretail_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_fdmsrcretail_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_fdmsrcretail_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_fdmsrcretail_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsrcretail_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DPaymentsSDKCertificate

SSLCert Property (FDMSRcRetail Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_fdmsrcretail_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertissuer(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmsrcretail_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_fdmsrcretail_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmsrcretail_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_fdmsrcretail_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmsrcretail_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_fdmsrcretail_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertusage(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertversion(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmsrcretail_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_fdmsrcretail_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmsrcretail_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DPaymentsSDKCertificate

SSLProvider Property (FDMSRcRetail Class)

The Secure Sockets Layer/Transport Layer Security (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_fdmsrcretail_getsslprovider(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 as follows:

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

SSLServerCert Property (FDMSRcRetail Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_fdmsrcretail_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_fdmsrcretail_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertusage(void* lpObj);

int dpaymentssdk_fdmsrcretail_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertversion(void* lpObj);

char* dpaymentssdk_fdmsrcretail_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

STAN Property (FDMSRcRetail 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_fdmsrcretail_getstan(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_gettimeout(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_gettppid(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_gettransactionamount(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_gettransactionnumber(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_geturl(void* lpObj);
int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail 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_fdmsrcretail_getvisaidentifier(void* lpObj);
int dpaymentssdk_fdmsrcretail_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:

 
 Copy
"          000000000000"

Data Type

String

AuthOnly Method (FDMSRcRetail Class)

Performs an authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AuthOnly();

Unicode (Windows)
INT AuthOnly();

int dpaymentssdk_fdmsrcretail_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 Code 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).

Retail AuthOnly Example

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

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;

retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.OrderNumber = "123";
retail.TransactionAmount = "1200";
retail.ReferenceNumber = "123";

retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.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 (FDMSRcRetail 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_fdmsrcretail_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 Balance. 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 MasterCards.

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

Captures a previously authorized transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Capture();

Unicode (Windows)
INT Capture();

int dpaymentssdk_fdmsrcretail_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 Code 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).

Retail AuthOnly and Capture Example

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

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;

retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.OrderNumber = "123";
retail.ReferenceNumber = "123456";
retail.TransactionAmount = "1200";

retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.AuthOnly();

string aggregate = retail.GetDetailAggregate();

//Capture
retail = new Fdmsrcretail();
retail.TPPID = "AAA000";
retail.MerchantTerminalNumber = "00000001";
retail.MerchantId = "1234";
retail.GroupId = "20001";
retail.DatawireId = "00011122233344455566";
retail.URL = "https://stg.dw.us.fdcnet.biz/rc";
retail.ApplicationId = "RAPIDCONNECTVXN";

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;

retail.STAN = "113";
retail.TransactionNumber = "1235";
retail.ReferenceNumber = "123457";

retail.SetDetailAggregate(aggregate);

//The TransactionAmount is populated when SetDetailAggregate is called.
//TransactionAmount may be set to a different amount when capturing,
//for instance to include Gratuity.

retail.TransactionAmount = "1600";

retail.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 (FDMSRcRetail 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_fdmsrcretail_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 (FDMSRcRetail Class)

Submits a credit transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Credit();

Unicode (Windows)
INT Credit();

int dpaymentssdk_fdmsrcretail_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 Code 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).

Retail Credit Example

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

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;

retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.OrderNumber = "123";
retail.ReferenceNumber = "123";
retail.TransactionAmount = "1200";

retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.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 (FDMSRcRetail 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_fdmsrcretail_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.

HostTotals Method (FDMSRcRetail Class)

Performs a Host Totals request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HostTotals();

Unicode (Windows)
INT HostTotals();

int dpaymentssdk_fdmsrcretail_hosttotals(void* lpObj);

int HostTotals();

Remarks

This method performs a Host Totals transaction submitted to request a Host Totals Report for a particular day.

You need to set the required merchant password and report type fields using the HostTotalsPassword and HostTotalsType configuration settings, respectively.

Retail HostTotals Example

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

retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.Config("CurrencyCode=840");
retail.Config("HostTotalsType=1");
retail.Config("HostTotalsPassword=111111");
retail.HostTotals();

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

Interrupt Method (FDMSRcRetail Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmsrcretail_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 (FDMSRcRetail Class)

Reverses a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reverse();

Unicode (Windows)
INT Reverse();

int dpaymentssdk_fdmsrcretail_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 Code 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).

Retail Sale and Reverse Example

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

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;

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

retail.TransactionAmount = "1200";

retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.Sale();

string aggregate = retail.GetDetailAggregate();

//Reverse    
retail = new Fdmsrcretail();
retail.TPPID = "AAA000";
retail.MerchantTerminalNumber = "00000001";
retail.MerchantId = "1234";
retail.GroupId = "20001";
retail.DatawireId = "00011122233344455566";
retail.URL = "https://stg.dw.us.fdcnet.biz/rc";
retail.ApplicationId = "RAPIDCONNECTVXN";


retail.STAN = "113";
retail.TransactionNumber = "1235";
retail.ReferenceNumber = "123457";

retail.SetDetailAggregate(aggregate);
retail.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 (FDMSRcRetail Class)

Performs a sale transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sale();

Unicode (Windows)
INT Sale();

int dpaymentssdk_fdmsrcretail_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 Code 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).

Retail Sale Example

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

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;

retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.OrderNumber = "123";
retail.ReferenceNumber = "123";
retail.TransactionAmount = "1200";

retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.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 (FDMSRcRetail 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_fdmsrcretail_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.)

VerifyCard Method (FDMSRcRetail Class)

Performs a zero dollar verification of the card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyCard();

Unicode (Windows)
INT VerifyCard();

int dpaymentssdk_fdmsrcretail_verifycard(void* lpObj);

int VerifyCard();

Remarks

This method performs a card verification without charging any funds. This can be used to simply verify if the card is valid, or perform AVS and CVV checks without actually charging any funds to the card.

When calling this method TransactionAmount must be set to 0. Set either CustomerAddress or CustomerZip to perform AVS checks. Set CVVData to perform CVV checks.

The following combinations are supported:

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

Retail VerifyCard Example

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

retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;
retail.URL = "https://stg.dw.us.fdcnet.biz/rc";

retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.ReferenceNumber = "123";
retail.TransactionAmount = "0";

retail.CustomerZip = "11747";

//Card data can be swiped or manually keyed
retail.Card.Number = "373953123443227";
retail.Card.ExpMonth = 12;
retail.Card.ExpYear = 2018;
retail.Card.EntryDataSource = EntryDataSources.edsManualEntryTrack1Capable;

retail.VerifyCard();

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

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_CONNECTED 1

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

class FDMSRcRetailConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_DATAPACKETIN 2

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

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

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

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

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

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_DATAPACKETOUT 3

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

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

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

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

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

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_DISCONNECTED 4

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

class FDMSRcRetailDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_ERROR 5

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

class FDMSRcRetailErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_SSLSERVERAUTHENTICATION 6

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

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

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (FDMSRcRetail Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCRETAIL_STATUS 8

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

CCCard Type

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard (declared in dpaymentssdk.h)

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields

 
 Copy
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A";
card.EntryDataSource = edsTrack1;

 
 Copy
CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields

 
 Copy
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;

 
 Copy
CCCard card = new CCCard("4012000033330026", 04, 2009);

When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will fails with an error because none is present.

• CardType
• CVVData
• CVVPresence
• EntryDataSource
• ExpMonth
• ExpYear
• IsEncrypted
• MagneticStripe
• Number

Fields

 
 Copy
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1

or

class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2

Constructors

CCCard()

CCCard(const char* lpszNumber, int iExpMonth, int iExpYear)

CCCard(const char* lpszMagneticStripe, int iEntryDataSource)

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields