FDMSRcDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcDetailRecord class is a tool used to create off-line Refund or Force/VoiceApproved transactions to be settled by the FDMSRcSettle class. The FDMSRcDetailRecord class may also be used to modify the XML aggregates returned by the FDMSRcRetail or FDMSRcECommerce class's GetDetailAggregate method.

Syntax

FDMSRcDetailRecord

Remarks

Creating off-line transactions means that there is no authorization of funds using the FDMSRcECommerce, or FDMSRcRetail classs. Instead, you must manually add these transactions to the settlement batch. The FDMSRcDetailRecord class can be used to create these transactions, which can then be added to the FDMSRcSettle class's DetailRecord array property.

To create an off-line Refund, first set the TransactionType to fttRefundCredit, and then set the IndustryType and CardEntryDataSource based on whether you have a card reader, and how your customer is authenticated. The following example shows how this should be set for MOTO:

FDMSRcDetailRecord.TransactionType = fttRefundCredit FDMSRcDetailRecord.IndustryType = fitRcMOTO FDMSRcDetailRecord.CardEntryDataSource = edsManualEntryNoCardReader

Next, set the CardNumber, CardExpMonth, CardExpYear, TotalAuthorizedAmount, and SettlementAmount. Note that since this is an off-line transaction, the TotalAuthorizedAmount MUST be zero.

FDMSRcDetailRecord.CardNumber = "371030089111114" FDMSRcDetailRecord.CardExpMonth = 12 FDMSRcDetailRecord.CardExpYear = 2025 FDMSRcDetailRecord.TotalAuthorizedAmount = "0" FDMSRcDetailRecord.SettlementAmount = "5000" ' $50.00

Finally, set the FDMSRcSettle class's DetailRecord array property with the value returned by the GetDetailAggregate method. You've just added a Refund to the settlement.

FDMSRcSettle.DetailRecordCount = 1 FDMSRcSettle.DetailRecordAggregate(0) = FDMSRcDetailRecord.GetDetailAggregate()

Forced/VoiceApproved transactions are similar to refunds, with the exception that a Forced transaction requires a Voice Authorization code obtained from your acquiring bank's call center. Generally, the purchase of large high-dollar items (cars, appliances, etc) will require the merchant to call and receive a voice authorization. Once this code is received, it should be set to the ApprovalCode property. The following example shows a Force/VoiceApproved transaction in a Retail environment.

FDMSRcDetailRecord.TransactionType = fttVoiceApproved FDMSRcDetailRecord.IndustryType = fitRcRetail FDMSRcDetailRecord.CardEntryDataSource = edsTrack1 FDMSRcDetailRecord.CardNumber = "4444333322221111" FDMSRcDetailRecord.CardExpMonth = 12 FDMSRcDetailRecord.CardExpYear = 2025 FDMSRcDetailRecord.TotalAuthorizedAmount = "0" FDMSRcDetailRecord.SettlementAmount = "500000" '$5000.00 FDMSRcDetailRecord.ApprovalCode = "123456" FDMSRcSettle.DetailRecordCount = 1 FDMSRcSettle.DetailRecord(0) = FDMSRcDetailRecord.GetDetailAggregate()

In addition to creating off-line Refund and Force transactions, the FDMSRcDetailRecord class can be used to adjust the Detail Records returned from the FDMSRcECommerce and FDMSRcRetail classs. For instance, one reason to modify these detail records is to add Installment payment info (fitRcDirectMarketing or fitRcMOTO IndustryType) to the detail record.

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

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.

ApprovalCode Property (FDMSRcDetailRecord Class)

Approval code of the Voice/Force transaction to be sent for settlement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovalCode();
int SetApprovalCode(const char* lpszApprovalCode);

Unicode (Windows)
LPWSTR GetApprovalCode();
INT SetApprovalCode(LPCWSTR lpszApprovalCode);

