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:

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: 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. retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.ReferenceNumber = "123"; Then specify customer card and address information along with the transaction amount: 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.

retail.Sale();

The ResponseCode property indicates the result of the transaction. A code of 000 indicates success. For all other values please see the Response Codes section. Additional Response properties such as ResponseApprovalCode, ResponseAuthorizedAmount, ResponseText, ResponseAVSResult, ResponseCVVResult, and more, provide further details about the transaction response.

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

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

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DestinationPostalCode (required)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2ProductDescription (required)
• Level2PurchaseIdentifier (required)
• Level2MerchantTaxId
• Level2ShipFromPostalCode
• Level2TaxAmount
• Level2TaxIndicator

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode
• Level2MerchantTaxId

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2MerchantTaxId (required)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode

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

InstallmentDescription Property (FDMSRcRetail Class)

The merchant's description of an Installment Bill Payment Transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInstallmentDescription();
int SetInstallmentDescription(const char* lpszInstallmentDescription);

Unicode (Windows)
LPWSTR GetInstallmentDescription();
INT SetInstallmentDescription(LPCWSTR lpszInstallmentDescription);

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

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

Default Value

""

Remarks

The merchant's description of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 15 characters.

Data Type

String

InstallmentInvoiceNumber Property (FDMSRcRetail Class)

The Invoice Number of an Installment Bill Payment Transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInstallmentInvoiceNumber();
int SetInstallmentInvoiceNumber(const char* lpszInstallmentInvoiceNumber);

Unicode (Windows)
LPWSTR GetInstallmentInvoiceNumber();
INT SetInstallmentInvoiceNumber(LPCWSTR lpszInstallmentInvoiceNumber);

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

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

Default Value

""

Remarks

The Invoice Number of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 12 characters.

Data Type

String

InstallmentType Property (FDMSRcRetail Class)

The type of the Installment payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInstallmentType();
int SetInstallmentType(int iInstallmentType);

Unicode (Windows)
INT GetInstallmentType();
INT SetInstallmentType(INT iInstallmentType);

IT_UNSPECIFIED(0), 
IT_MERCHANT(1), 
IT_THIRD_PARTY(2), 
IT_ISSUER(3)

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

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

Default Value

0

Remarks

The type of the Installment payment.

This field is required for all Discover, Diners (including JCB - US Domestic) Installment transactions TransactionIndicator value 3 (tiInstallment) and it is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

Data Type

Integer

MerchantAdviceCode Property (FDMSRcRetail Class)

This property contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantAdviceCode();

Unicode (Windows)
LPWSTR GetMerchantAdviceCode();

char* dpaymentssdk_fdmsrcretail_getmerchantadvicecode(void* lpObj);

QString GetMerchantAdviceCode();

Default Value

""

Remarks

This field contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

The following values are defined:

This property is read-only.

Data Type

String

MITAmount Property (FDMSRcRetail Class)

The amount of the Recurring or Installment payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITAmount();
int SetMITAmount(const char* lpszMITAmount);

Unicode (Windows)
LPWSTR GetMITAmount();
INT SetMITAmount(LPCWSTR lpszMITAmount);

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

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

Default Value

""

Remarks

The amount of the Recurring or Installment payment.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

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

MITAmountType Property (FDMSRcRetail Class)

Identifies the type of the Recurring or Installment Payment amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMITAmountType();
int SetMITAmountType(int iMITAmountType);

Unicode (Windows)
INT GetMITAmountType();
INT SetMITAmountType(INT iMITAmountType);

AT_UNSPECIFIED(0), 
AT_FIXED(1), 
AT_VARIABLE(2)

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

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

Default Value

0

Remarks

Identifies the type of the Recurring or Installment Payment amount.

The following values are defined:

Data Type

Integer

MITFrequency Property (FDMSRcRetail Class)

This property indicates the frequency of a Recurring or Installment payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMITFrequency();
int SetMITFrequency(int iMITFrequency);

Unicode (Windows)
INT GetMITFrequency();
INT SetMITFrequency(INT iMITFrequency);

FREQ_UNSPECIFIED(0), 
FREQ_DAILY(1), 
FREQ_WEEKLY(2), 
FREQ_BIWEEKLY(3), 
FREQ_MONTHLY(4), 
FREQ_QUARTERLY(5), 
FREQ_BIANNUALLY(6), 
FREQ_ANNUALLY(7), 
FREQ_UNSCHEDULED(8), 
FREQ_TEN_DAYS(9), 
FREQ_TWICE_WEEKLY(10), 
FREQ_EVERY_TWO_MONTHS(11), 
FREQ_TRIMESTER(12)

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

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

