FDMSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSLevel2 class is a tool used to create Level2 Corporate Purchasing Card addendum aggregates, which can then be passed to the FDMSSETTLE class and settled.

Syntax

FDMSLevel2

Remarks

The properties required to build a Level 2 addendum depends upon the value of the CardType property. The following tables indicate which properties are valid for what card type:

American Express

• DestinationZip (required)
• PurchaseIdentifier (required)
• TaxAmount (required)

Visa

• PurchaseIdentifier (required)
• CommercialCardType (optional)
• InvoiceNumber (optional)
• DestinationCountry (optional)
• DestinationZip (optional)
• DiscountAmount (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• FreightTaxAmount (optional)
• FreightTaxRate (optional)
• MerchantReference (optional)
• OrderDate (optional)
• ShippedFromZip (optional)
• TaxAmount (optional)

MasterCard

• MerchantTaxId (required)
• MerchantType (required)
• PurchaseIdentifier (required)
• TaxAmount (required)
• CommercialCardType (optional)
• DestinationCountry (optional)
• DestinationState (optional)
• DestinationZip (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• MerchantReference (optional)
• ShippedFromZip (optional)

The following example illustrates how to add Level 2 data to a transaction to be settled:

FDMSECommerce.Authorize() FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "060828" 'September 28th, 2006 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.InvoiceNumber = "CUSTCODE" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum()

Note that while Level 2 addendum data is only applicable to corporate purchasing cards, you may send Level 2 data for all Visa, Master Card, and American Express cards if you wish.

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.

CardType Property (FDMSLevel2 Class)

The card type for which a Level 2 or Level 3 addendum will be created.

Syntax

• C++
• C
• Qt

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

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

FCT_UNKNOWN(0), 
FCT_VISA(1), 
FCT_MASTER_CARD(2), 
FCT_AMERICAN_EXPRESS(3)

int dpaymentssdk_fdmslevel2_getcardtype(void* lpObj);
int dpaymentssdk_fdmslevel2_setcardtype(void* lpObj, int iCardType);

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

Default Value

0

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

Data Type

Integer

CommercialCardType Property (FDMSLevel2 Class)

Indicates the type of commercial card being settled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommercialCardType();
int SetCommercialCardType(int iCommercialCardType);

Unicode (Windows)
INT GetCommercialCardType();
INT SetCommercialCardType(INT iCommercialCardType);

FCC_NOT_COMMERCIAL(0), 
FCC_PURCHASE_CARD(1), 
FCC_CORPORATE_CARD(2), 
FCC_BUSINESS_CARD(3), 
FCC_UNKNOWN(4)

int dpaymentssdk_fdmslevel2_getcommercialcardtype(void* lpObj);
int dpaymentssdk_fdmslevel2_setcommercialcardtype(void* lpObj, int iCommercialCardType);

int GetCommercialCardType();
int SetCommercialCardType(int iCommercialCardType);

Default Value

0

Remarks

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

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

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

Integer

DestinationCountry Property (FDMSLevel2 Class)

Country the goods are to be shipped to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationCountry();
int SetDestinationCountry(const char* lpszDestinationCountry);

Unicode (Windows)
LPWSTR GetDestinationCountry();
INT SetDestinationCountry(LPCWSTR lpszDestinationCountry);

char* dpaymentssdk_fdmslevel2_getdestinationcountry(void* lpObj);
int dpaymentssdk_fdmslevel2_setdestinationcountry(void* lpObj, const char* lpszDestinationCountry);

QString GetDestinationCountry();
int SetDestinationCountry(QString qsDestinationCountry);

Default Value

""

Remarks

For Visa and MasterCard transactions, this property contains the three-digit numeric code of the country where the goods are being shipped. These codes are specified by ISO-3166. For the United States, use "840".

The maximum length of this property is 3 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

DestinationState Property (FDMSLevel2 Class)

State or province to which the goods are to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationState();
int SetDestinationState(const char* lpszDestinationState);

Unicode (Windows)
LPWSTR GetDestinationState();
INT SetDestinationState(LPCWSTR lpszDestinationState);

char* dpaymentssdk_fdmslevel2_getdestinationstate(void* lpObj);
int dpaymentssdk_fdmslevel2_setdestinationstate(void* lpObj, const char* lpszDestinationState);

QString GetDestinationState();
int SetDestinationState(QString qsDestinationState);

Default Value

""

Remarks

This property contains the State or Province where purchased goods will be delivered. The maximum length of this property is 3 characters. This property is only used for MasterCard Corporate Purchasing Cards.

Data Type

String

DestinationZip Property (FDMSLevel2 Class)

The zip code to which the commodity was shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationZip();
int SetDestinationZip(const char* lpszDestinationZip);

Unicode (Windows)
LPWSTR GetDestinationZip();
INT SetDestinationZip(LPCWSTR lpszDestinationZip);

char* dpaymentssdk_fdmslevel2_getdestinationzip(void* lpObj);
int dpaymentssdk_fdmslevel2_setdestinationzip(void* lpObj, const char* lpszDestinationZip);

QString GetDestinationZip();
int SetDestinationZip(QString qsDestinationZip);

Default Value

""

Remarks

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place. In this case, both DestinationZip and ShippedFromZip should be identical.

The maximum length for this property is 10 characters.

This property is used for Visa, MasterCard, and American Express Corporate Purchasing Cards.

Data Type

String

DiscountAmount Property (FDMSLevel2 Class)

Amount of any discount subtracted from the line item totals.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscountAmount();
int SetDiscountAmount(const char* lpszDiscountAmount);

Unicode (Windows)
LPWSTR GetDiscountAmount();
INT SetDiscountAmount(LPCWSTR lpszDiscountAmount);

char* dpaymentssdk_fdmslevel2_getdiscountamount(void* lpObj);
int dpaymentssdk_fdmslevel2_setdiscountamount(void* lpObj, const char* lpszDiscountAmount);

QString GetDiscountAmount();
int SetDiscountAmount(QString qsDiscountAmount);

Default Value

""

Remarks

This property contains the amount of any discount applied to the transaction by the merchant. This field should be empty if no line item discount applies, or if Level 3 data is attached to the transaction, and contains discount amounts for individual items on an item-by-item basis.

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.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

DutyAmount Property (FDMSLevel2 Class)

Duty fees (if any) for imported goods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutyAmount();
int SetDutyAmount(const char* lpszDutyAmount);

Unicode (Windows)
LPWSTR GetDutyAmount();
INT SetDutyAmount(LPCWSTR lpszDutyAmount);

char* dpaymentssdk_fdmslevel2_getdutyamount(void* lpObj);
int dpaymentssdk_fdmslevel2_setdutyamount(void* lpObj, const char* lpszDutyAmount);

QString GetDutyAmount();
int SetDutyAmount(QString qsDutyAmount);

Default Value

""

Remarks

This property contains the fee amount associated with the import of the purchased goods.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

FreightAmount Property (FDMSLevel2 Class)

Shipping charges associated with this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightAmount();
int SetFreightAmount(const char* lpszFreightAmount);

Unicode (Windows)
LPWSTR GetFreightAmount();
INT SetFreightAmount(LPCWSTR lpszFreightAmount);

char* dpaymentssdk_fdmslevel2_getfreightamount(void* lpObj);
int dpaymentssdk_fdmslevel2_setfreightamount(void* lpObj, const char* lpszFreightAmount);

QString GetFreightAmount();
int SetFreightAmount(QString qsFreightAmount);

Default Value

""

Remarks

This property contains the freight or shipping portion of the total transaction amount.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

FreightTaxAmount Property (FDMSLevel2 Class)

Portion of the FreightAmount that is tax.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightTaxAmount();
int SetFreightTaxAmount(const char* lpszFreightTaxAmount);

Unicode (Windows)
LPWSTR GetFreightTaxAmount();
INT SetFreightTaxAmount(LPCWSTR lpszFreightTaxAmount);

char* dpaymentssdk_fdmslevel2_getfreighttaxamount(void* lpObj);
int dpaymentssdk_fdmslevel2_setfreighttaxamount(void* lpObj, const char* lpszFreightTaxAmount);

QString GetFreightTaxAmount();
int SetFreightTaxAmount(QString qsFreightTaxAmount);

Default Value

""

Remarks

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the freight or shipping charges of the overall purchase.

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.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

FreightTaxRate Property (FDMSLevel2 Class)

Rate used to calculate the FreightTaxAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightTaxRate();
int SetFreightTaxRate(const char* lpszFreightTaxRate);

Unicode (Windows)
LPWSTR GetFreightTaxRate();
INT SetFreightTaxRate(LPCWSTR lpszFreightTaxRate);

char* dpaymentssdk_fdmslevel2_getfreighttaxrate(void* lpObj);
int dpaymentssdk_fdmslevel2_setfreighttaxrate(void* lpObj, const char* lpszFreightTaxRate);

QString GetFreightTaxRate();
int SetFreightTaxRate(QString qsFreightTaxRate);

Default Value

""

Remarks

This property contains the tax rate used to calculate the FreightTaxAmount. This field has a two-digit implied decimal position, and the maximum length is 4 digits.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

InvoiceNumber Property (FDMSLevel2 Class)

Customer Reference Identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber);

Unicode (Windows)
LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);