char* dpaymentssdk_fdmsrcdetailrecord_getapprovalcode(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setapprovalcode(void* lpObj, const char* lpszApprovalCode);

QString GetApprovalCode();
int SetApprovalCode(QString qsApprovalCode);

Default Value

""

Remarks

This property should be set with the approval code the merchant gets over the phone for a Voice/Force transaction.

Data Type

String

ArrivalDate Property (FDMSRcDetailRecord Class)

The arrival date of the guest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArrivalDate();
int SetArrivalDate(const char* lpszArrivalDate);

Unicode (Windows)
LPWSTR GetArrivalDate();
INT SetArrivalDate(LPCWSTR lpszArrivalDate);

char* dpaymentssdk_fdmsrcdetailrecord_getarrivaldate(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setarrivaldate(void* lpObj, const char* lpszArrivalDate);

QString GetArrivalDate();
int SetArrivalDate(QString qsArrivalDate);

Default Value

""

Remarks

Date the guest checked in, or the expected arrival date when authorizing a reservation. The date specified should be in the format "MMDDYY".

Note: The Arrival Date must be a date that precedes the Departure Date.

Data Type

String

CardEntryDataSource Property (FDMSRcDetailRecord Class)

This property identifies 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_fdmsrcdetailrecord_getcardentrydatasource(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

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

Default Value

0

Remarks

Allowable values include: This property contains a 1-character code identifying the source of the customer data.

Data Type

Integer

CardExpMonth Property (FDMSRcDetailRecord Class)

Expiration month of the credit card specified in CardNumber .

Syntax

• C++
• C
• Qt

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

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

int dpaymentssdk_fdmsrcdetailrecord_getcardexpmonth(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setcardexpmonth(void* lpObj, int iCardExpMonth);

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

Default Value

1

Remarks

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

Data Type

Integer

CardExpYear Property (FDMSRcDetailRecord Class)

Expiration year of the credit card specified in CardNumber .

Syntax

• C++
• C
• Qt

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

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

int dpaymentssdk_fdmsrcdetailrecord_getcardexpyear(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setcardexpyear(void* lpObj, int iCardExpYear);

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

Default Value

2000

Remarks

This field 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 cannot be specified.

Data Type

Integer

CardholderName Property (FDMSRcDetailRecord Class)

The name of the Cardholder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardholderName();
int SetCardholderName(const char* lpszCardholderName);

Unicode (Windows)
LPWSTR GetCardholderName();
INT SetCardholderName(LPCWSTR lpszCardholderName);

char* dpaymentssdk_fdmsrcdetailrecord_getcardholdername(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setcardholdername(void* lpObj, const char* lpszCardholderName);

QString GetCardholderName();
int SetCardholderName(QString qsCardholderName);

Default Value

""

Remarks

This property is used to specify the name of the cardholder.

Data Type

String

CardNumber Property (FDMSRcDetailRecord Class)

Customer's credit card number from the original authorization request.

Syntax

• C++
• C
• Qt

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

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

char* dpaymentssdk_fdmsrcdetailrecord_getcardnumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setcardnumber(void* lpObj, const char* lpszCardNumber);

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

Default Value

""

Remarks

This field contains the customer's credit card number used in the original authorization request. This alphanumeric field can be a maximum of 22 characters long, excluding whitespace and dashes which are stripped out when the property is set.

Data Type

String

CashBack Property (FDMSRcDetailRecord Class)

Amount of cash that was returned 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_fdmsrcdetailrecord_getcashback(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setcashback(void* lpObj, const char* lpszCashBack);

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

Default Value

""

Remarks

This property should reflect the cash back amount from the original debit or EBT card sale. The value sent in the settlement MUST be identical to the amount approved in the sale.

Data Type

String

DepartureDate Property (FDMSRcDetailRecord Class)

The departure date of the guest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepartureDate();
int SetDepartureDate(const char* lpszDepartureDate);

Unicode (Windows)
LPWSTR GetDepartureDate();
INT SetDepartureDate(LPCWSTR lpszDepartureDate);

char* dpaymentssdk_fdmsrcdetailrecord_getdeparturedate(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setdeparturedate(void* lpObj, const char* lpszDepartureDate);

QString GetDepartureDate();
int SetDepartureDate(QString qsDepartureDate);

Default Value

""

Remarks

Date the guest checked out, or the expected departure date when authorizing a reservation. The date specified should be in the format "MMDDYY".

Note: The Departure Date must be a date that is after the Arrival Date.

Data Type

String

Duration Property (FDMSRcDetailRecord Class)

Length of hotel stay in days.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDuration();
int SetDuration(int iDuration);

Unicode (Windows)
INT GetDuration();
INT SetDuration(INT iDuration);

int dpaymentssdk_fdmsrcdetailrecord_getduration(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setduration(void* lpObj, int iDuration);

int GetDuration();
int SetDuration(int iDuration);

Default Value

1

Remarks

The number of days the guest stayed in the hotel, or the expected duration of stay when authorizing a reservation. This field must be between 1 and 99 days.

Data Type

Integer

ECI Property (FDMSRcDetailRecord Class)

Identifies the security level of the ECommerce transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetECI();
int SetECI(const char* lpszECI);

Unicode (Windows)
LPWSTR GetECI();
INT SetECI(LPCWSTR lpszECI);

char* dpaymentssdk_fdmsrcdetailrecord_geteci(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_seteci(void* lpObj, const char* lpszECI);

QString GetECI();
int SetECI(QString qsECI);

Default Value

""

Remarks

This setting specifies the security level of the ECommerce transaction. In most cases this does not need to be changed. A common reason for modifying this value is when supplying 3-D secure values. Possible values are:

Data Type

String

ExtraCharges Property (FDMSRcDetailRecord Class)

List of extra charges for hotel transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExtraCharges();
int SetExtraCharges(const char* lpszExtraCharges);

Unicode (Windows)
LPWSTR GetExtraCharges();
INT SetExtraCharges(LPCWSTR lpszExtraCharges);

char* dpaymentssdk_fdmsrcdetailrecord_getextracharges(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setextracharges(void* lpObj, const char* lpszExtraCharges);

QString GetExtraCharges();
int SetExtraCharges(QString qsExtraCharges);

Default Value

""

Remarks

This property contains a six-character numeric value used to identify any additional ancillary charges that are booked to the cardholder's card after the transaction was completed. The merchant may enter one or more codes on each transaction being settled. If extra charges are being submitted, this field must contain value(s) as defined below.

For example, to indicate charges in both the gift shop and mini bar, ExtraCharges should equal "34".

This field is only applicable to Visa card transactions when IndustryType is Hotel and will not be sent for any other industry types.

Data Type

String

FolioNumber Property (FDMSRcDetailRecord Class)

The Folio or Room Agreement number assigned by the hotel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFolioNumber();
int SetFolioNumber(const char* lpszFolioNumber);

Unicode (Windows)
LPWSTR GetFolioNumber();
INT SetFolioNumber(LPCWSTR lpszFolioNumber);

char* dpaymentssdk_fdmsrcdetailrecord_getfolionumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setfolionumber(void* lpObj, const char* lpszFolioNumber);

QString GetFolioNumber();
int SetFolioNumber(QString qsFolioNumber);

Default Value

""

Remarks

This is a 12 alphanumeric code assigned by the hotel during the transaction.

Data Type

String

HotelNoShow Property (FDMSRcDetailRecord Class)

Indicates whether the guest did not show.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHotelNoShow();
int SetHotelNoShow(int bHotelNoShow);

Unicode (Windows)
BOOL GetHotelNoShow();
INT SetHotelNoShow(BOOL bHotelNoShow);

int dpaymentssdk_fdmsrcdetailrecord_gethotelnoshow(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_sethotelnoshow(void* lpObj, int bHotelNoShow);

bool GetHotelNoShow();
int SetHotelNoShow(bool bHotelNoShow);

Default Value

FALSE

Remarks

This property can be set to 'True' to indicate that the guest did not show.

Data Type

Boolean

IndustryType Property (FDMSRcDetailRecord 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);

FIT_RC_UNKNOWN(0), 
FIT_RC_RETAIL(1), 
FIT_RC_RESTAURANT(2), 
FIT_RC_GROCERY_STORE(3), 
FIT_RC_DIRECT_MARKETING(4), 
FIT_RC_HOTEL(5), 
FIT_RC_MOTO(6)

int dpaymentssdk_fdmsrcdetailrecord_getindustrytype(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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

InstallmentCount Property (FDMSRcDetailRecord Class)

Total number of installments (installment transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInstallmentCount();
int SetInstallmentCount(int iInstallmentCount);

Unicode (Windows)
INT GetInstallmentCount();
INT SetInstallmentCount(INT iInstallmentCount);

int dpaymentssdk_fdmsrcdetailrecord_getinstallmentcount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setinstallmentcount(void* lpObj, int iInstallmentCount);

int GetInstallmentCount();
int SetInstallmentCount(int iInstallmentCount);

Default Value

0

Remarks

This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSRcEcommerce class.

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

InstallmentNumber Property (FDMSRcDetailRecord Class)

Current installment number (installment transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInstallmentNumber();
int SetInstallmentNumber(int iInstallmentNumber);

Unicode (Windows)
INT GetInstallmentNumber();
INT SetInstallmentNumber(INT iInstallmentNumber);

int dpaymentssdk_fdmsrcdetailrecord_getinstallmentnumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setinstallmentnumber(void* lpObj, int iInstallmentNumber);

int GetInstallmentNumber();
int SetInstallmentNumber(int iInstallmentNumber);

Default Value

0

Remarks

This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSRcEcommerce class.

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

Level2CustomerReferenceNumber Property (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2customerreferencenumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2destinationcountrycode(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2destinationpostalcode(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2discountamount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2dutyamount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2freightamount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2merchanttaxid(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2productdescription(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2purchaseidentifier(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2shipfrompostalcode(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2taxamount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getlevel2taxindicator(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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

LodgingChargeType Property (FDMSRcDetailRecord Class)

Type of charge made at a hotel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLodgingChargeType();
int SetLodgingChargeType(int iLodgingChargeType);

Unicode (Windows)
INT GetLodgingChargeType();
INT SetLodgingChargeType(INT iLodgingChargeType);

LCT_LODGING(0), 
LCT_RESTAURANT(1), 
LCT_GIFT_SHOP(2)

int dpaymentssdk_fdmsrcdetailrecord_getlodgingchargetype(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setlodgingchargetype(void* lpObj, int iLodgingChargeType);

int GetLodgingChargeType();
int SetLodgingChargeType(int iLodgingChargeType);

Default Value

0

Remarks

This property contains an indicator used to identify a hotel charge type. It must contain one of the values defined below:

• lctLodging (0)
• lctRestaurant (1)
• lctGiftShop (2)

Note, this property is only applicable when using the Hotel IndustryType.

Data Type

Integer

LodgingPhoneNumber Property (FDMSRcDetailRecord Class)

Phone number of the property the customer stayed at.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLodgingPhoneNumber();
int SetLodgingPhoneNumber(const char* lpszLodgingPhoneNumber);

Unicode (Windows)
LPWSTR GetLodgingPhoneNumber();
INT SetLodgingPhoneNumber(LPCWSTR lpszLodgingPhoneNumber);

char* dpaymentssdk_fdmsrcdetailrecord_getlodgingphonenumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setlodgingphonenumber(void* lpObj, const char* lpszLodgingPhoneNumber);

QString GetLodgingPhoneNumber();
int SetLodgingPhoneNumber(QString qsLodgingPhoneNumber);

Default Value

""

Remarks

This 10 character field contains the customer service phone number without dashes or spaces. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "8001234567" is acceptable, while "18001234567" or "1-800-123-4567" is not.

Note, this property is only applicable when using the Hotel IndustryType.

Data Type

String

LodgingReferenceNumber Property (FDMSRcDetailRecord Class)

A reference number assigned by the hotel/lodging establishment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLodgingReferenceNumber();
int SetLodgingReferenceNumber(const char* lpszLodgingReferenceNumber);

Unicode (Windows)
LPWSTR GetLodgingReferenceNumber();
INT SetLodgingReferenceNumber(LPCWSTR lpszLodgingReferenceNumber);

char* dpaymentssdk_fdmsrcdetailrecord_getlodgingreferencenumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setlodgingreferencenumber(void* lpObj, const char* lpszLodgingReferenceNumber);

QString GetLodgingReferenceNumber();
int SetLodgingReferenceNumber(QString qsLodgingReferenceNumber);

Default Value

""

Remarks

This is a 9 character identifier assigned by the hotel/lodging for the transaction.

Data Type

String

MerchantServicePhone Property (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getmerchantservicephone(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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 fitRcMOTO transactions. It is recommended but not required for fitRcDirectMarketing and fitRcHotel transactions.

Data Type

String

MerchantURL Property (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getmerchanturl(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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.

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

This is only applicable when the IndustryType is set to fitRcDirectMarketing or fitRcHotel.

Data Type

String

OrderNumber Property (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getordernumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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

ProgramIndicator Property (FDMSRcDetailRecord Class)

Indicates the reason for the charge in a hotel transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProgramIndicator();
int SetProgramIndicator(int iProgramIndicator);

Unicode (Windows)
INT GetProgramIndicator();
INT SetProgramIndicator(INT iProgramIndicator);

int dpaymentssdk_fdmsrcdetailrecord_getprogramindicator(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setprogramindicator(void* lpObj, int iProgramIndicator);

int GetProgramIndicator();
int SetProgramIndicator(int iProgramIndicator);

Default Value

1

Remarks

This is used to specify the program indicator for a hotel/lodging transaction. This property is not applicable for Mastercards.

Valid Values:

Data Type

Integer

ReferenceNumber Property (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getreferencenumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setreferencenumber(void* lpObj, const char* lpszReferenceNumber);

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

Default Value

""

Remarks

This value is a merchant assigned 10 bytes value. The value must be unique within a day for a given merchant id and terminal id. The Reference Number entered in the DetailRecord should be the same as the Reference Number submitted in the original transaction.

Data Type

String

RoomNumber Property (FDMSRcDetailRecord Class)

The Room Number assigned by the hotel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRoomNumber();
int SetRoomNumber(const char* lpszRoomNumber);

Unicode (Windows)
LPWSTR GetRoomNumber();
INT SetRoomNumber(LPCWSTR lpszRoomNumber);

char* dpaymentssdk_fdmsrcdetailrecord_getroomnumber(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setroomnumber(void* lpObj, const char* lpszRoomNumber);

QString GetRoomNumber();
int SetRoomNumber(QString qsRoomNumber);

Default Value

""

Remarks

This is a 6 character room number code assigned by the hotel during the transaction.

Data Type

String

RoomRate Property (FDMSRcDetailRecord Class)

The daily room rate in a hotel transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRoomRate();
int SetRoomRate(const char* lpszRoomRate);

Unicode (Windows)
LPWSTR GetRoomRate();
INT SetRoomRate(LPCWSTR lpszRoomRate);

char* dpaymentssdk_fdmsrcdetailrecord_getroomrate(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setroomrate(void* lpObj, const char* lpszRoomRate);

QString GetRoomRate();
int SetRoomRate(QString qsRoomRate);

Default Value

""

Remarks

This property contains the daily rate for one room at the lodging property.

Data Type

String

RoomTax Property (FDMSRcDetailRecord Class)

The daily room tax amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRoomTax();
int SetRoomTax(const char* lpszRoomTax);

Unicode (Windows)
LPWSTR GetRoomTax();
INT SetRoomTax(LPCWSTR lpszRoomTax);

char* dpaymentssdk_fdmsrcdetailrecord_getroomtax(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setroomtax(void* lpObj, const char* lpszRoomTax);

QString GetRoomTax();
int SetRoomTax(QString qsRoomTax);

Default Value

""

Remarks

This property contains the daily Room Tax for lodging.

Data Type

String

SettlementAmount Property (FDMSRcDetailRecord Class)

The amount that the customer will be charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSettlementAmount();
int SetSettlementAmount(const char* lpszSettlementAmount);

Unicode (Windows)
LPWSTR GetSettlementAmount();
INT SetSettlementAmount(LPCWSTR lpszSettlementAmount);

char* dpaymentssdk_fdmsrcdetailrecord_getsettlementamount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_setsettlementamount(void* lpObj, const char* lpszSettlementAmount);

QString GetSettlementAmount();
int SetSettlementAmount(QString qsSettlementAmount);

Default Value

"0"

Remarks

This field contains the final settlement amount of the transaction. In most cases, this is the TransactionAmount from the original authorization request. However, you may settle a lesser amount (ie: Partial shipment or backordered stock).

This field must always be greater than 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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

STAN Property (FDMSRcDetailRecord 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_fdmsrcdetailrecord_getstan(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_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

TotalAuthorizedAmount Property (FDMSRcDetailRecord Class)

Sum total of all the original authorization and all subsequent incremental authorizations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalAuthorizedAmount();
int SetTotalAuthorizedAmount(const char* lpszTotalAuthorizedAmount);

Unicode (Windows)
LPWSTR GetTotalAuthorizedAmount();
INT SetTotalAuthorizedAmount(LPCWSTR lpszTotalAuthorizedAmount);

char* dpaymentssdk_fdmsrcdetailrecord_gettotalauthorizedamount(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_settotalauthorizedamount(void* lpObj, const char* lpszTotalAuthorizedAmount);

QString GetTotalAuthorizedAmount();
int SetTotalAuthorizedAmount(QString qsTotalAuthorizedAmount);

Default Value

""

Remarks

When supporting incremental authorizations, you must manually keep track of the sum of all authorizations made for a single transaction (all based on the same transaction id). This total must be added to the TotalAuthorizedAmount property of the detail record associated with the first authorization. Only one detail record should be submitted no matter how many incremental authorizations are attached to the transaction.

Data Type

String

TransactionType Property (FDMSRcDetailRecord Class)

Indicates transaction type for this detail record.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionType();
int SetTransactionType(int iTransactionType);

Unicode (Windows)
INT GetTransactionType();
INT SetTransactionType(INT iTransactionType);

FTT_NOT_SET(0), 
FTT_AUTHORIZATION(1), 
FTT_AUTHORIZATION_WITH_CASHBACK(2), 
FTT_VOICE_APPROVED(3), 
FTT_EBTCASH_AUTHORIZATION_WITHOUT_CASHBACK(4), 
FTT_REFUND_CREDIT(5), 
FTT_EBTCASH_AUTHORIZATION_WITH_CASHBACK(6), 
FTT_EBTCASH_AUTHORIZATION_CASHBACK_ONLY(7), 
FTT_EBTSNAPAUTHORIZATION(8), 
FTT_EBTSNAPVOUCHER_CLEAR(9), 
FTT_NO_SHOW_CREDIT(10), 
FTT_NO_SHOW_DEBIT(11), 
FTT_MOTOAUTHORIZATION(12), 
FTT_REFUND_DEBIT(13), 
FTT_REFUND_EBTSNAP(14)

int dpaymentssdk_fdmsrcdetailrecord_gettransactiontype(void* lpObj);
int dpaymentssdk_fdmsrcdetailrecord_settransactiontype(void* lpObj, int iTransactionType);

int GetTransactionType();
int SetTransactionType(int iTransactionType);

Default Value

0

Remarks

This property indicates the type of transaction that is being settled. The following table explains the Transaction Types in detail:

Data Type

Integer

Config Method (FDMSRcDetailRecord Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

GetDetailAggregate Method (FDMSRcDetailRecord Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDetailAggregate();

Unicode (Windows)
LPWSTR GetDetailAggregate();

char* dpaymentssdk_fdmsrcdetailrecord_getdetailaggregate(void* lpObj);

QString GetDetailAggregate();

Remarks

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

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

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

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

Error Handling (C++)

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

ParseAggregate Method (FDMSRcDetailRecord Class)

Parses the aggregate returned from another class's GetDetailAggregate method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseAggregate(const char* lpszAggregate);

Unicode (Windows)
INT ParseAggregate(LPCWSTR lpszAggregate);

int dpaymentssdk_fdmsrcdetailrecord_parseaggregate(void* lpObj, const char* lpszAggregate);

int ParseAggregate(const QString& qsAggregate);

Remarks

This method takes the XML aggregate returned from the FDMSRcRetail or FDMSRcECommerce class, parses it, and then fills all the properties of the FDMSRcDetailrecord class. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSRcSettle class, sometimes it is necessary to adjust the contents of the XML aggregate first.

Error Handling (C++)

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

Reset Method (FDMSRcDetailRecord Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmsrcdetailrecord_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

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

Error Event (FDMSRcDetailRecord Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSRCDETAILRECORD_ERROR 1

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

class FDMSRcDetailRecordErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Config Settings (FDMSRcDetailRecord Class)

FDMSRcDetailRecord Config Settings

Base Config Settings

Trappable Errors (FDMSRcDetailRecord Class)

Error Handling (C++)

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

FDMSRcDetailRecord Errors