Default Value

0

Remarks

This field indicates the frequency of a Recurring or Installment payment.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

When the Card Type is 'Discover', 'JCB', or 'Diners', the valid values are 1, 2, 3, 4, 5, 6, 7, or 8.

For Visa Recurring transactions, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12.

For Visa Installment transactions, valid values are 2, 3, or 4.

Data Type

Integer

MITPaymentCurrency Property (FDMSRcRetail Class)

Contains the Installment Payment Currency represented as a 3 digit value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITPaymentCurrency();
int SetMITPaymentCurrency(const char* lpszMITPaymentCurrency);

Unicode (Windows)
LPWSTR GetMITPaymentCurrency();
INT SetMITPaymentCurrency(LPCWSTR lpszMITPaymentCurrency);

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

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

Default Value

"840"

Remarks

Contains the Installment Payment Currency represented as a 3 digit value.

This field is only applicable when Card Type is 'Visa'. For US Dollars, use "840".

Data Type

String

MITRecurringPaymentType Property (FDMSRcRetail Class)

This property contains the type of Recurring Payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMITRecurringPaymentType();
int SetMITRecurringPaymentType(int iMITRecurringPaymentType);

Unicode (Windows)
INT GetMITRecurringPaymentType();
INT SetMITRecurringPaymentType(INT iMITRecurringPaymentType);

RPT_UNSPECIFIED(0), 
RPT_REGISTRATION(1), 
RPT_SUBSEQUENT(2), 
RPT_MODIFICATION(3), 
RPT_CANCELLATION(4)

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

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

Default Value

0

Remarks

This field contains the type of Recurring Payment.

This field is only applicable when Card Type is 'Visa'. The following values are defined:

Data Type

Integer

MITRegistrationRefNum Property (FDMSRcRetail Class)

This property contains a unique Reference Number for the Recurring Payment transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITRegistrationRefNum();
int SetMITRegistrationRefNum(const char* lpszMITRegistrationRefNum);

Unicode (Windows)
LPWSTR GetMITRegistrationRefNum();
INT SetMITRegistrationRefNum(LPCWSTR lpszMITRegistrationRefNum);

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

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

Default Value

""

Remarks

This field contains a unique Reference Number for the Recurring Payment transaction.

This field is only applicable when Card Type is 'Visa'.

The maximum length of this field is 35 characters.

Data Type

String

MITSequenceIndicator Property (FDMSRcRetail Class)

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMITSequenceIndicator();
int SetMITSequenceIndicator(int iMITSequenceIndicator);

Unicode (Windows)
INT GetMITSequenceIndicator();
INT SetMITSequenceIndicator(INT iMITSequenceIndicator);

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

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

Default Value

0

Remarks

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

This field should be populated in ascending order and is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

Valid values for this field are numbers from 0 to 99.

Data Type

Integer

MITTotalPaymentAmount Property (FDMSRcRetail Class)

This property contains the Total Installment Amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITTotalPaymentAmount();
int SetMITTotalPaymentAmount(const char* lpszMITTotalPaymentAmount);

Unicode (Windows)
LPWSTR GetMITTotalPaymentAmount();
INT SetMITTotalPaymentAmount(LPCWSTR lpszMITTotalPaymentAmount);

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

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

Default Value

""

Remarks

This field contains the Total Installment Amount.

This field is only applicable for Visa Installment transactions. Note : The total amount cannot exceed USD 500,000.

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

MITTotalPaymentCount Property (FDMSRcRetail Class)

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITTotalPaymentCount();
int SetMITTotalPaymentCount(const char* lpszMITTotalPaymentCount);

Unicode (Windows)
LPWSTR GetMITTotalPaymentCount();
INT SetMITTotalPaymentCount(LPCWSTR lpszMITTotalPaymentCount);

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

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

Default Value

""

Remarks

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'. For Discover, the valid values should be from 02 to 99, UD and UC. For Visa, the valid values should be from 01 to 99. Note: For Visa recurring payments, value of '99' means that recurring payments are authorized until canceled or that the Number of Recurring Payments is not defined.