char* dpaymentssdk_fdmslevel2_getinvoicenumber(void* lpObj);
int dpaymentssdk_fdmslevel2_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);

Default Value

""

Remarks

This property contains the Customer Reference Indicator, used by the customer to identify the purchase (e.g., the invoice number). The maximum length of this property is 17 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

MerchantReference Property (FDMSLevel2 Class)

Merchant Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantReference();
int SetMerchantReference(const char* lpszMerchantReference);

Unicode (Windows)
LPWSTR GetMerchantReference();
INT SetMerchantReference(LPCWSTR lpszMerchantReference);

char* dpaymentssdk_fdmslevel2_getmerchantreference(void* lpObj);
int dpaymentssdk_fdmslevel2_setmerchantreference(void* lpObj, const char* lpszMerchantReference);

QString GetMerchantReference();
int SetMerchantReference(QString qsMerchantReference);

Default Value

""

Remarks

For Master Card, this property contains the code that facilitates merchant/corporation communication and record keeping. For Visa, this property contains the invoice number associated with the VAT invoice (not applicable in the US).

The maximum length of this property is 15 characters for Visa and 17 characters for MasterCard.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

MerchantTaxId Property (FDMSLevel2 Class)

Merchant's government tax Id number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTaxId();
int SetMerchantTaxId(const char* lpszMerchantTaxId);