When this field is sent for Visa or Discover (including JCB - US Domestic Only and Diners), the Bill Payment Transaction Indicator must be present with the value of 'Recurring' or 'Installment'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field can only be sent when the Installment Type field contains the value of 'Merchant' or 'ThirdParty'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field must be sent for ALL Installment transactions for a series of payments, and the original CIT transaction must be initiated with 3DS.

The maximum length of this field is 2 characters.

Data Type

String

MITUniqueID Property (FDMSRcRetail Class)

This property is used to uniquely identify each of the Recurring or Installment Payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITUniqueID();
int SetMITUniqueID(const char* lpszMITUniqueID);

Unicode (Windows)
LPWSTR GetMITUniqueID();
INT SetMITUniqueID(LPCWSTR lpszMITUniqueID);

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

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

Default Value

""

Remarks

This field is used to uniquely identify each of the Recurring or Installment Payment. This ID is used to reference authorization transactions.

This field is only applicable when Card Type is 'Discover', 'JCB' or 'Diners'.

The maximum length of this field is 14 characters.

Data Type

String

MITValidationFlag Property (FDMSRcRetail Class)

Indicates the validation source for the validity of a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMITValidationFlag();
int SetMITValidationFlag(int iMITValidationFlag);

Unicode (Windows)
INT GetMITValidationFlag();
INT SetMITValidationFlag(INT iMITValidationFlag);

VF_UNSPECIFIED(0), 
VF_VALIDATED(1), 
VF_NOT_VALIDATED(2)

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

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

Default Value

0

Remarks

Indicates the validation source for the validity of a transaction.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

The following values are defined:

Data Type

Integer

MITValidationRef Property (FDMSRcRetail Class)

This property contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMITValidationRef();
int SetMITValidationRef(const char* lpszMITValidationRef);

Unicode (Windows)
LPWSTR GetMITValidationRef();
INT SetMITValidationRef(LPCWSTR lpszMITValidationRef);

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

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

Default Value

""

Remarks

This field contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

This field is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

The maximum length of this field is 20 characters.

Data Type

String

TransactionIndicator Property (FDMSRcRetail Class)

Specifies the type of Bill Payment being made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionIndicator();
int SetTransactionIndicator(int iTransactionIndicator);

Unicode (Windows)
INT GetTransactionIndicator();
INT SetTransactionIndicator(INT iTransactionIndicator);

TI_UNSPECIFIED(0), 
TI_SINGLE_TRANSACTION(1), 
TI_RECURRING(2), 
TI_INSTALLMENT(3), 
TI_DEFERRED_BILLING(4)

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

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

Default Value

0

Remarks

Specifies the type of Bill Payment being made.

This property contains the type of bill payment being made. This is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

To settle an Installment transaction, you must use the FDMSRcDetailrecord class to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()

Data Type

Integer

CardType Property (FDMSRcRetail Class)

Type of credit card being used in this transaction.

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

CardCVVData Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

CardCVVPresence Property (FDMSRcRetail Class)

Indicates the presence of the card verification value.

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

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

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (FDMSRcRetail Class)

Expiration month of the credit card specified in Number .

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (FDMSRcRetail Class)

Expiration year of the credit card specified in Number .

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

String

CardNumber Property (FDMSRcRetail Class)

Customer's credit card number for the transaction.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

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

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

Level2CustomerReferenceNumber Property (FDMSRcRetail Class)

The reference number or order number to be reported as part of the Purchase Card data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2CustomerReferenceNumber();
int SetLevel2CustomerReferenceNumber(const char* lpszLevel2CustomerReferenceNumber);

Unicode (Windows)
LPWSTR GetLevel2CustomerReferenceNumber();
INT SetLevel2CustomerReferenceNumber(LPCWSTR lpszLevel2CustomerReferenceNumber);

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

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

Default Value

""

Remarks

The reference number or order number to be reported as part of the Purchase Card data.

If Level2TaxAmount is specified this property is required.

The value may be up to 17 characters in length.

Data Type

String

Level2DestinationCountryCode Property (FDMSRcRetail Class)

This property represents the country code of the location the items in this purchase are being delivered to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2DestinationCountryCode();
int SetLevel2DestinationCountryCode(const char* lpszLevel2DestinationCountryCode);

Unicode (Windows)
LPWSTR GetLevel2DestinationCountryCode();
INT SetLevel2DestinationCountryCode(LPCWSTR lpszLevel2DestinationCountryCode);

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

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