Unicode (Windows)
LPWSTR GetMerchantTaxId();
INT SetMerchantTaxId(LPCWSTR lpszMerchantTaxId);

char* dpaymentssdk_fdmslevel2_getmerchanttaxid(void* lpObj);
int dpaymentssdk_fdmslevel2_setmerchanttaxid(void* lpObj, const char* lpszMerchantTaxId);

QString GetMerchantTaxId();
int SetMerchantTaxId(QString qsMerchantTaxId);

Default Value

""

Remarks

This property contains the government-assigned tax identification number of the merchant from whom the goods or services were purchased.

The maximum length of this property is 15 characters. This property is only used for MasterCard Corporate Purchasing Cards.

Data Type

String

MerchantType Property (FDMSLevel2 Class)

MasterCard merchant classification code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantType();
int SetMerchantType(const char* lpszMerchantType);

Unicode (Windows)
LPWSTR GetMerchantType();
INT SetMerchantType(LPCWSTR lpszMerchantType);

char* dpaymentssdk_fdmslevel2_getmerchanttype(void* lpObj);
int dpaymentssdk_fdmslevel2_setmerchanttype(void* lpObj, const char* lpszMerchantType);

QString GetMerchantType();
int SetMerchantType(QString qsMerchantType);

Default Value

"0000"

Remarks

Merchant Type is a four-position field defined by MasterCard that describes various merchant classifications. Each position in the field has a separate, special meaning for categorizing the merchant. If the data for a particular position is not available, that position must contain a blank. If it is available, it must contain one of the following business codes:

Position 1 - Business Classification

Position 2 - Type of Business Owner Classification

Position 3 - Minority, Small Business, Disadvantaged Certification

Position 4 - Racial or Ethnic Type (Unconditional Majority Owner)

The maximum length of this property is 4 characters. This property is only used for MasterCard Corporate Purchasing Cards.

Data Type

String

OrderDate Property (FDMSLevel2 Class)

Date of the order in YYMMDD format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrderDate();
int SetOrderDate(const char* lpszOrderDate);

Unicode (Windows)
LPWSTR GetOrderDate();
INT SetOrderDate(LPCWSTR lpszOrderDate);

char* dpaymentssdk_fdmslevel2_getorderdate(void* lpObj);
int dpaymentssdk_fdmslevel2_setorderdate(void* lpObj, const char* lpszOrderDate);

QString GetOrderDate();
int SetOrderDate(QString qsOrderDate);

Default Value

""

Remarks

This property contains the purchase order date, and must be supplied in the YYMMDD format.