Default Value

""

Remarks

This field represents the country code of the location the items in this purchase are being delivered to.

This value is the ISO 3166 three digit numeric identifier.

Data Type

String

Level2DestinationPostalCode Property (FDMSRcRetail Class)

This property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2DestinationPostalCode();
int SetLevel2DestinationPostalCode(const char* lpszLevel2DestinationPostalCode);

Unicode (Windows)
LPWSTR GetLevel2DestinationPostalCode();
INT SetLevel2DestinationPostalCode(LPCWSTR lpszLevel2DestinationPostalCode);

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

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

Default Value

""

Remarks

This property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

This property is required for American Express purchase card transactions. This is the same as the Level2ShipFromPostalCode when the customer takes possession of the items at the merchant location.

The value may be up to 9 characters.

Data Type

String

Level2DiscountAmount Property (FDMSRcRetail Class)

This property contains the discount amount for the purchase.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2DiscountAmount();
int SetLevel2DiscountAmount(const char* lpszLevel2DiscountAmount);

Unicode (Windows)
LPWSTR GetLevel2DiscountAmount();
INT SetLevel2DiscountAmount(LPCWSTR lpszLevel2DiscountAmount);

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

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

Default Value

""

Remarks

This property contains the discount amount for the purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a discount has been applied.

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

Level2DutyAmount Property (FDMSRcRetail Class)

This property contains the duty amount for this purchase.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2DutyAmount();
int SetLevel2DutyAmount(const char* lpszLevel2DutyAmount);

Unicode (Windows)
LPWSTR GetLevel2DutyAmount();
INT SetLevel2DutyAmount(LPCWSTR lpszLevel2DutyAmount);

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

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

Default Value

""

Remarks

This property contains the duty amount for this purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a duty amount has been applied.

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

Level2FreightAmount Property (FDMSRcRetail Class)

This property contains the amount for freight included in this purchase.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2FreightAmount();
int SetLevel2FreightAmount(const char* lpszLevel2FreightAmount);

Unicode (Windows)
LPWSTR GetLevel2FreightAmount();
INT SetLevel2FreightAmount(LPCWSTR lpszLevel2FreightAmount);

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

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

Default Value

""

Remarks

This property contains the amount for freight included in this purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a freight amount has been applied.

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

Level2MerchantTaxId Property (FDMSRcRetail Class)

This property should contain the Tax Id collected by the merchant for this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2MerchantTaxId();
int SetLevel2MerchantTaxId(const char* lpszLevel2MerchantTaxId);

Unicode (Windows)
LPWSTR GetLevel2MerchantTaxId();
INT SetLevel2MerchantTaxId(LPCWSTR lpszLevel2MerchantTaxId);

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

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

Default Value

""

Remarks

This property should contain the Tax Id collected by the merchant for this transaction.

This property is required for MasterCard purchase card transactions.

The value may be up to 15 characters in length.

Data Type

String

Level2ProductDescription Property (FDMSRcRetail Class)

This property should contain a description of an item purchased with this card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2ProductDescription();
int SetLevel2ProductDescription(const char* lpszLevel2ProductDescription);

Unicode (Windows)
LPWSTR GetLevel2ProductDescription();
INT SetLevel2ProductDescription(LPCWSTR lpszLevel2ProductDescription);

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

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

Default Value

""

Remarks

This property should contain a description of an item purchased with this card.

This property is required for American Express purchase card transactions and not applicable to other card types.

The value may be up to 40 characters in length.

Data Type

String

Level2PurchaseIdentifier Property (FDMSRcRetail Class)

This property represents the data used by the merchant or customer to identify the purchase.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2PurchaseIdentifier();
int SetLevel2PurchaseIdentifier(const char* lpszLevel2PurchaseIdentifier);

Unicode (Windows)
LPWSTR GetLevel2PurchaseIdentifier();
INT SetLevel2PurchaseIdentifier(LPCWSTR lpszLevel2PurchaseIdentifier);

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

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

Default Value

""

Remarks

This property represents the data used by the merchant or customer to identify the purchase. This can be a SKU, code, or reference number.

This property is required for Visa, MasterCard, and American Express purchase card transactions.

The value may be up to 25 characters in length.

Data Type

String

Level2ShipFromPostalCode Property (FDMSRcRetail Class)

The postal or zip code the item(s) in this purchase are to be shipped from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2ShipFromPostalCode();
int SetLevel2ShipFromPostalCode(const char* lpszLevel2ShipFromPostalCode);

Unicode (Windows)
LPWSTR GetLevel2ShipFromPostalCode();
INT SetLevel2ShipFromPostalCode(LPCWSTR lpszLevel2ShipFromPostalCode);

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

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

Default Value

""

Remarks

The postal or zip code the item(s) in this purchase are to be shipped from.

The value may be up to 9 characters.

Data Type

String

Level2TaxAmount Property (FDMSRcRetail Class)

This property contains the portion of the transaction amount that represents the tax.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2TaxAmount();
int SetLevel2TaxAmount(const char* lpszLevel2TaxAmount);

Unicode (Windows)
LPWSTR GetLevel2TaxAmount();
INT SetLevel2TaxAmount(LPCWSTR lpszLevel2TaxAmount);

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

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

Default Value

""

Remarks

This property contains the portion of the transaction amount that represents the tax.

This property is required when Level2TaxIndicator is set to 2 (tiProvided).

For Visa this is the amount of state or provincial tax included in the TransactionAmount. The tax amount must be within 0.1 % and 22% of the pre-tax transaction amount.

For MasterCard the total amount of sales tax on the total purchase must be between 0.1% and 30 % of the total pre-tax transaction amount; zeros indicate that the card acceptor is capable of transmitting the tax amount and the tax amount is zero.

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

Level2TaxIndicator Property (FDMSRcRetail Class)

This property indicates the taxable status of the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLevel2TaxIndicator();
int SetLevel2TaxIndicator(int iLevel2TaxIndicator);

Unicode (Windows)
INT GetLevel2TaxIndicator();
INT SetLevel2TaxIndicator(INT iLevel2TaxIndicator);

TI_UN_SET(0), 
TI_NOT_PROVIDED(1), 
TI_PROVIDED(2), 
TI_EXEMPT(3)

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

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

Default Value

0

Remarks

This field indicates the taxable status of the transaction. Possible values are:

Data Type

Integer

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