The maximum length of this field is 6 digits.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

PurchaseIdentifier Property (FDMSLevel2 Class)

Used to identify the purchase.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPurchaseIdentifier();
int SetPurchaseIdentifier(const char* lpszPurchaseIdentifier);

Unicode (Windows)
LPWSTR GetPurchaseIdentifier();
INT SetPurchaseIdentifier(LPCWSTR lpszPurchaseIdentifier);

char* dpaymentssdk_fdmslevel2_getpurchaseidentifier(void* lpObj);
int dpaymentssdk_fdmslevel2_setpurchaseidentifier(void* lpObj, const char* lpszPurchaseIdentifier);

QString GetPurchaseIdentifier();
int SetPurchaseIdentifier(QString qsPurchaseIdentifier);

Default Value

""

Remarks

This field is required for Visa, MasterCard and Amex Level2 transactions.For Visa this field should contain a merchant assigned value to identify the purchase such as the SKU number. For MasterCard this field should contain the code that was supplied to the merchant by the cardholder. For Amex this field should contain the customer reference number. The maximum length of this property is 25 characters.

Data Type

String

ShippedFromZip Property (FDMSLevel2 Class)

Zip code the goods are being shipped from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippedFromZip();
int SetShippedFromZip(const char* lpszShippedFromZip);

Unicode (Windows)
LPWSTR GetShippedFromZip();
INT SetShippedFromZip(LPCWSTR lpszShippedFromZip);

char* dpaymentssdk_fdmslevel2_getshippedfromzip(void* lpObj);
int dpaymentssdk_fdmslevel2_setshippedfromzip(void* lpObj, const char* lpszShippedFromZip);

QString GetShippedFromZip();
int SetShippedFromZip(QString qsShippedFromZip);

Default Value

""

Remarks

This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

TaxAmount Property (FDMSLevel2 Class)

Sales tax charged in addition to the original TransactionAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxAmount();
int SetTaxAmount(const char* lpszTaxAmount);

Unicode (Windows)
LPWSTR GetTaxAmount();
INT SetTaxAmount(LPCWSTR lpszTaxAmount);

char* dpaymentssdk_fdmslevel2_gettaxamount(void* lpObj);
int dpaymentssdk_fdmslevel2_settaxamount(void* lpObj, const char* lpszTaxAmount);

QString GetTaxAmount();
int SetTaxAmount(QString qsTaxAmount);

Default Value

""

Remarks

This property contains the amount of state or provincial (or VAT) tax included in the transaction amount. Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

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.

This property is used for Visa, MasterCard, and American Express Corporate Purchasing Cards.

Data Type

String

Config Method (FDMSLevel2 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_fdmslevel2_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.

GetAddendum Method (FDMSLevel2 Class)

Returns a Level 2 Purchasing card addendum based on the specified CardType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAddendum();

Unicode (Windows)
LPWSTR GetAddendum();

char* dpaymentssdk_fdmslevel2_getaddendum(void* lpObj);

QString GetAddendum();

Remarks

The properties required to build a Level 2 addendum depends upon the value of the CardType property. The following tables indicate which properties are valid for what card type:

American Express

• DestinationZip (required)
• PurchaseIdentifier (required)
• TaxAmount (required)

Visa

• PurchaseIdentifier (required)
• CommercialCardType (optional)
• InvoiceNumber (optional)
• DestinationCountry (optional)
• DestinationZip (optional)
• DiscountAmount (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• FreightTaxAmount (optional)
• FreightTaxRate (optional)
• MerchantReference (optional)
• OrderDate (optional)
• ShippedFromZip (optional)
• TaxAmount (optional)

MasterCard

• MerchantTaxId (required)
• MerchantType (required)
• PurchaseIdentifier (required)
• TaxAmount (required)
• CommercialCardType (optional)
• DestinationCountry (optional)
• DestinationState (optional)
• DestinationZip (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• MerchantReference (optional)
• ShippedFromZip (optional)

The following example illustrates how to add Level 2 data to a transaction to be settled:

FDMSECommerce.Authorize() FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "060828" 'September 28th, 2006 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.InvoiceNumber = "CUSTCODE" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum()

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.

Reset Method (FDMSLevel2 Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmslevel2_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 (FDMSLevel2 Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSLEVEL2_ERROR 1

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

class FDMSLevel2ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Base Config Settings

Trappable Errors (FDMSLevel2 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.

FDMSLevel2 Errors