ProxyAuthScheme Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ReferenceNumber Property (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

ResponseApprovalCode Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* dpaymentssdk_fdmsrcretail_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

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

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

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

Data Type

String

ResponseAuthorizedAmount Property (FDMSRcRetail Class)

The amount actually charged to the card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizedAmount();

Unicode (Windows)
LPWSTR GetResponseAuthorizedAmount();

char* dpaymentssdk_fdmsrcretail_getresponseauthorizedamount(void* lpObj);

QString GetResponseAuthorizedAmount();

Default Value

""

Remarks

The amount actually charged to the card.

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

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

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

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

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkId Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizingNetworkId();

Unicode (Windows)
LPWSTR GetResponseAuthorizingNetworkId();

char* dpaymentssdk_fdmsrcretail_getresponseauthorizingnetworkid(void* lpObj);

QString GetResponseAuthorizingNetworkId();

Default Value

""

Remarks

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

This value is up to 3 alphanumeric characters.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkName Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizingNetworkName();

Unicode (Windows)
LPWSTR GetResponseAuthorizingNetworkName();

char* dpaymentssdk_fdmsrcretail_getresponseauthorizingnetworkname(void* lpObj);

QString GetResponseAuthorizingNetworkName();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ResponseAVSResult Property (FDMSRcRetail Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* dpaymentssdk_fdmsrcretail_getresponseavsresult(void* lpObj);

QString GetResponseAVSResult();

Default Value

""

Remarks

Contains the Address Verification System result code.

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

Visa Card AVS Codes

MasterCard AVS Codes

Amex AVS Codes

Discover or JCB

This property is read-only.

Data Type

String

ResponseBalance Property (FDMSRcRetail Class)

Contains the remaining available balance left on the card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseBalance();

Unicode (Windows)
LPWSTR GetResponseBalance();

char* dpaymentssdk_fdmsrcretail_getresponsebalance(void* lpObj);

QString GetResponseBalance();

Default Value

""

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

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

Data Type

String

ResponseCardLevelResult Property (FDMSRcRetail Class)

This property is only applicable to Visa card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCardLevelResult();

Unicode (Windows)
LPWSTR GetResponseCardLevelResult();

char* dpaymentssdk_fdmsrcretail_getresponsecardlevelresult(void* lpObj);

QString GetResponseCardLevelResult();

Default Value

""

Remarks

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

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

Data Type

String

ResponseCode Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* dpaymentssdk_fdmsrcretail_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ResponseCommercialCard Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseCommercialCard();

Unicode (Windows)
INT GetResponseCommercialCard();

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

int dpaymentssdk_fdmsrcretail_getresponsecommercialcard(void* lpObj);

int GetResponseCommercialCard();

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVVResult();

Unicode (Windows)
LPWSTR GetResponseCVVResult();

char* dpaymentssdk_fdmsrcretail_getresponsecvvresult(void* lpObj);

QString GetResponseCVVResult();

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDatawireReturnCode();

Unicode (Windows)
LPWSTR GetResponseDatawireReturnCode();

char* dpaymentssdk_fdmsrcretail_getresponsedatawirereturncode(void* lpObj);

QString GetResponseDatawireReturnCode();

Default Value

""

Remarks

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

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

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

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (FDMSRcRetail Class)

Status of the communication with Datawire.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDatawireStatus();

Unicode (Windows)
LPWSTR GetResponseDatawireStatus();

char* dpaymentssdk_fdmsrcretail_getresponsedatawirestatus(void* lpObj);

QString GetResponseDatawireStatus();

Default Value

""

Remarks

Status of the communication with Datawire.

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

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

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

This property is read-only.

Data Type

String

ResponseEMVData Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseEMVData();

Unicode (Windows)
LPWSTR GetResponseEMVData();

char* dpaymentssdk_fdmsrcretail_getresponseemvdata(void* lpObj);

QString GetResponseEMVData();

Default Value

""

Remarks

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

This property is only applicable to Retail and Debit transactions.

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

Data Type

String

ResponsePOSData Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponsePOSData();

Unicode (Windows)
LPWSTR GetResponsePOSData();

char* dpaymentssdk_fdmsrcretail_getresponseposdata(void* lpObj);

QString GetResponsePOSData();

Default Value

""

Remarks

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

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

Data Type

String

ResponseReturnedACI Property (FDMSRcRetail Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseReturnedACI();

Unicode (Windows)
LPWSTR GetResponseReturnedACI();

char* dpaymentssdk_fdmsrcretail_getresponsereturnedaci(void* lpObj);

QString GetResponseReturnedACI();

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

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

Possible returned ACI values are:

This property is read-only.

Data Type

String

ResponseRoutingIndicator Property (FDMSRcRetail Class)

Indicates whether the transaction was processed as Credit or Debit.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseRoutingIndicator();

Unicode (Windows)
LPWSTR GetResponseRoutingIndicator();

char* dpaymentssdk_fdmsrcretail_getresponseroutingindicator(void* lpObj);

QString GetResponseRoutingIndicator();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ResponseSettlementDate Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseSettlementDate();

Unicode (Windows)
LPWSTR GetResponseSettlementDate();

char* dpaymentssdk_fdmsrcretail_getresponsesettlementdate(void* lpObj);

QString GetResponseSettlementDate();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ResponseText Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* dpaymentssdk_fdmsrcretail_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ResponseTransactionDate Property (FDMSRcRetail Class)

The transaction date returned from the server in yyyyMMddHHmmss format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionDate();

Unicode (Windows)
LPWSTR GetResponseTransactionDate();

char* dpaymentssdk_fdmsrcretail_getresponsetransactiondate(void* lpObj);

QString GetResponseTransactionDate();

Default Value

""

Remarks

The transaction date returned from the server in yyyyMMddHHmmss format.

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

This property is read-only.

Data Type

String

ResponseTransactionId Property (FDMSRcRetail Class)

Card issuer's Transaction Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* dpaymentssdk_fdmsrcretail_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

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

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

Data Type

String

ReversalTransactionType Property (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

SSLAcceptServerCertEncoded Property (FDMSRcRetail Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FDMSRcRetail Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (FDMSRcRetail Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (FDMSRcRetail Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (FDMSRcRetail Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int dpaymentssdk_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:

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

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

Data Type

Integer

SSLServerCertEncoded Property (FDMSRcRetail Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

STAN Property (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: " 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 ResponseCode to determine if the transaction was successful.

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

Retail AuthOnly Example 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 ResponseBalance. Note that Balance Inquiries do not place a hold on a cardholder's funds and are not captured.

Note: This method is only applicable to swiped 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 ResponseCode to determine if the transaction was successful.

FDMS Recommendations:

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

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