FDMSLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

FDMSLevel3

Remarks

This Level3Extension class creates Level 3 addendum data, which can be sent in the settlement to achieve a better interchange rate when accepting corporate purchasing cards. The Level 3 addendum allows the merchant to send very detailed information about every item that was purchased by the card holder, as well as tax and shipping information.

This class creates a different addendum aggregate based on the CardType. Visa and MasterCard addendums differ slightly, and therefore a slightly different set of properties are required for each.

List of valid Line Item properties for Visa:

List of valid Line Item properties for Mastercard:

The following example illustrates how to build a Level 3 addendum for the fctVisa CardType: 

 
 Copy
  'First, authorize the credit card
  FDMSECommerce.TransactionAmount = "2720" '$27.20
  FDMSECommerce.Authorize()

  'Then, put the result into the settlement component
  FDMSSettle.DetailRecordCount = 1
  FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate()

  'Then build the Level 2 portion
  FDMSLevel2.CardType = fctVisa
  FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard  
  FDMSLevel2.OrderDate = "230928" 'September 28th, 2023
  FDMSLevel2.FreightTaxAmount = "0"
  FDMSLevel2.FreightAmount = "600" '$6.00
  FDMSLevel2.PurchaseIdentifier = "123456PURCHID"
  FDMSLevel2.ShippedToZip = "90210"
  FDMSLevel2.ShippedFromZip = "90210"
  FDMSLevel2.TaxAmount = "120"  '$1.20
  
  'Now build the Level 3 portion

  FDMSLevel3.CardType = fctVisa
  FDMSLevel3.LineItemCount = 2

  FDMSLevel3.ItemCommodityCode(0) = "4900" ' Books and printed materials
  FDMSLevel3.ItemDescription(0) = "Reference manual"
  FDMSLevel3.ItemDiscountAmount(0) = "" ' No discount
  FDMSLevel3.ItemProductCode(0) = "ISBN123456"
  FDMSLevel3.ItemTaxAmount(0) = "60" '$0.60
  FDMSLevel3.ItemTaxRate(0) = "600"  '6.00 percent
  FDMSLevel3.ItemQuantity(0) = "2"
  FDMSLevel3.ItemUnitCost(0) = "500" '$5.00
  FDMSLevel3.ItemTotal(0) = "1060"   '$10.60
  FDMSLevel3.ItemUnits(0) = "each"

  FDMSLevel3.ItemCommodityCode(1) = "4900" ' Books and printed materials
  FDMSLevel3.ItemDescription(1) = "Quick Start manual"
  FDMSLevel3.ItemDiscountAmount(1) = "" ' No discount
  FDMSLevel3.ItemProductCode(1) = "ISBN654321"
  FDMSLevel3.ItemTaxAmount(1) = "60"  '$0.60
  FDMSLevel3.ItemTaxRate(1) = "600"   '6.00 percent
  FDMSLevel3.ItemQuantity(1) = "1"
  FDMSLevel3.ItemUnitCost(1) = "1000" '$10.00
  FDMSLevel3.ItemTotal(1) = "1060"    '$10.60
  FDMSLevel3.ItemUnits(1) = "each"

  'Finally, add the Level 2 and Level 3 addendum data to the settlement at the same index
  'as the associated transaction.
  FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum() & FDMSLevel3.GetAddendum()

A Level 3 addendum for the fctMasterCard CardType is constructed similarly:

NOTE: You must send both a Level 2 addendum and a Level 3 addendum together in the same DetailAddendum. Level 3 data cannot be processed without a corresponding Level2 aggregate (however, you can send Level 2 data without Level 3 data).

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

CardTypeThe card type for which a Level 2 or Level 3 addendum will be created.
LineItemsA collection of line items to be included in the Level 3 addendum.
MerchantTaxIdMerchant's tax Id number assigned by the taxing authority.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
GetAddendumReturns a Level 3 Purchasing card addendum based on the specified CardType .
ResetClears all properties to their default values.

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.

ErrorFired when information is available about errors during data delivery.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

CardType Property (FDMSLevel3 Class)

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

Syntax

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

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

Possible Values

FCT_UNKNOWN(0), 
FCT_VISA(1), 
FCT_MASTER_CARD(2), 
FCT_AMERICAN_EXPRESS(3)
int dpaymentssdk_fdmslevel3_getcardtype(void* lpObj);
int dpaymentssdk_fdmslevel3_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:

fctVisa (1)Creates a Group 22 addendum for Visa or MasterCards.
fctMasterCard (2)Creates a Group 22 addendum for Visa or MasterCards.
fctAmericanExpress (3)Creates a Group 21 addendum for American Express cards (NOTE: American Express is not available for Level 3).

Data Type

Integer

LineItems Property (FDMSLevel3 Class)

A collection of line items to be included in the Level 3 addendum.

Syntax

int dpaymentssdk_fdmslevel3_getlineitemcount(void* lpObj);
int dpaymentssdk_fdmslevel3_setlineitemcount(void* lpObj, int iLineItemCount);

char* dpaymentssdk_fdmslevel3_getitemcommoditycode(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemcommoditycode(void* lpObj, int itemindex, const char* lpszItemCommodityCode);

char* dpaymentssdk_fdmslevel3_getitemdescription(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

char* dpaymentssdk_fdmslevel3_getitemdiscountamount(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemdiscountamount(void* lpObj, int itemindex, const char* lpszItemDiscountAmount);

char* dpaymentssdk_fdmslevel3_getitemnationaltaxamount(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemnationaltaxamount(void* lpObj, int itemindex, const char* lpszItemNationalTaxAmount);

char* dpaymentssdk_fdmslevel3_getitemothertaxamount(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemothertaxamount(void* lpObj, int itemindex, const char* lpszItemOtherTaxAmount);

char* dpaymentssdk_fdmslevel3_getitemproductcode(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemproductcode(void* lpObj, int itemindex, const char* lpszItemProductCode);

int dpaymentssdk_fdmslevel3_getitemquantity(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemquantity(void* lpObj, int itemindex, int iItemQuantity);

char* dpaymentssdk_fdmslevel3_getitemquantityexponent(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemquantityexponent(void* lpObj, int itemindex, const char* lpszItemQuantityExponent);

char* dpaymentssdk_fdmslevel3_getitemtaxamount(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemtaxamount(void* lpObj, int itemindex, const char* lpszItemTaxAmount);

int dpaymentssdk_fdmslevel3_getitemtaxincluded(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemtaxincluded(void* lpObj, int itemindex, int bItemTaxIncluded);

char* dpaymentssdk_fdmslevel3_getitemtaxrate(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemtaxrate(void* lpObj, int itemindex, const char* lpszItemTaxRate);

int dpaymentssdk_fdmslevel3_getitemtaxtype(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemtaxtype(void* lpObj, int itemindex, int iItemTaxType);

char* dpaymentssdk_fdmslevel3_getitemtotal(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemtotal(void* lpObj, int itemindex, const char* lpszItemTotal);

char* dpaymentssdk_fdmslevel3_getitemunitcost(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemunitcost(void* lpObj, int itemindex, const char* lpszItemUnitCost);

char* dpaymentssdk_fdmslevel3_getitemunits(void* lpObj, int itemindex);
int dpaymentssdk_fdmslevel3_setitemunits(void* lpObj, int itemindex, const char* lpszItemUnits);


int GetLineItemCount();
int SetLineItemCount(int iLineItemCount);

QString GetItemCommodityCode(int iItemIndex);
int SetItemCommodityCode(int iItemIndex, QString qsItemCommodityCode);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

QString GetItemDiscountAmount(int iItemIndex);
int SetItemDiscountAmount(int iItemIndex, QString qsItemDiscountAmount);

QString GetItemNationalTaxAmount(int iItemIndex);
int SetItemNationalTaxAmount(int iItemIndex, QString qsItemNationalTaxAmount);

QString GetItemOtherTaxAmount(int iItemIndex);
int SetItemOtherTaxAmount(int iItemIndex, QString qsItemOtherTaxAmount);

QString GetItemProductCode(int iItemIndex);
int SetItemProductCode(int iItemIndex, QString qsItemProductCode);

int GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, int iItemQuantity);

QString GetItemQuantityExponent(int iItemIndex);
int SetItemQuantityExponent(int iItemIndex, QString qsItemQuantityExponent);

QString GetItemTaxAmount(int iItemIndex);
int SetItemTaxAmount(int iItemIndex, QString qsItemTaxAmount);

bool GetItemTaxIncluded(int iItemIndex);
int SetItemTaxIncluded(int iItemIndex, bool bItemTaxIncluded);

QString GetItemTaxRate(int iItemIndex);
int SetItemTaxRate(int iItemIndex, QString qsItemTaxRate);

int GetItemTaxType(int iItemIndex);
int SetItemTaxType(int iItemIndex, int iItemTaxType);

QString GetItemTotal(int iItemIndex);
int SetItemTotal(int iItemIndex, QString qsItemTotal);

QString GetItemUnitCost(int iItemIndex);
int SetItemUnitCost(int iItemIndex, QString qsItemUnitCost);

QString GetItemUnits(int iItemIndex);
int SetItemUnits(int iItemIndex, QString qsItemUnits);

Remarks

This property contains a collection of line items to be included in the Level 3 addendum.

This property is used for both Visa and MasterCard Corporate Purchasing Cards. However, the line item fields that each card supports are different.

List of valid Line Item properties for Visa:

List of valid Line Item properties for Mastercard:

An example of setting two line items for a Visa Corporate purchasing card follows:

 
 Copy

  FDMSLevel3.CardType = fctVisa

  FDMSLevel3.LineItems.Add(new FDMSLineItem());
  FDMSLevel3.LineItems[0].CommodityCode = "4900" // Books and printed materials
  FDMSLevel3.LineItems[0].Description = "Reference manual"
  FDMSLevel3.LineItems[0].DiscountAmount = "" // No discount
  FDMSLevel3.LineItems[0].ProductCode = "ISBN123456"
  FDMSLevel3.LineItems[0].Quantity = "2"
  FDMSLevel3.LineItems[0].QuantityExponent = "0"
  FDMSLevel3.LineItems[0].UnitCost = "500"  // $5.00
  FDMSLevel3.LineItems[0].TaxAmount = "60"  // $0.60
  FDMSLevel3.LineItems[0].TaxRate = "600"   // 6.00 percent
  FDMSLevel3.LineItems[0].Total = "1060"    // $10.60
  FDMSLevel3.LineItems[0].Units = "each"

  FDMSLevel3.LineItems.Add(new FDMSLineItem());
  FDMSLevel3.LineItems[1].CommodityCode = "4900" // Books and printed materials
  FDMSLevel3.LineItems[1].Description = "Quick Start manual"
  FDMSLevel3.LineItems[1].DiscountAmount = "" // No discount
  FDMSLevel3.LineItems[1].ProductCode = "ISBN654321"
  FDMSLevel3.LineItems[1].UnitCost = "1000" // $10.00
  FDMSLevel3.LineItems[1].Quantity = "1"
  FDMSLevel3.LineItems[1].TaxRate = "600"   // 6.00 percent
  FDMSLevel3.LineItems[1].TaxAmount = "60"  // $0.60
  FDMSLevel3.LineItems[1].Total = "1060"    // $10.60
  FDMSLevel3.LineItems[1].Units = "each"

Data Type

DPaymentsSDKFDMSLineItem

MerchantTaxId Property (FDMSLevel3 Class)

Merchant's tax Id number assigned by the taxing authority.

Syntax

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

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

char* dpaymentssdk_fdmslevel3_getmerchanttaxid(void* lpObj);
int dpaymentssdk_fdmslevel3_setmerchanttaxid(void* lpObj, const char* lpszMerchantTaxId);
QString GetMerchantTaxId();
int SetMerchantTaxId(QString qsMerchantTaxId);

Default Value

""

Remarks

This property contains the VAT identification number of the merchant from whom the goods or services were purchased.

The maximum length of this property is 20 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

Config Method (FDMSLevel3 Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_fdmslevel3_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 (FDMSLevel3 Class)

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

Syntax

ANSI (Cross Platform)
char* GetAddendum();

Unicode (Windows)
LPWSTR GetAddendum();

char* dpaymentssdk_fdmslevel3_getaddendum(void* lpObj);

QString GetAddendum();

Remarks

The type of addendum created by this class depends upon the value of the CardType property. Different addendums are created when the CardType is set to fctVisa or fctMasterCard, and different properties are required for the two different CardTypes.

List of valid Line Item properties for Visa:

List of valid Line Item properties for Mastercard:

The following example illustrates how to build a Level 3 addendum for the fctVisa CardType: 

 
 Copy
  'First, authorize the credit card
  FDMSECommerce.TransactionAmount = "2720" '$27.20
  FDMSECommerce.Authorize()

  'Then, put the result into the settlement component
  FDMSSettle.DetailRecordCount = 1
  FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate()

  'Then build the Level 2 portion
  FDMSLevel2.CardType = fctVisa
  FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard  
  FDMSLevel2.OrderDate = "230928" 'September 28th, 2023
  FDMSLevel2.FreightTaxAmount = "0"
  FDMSLevel2.FreightAmount = "600" '$6.00
  FDMSLevel2.PurchaseIdentifier = "123456PURCHID"
  FDMSLevel2.ShippedToZip = "90210"
  FDMSLevel2.ShippedFromZip = "90210"
  FDMSLevel2.TaxAmount = "120"  '$1.20
  
  'Now build the Level 3 portion

  FDMSLevel3.CardType = fctVisa
  FDMSLevel3.LineItemCount = 2

  FDMSLevel3.ItemCommodityCode(0) = "4900" ' Books and printed materials
  FDMSLevel3.ItemDescription(0) = "Reference manual"
  FDMSLevel3.ItemDiscountAmount(0) = "" ' No discount
  FDMSLevel3.ItemProductCode(0) = "ISBN123456"
  FDMSLevel3.ItemTaxAmount(0) = "60" '$0.60
  FDMSLevel3.ItemTaxRate(0) = "600"  '6.00 percent
  FDMSLevel3.ItemQuantity(0) = "2"
  FDMSLevel3.ItemUnitCost(0) = "500" '$5.00
  FDMSLevel3.ItemTotal(0) = "1060"   '$10.60
  FDMSLevel3.ItemUnits(0) = "each"

  FDMSLevel3.ItemCommodityCode(1) = "4900" ' Books and printed materials
  FDMSLevel3.ItemDescription(1) = "Quick Start manual"
  FDMSLevel3.ItemDiscountAmount(1) = "" ' No discount
  FDMSLevel3.ItemProductCode(1) = "ISBN654321"
  FDMSLevel3.ItemTaxAmount(1) = "60"  '$0.60
  FDMSLevel3.ItemTaxRate(1) = "600"   '6.00 percent
  FDMSLevel3.ItemQuantity(1) = "1"
  FDMSLevel3.ItemUnitCost(1) = "1000" '$10.00
  FDMSLevel3.ItemTotal(1) = "1060"    '$10.60
  FDMSLevel3.ItemUnits(1) = "each"

  'Finally, add the Level 2 and Level 3 addendum data to the settlement at the same index
  'as the associated transaction.
  FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum() & FDMSLevel3.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 (FDMSLevel3 Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmslevel3_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 (FDMSLevel3 Class)

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_FDMSLEVEL3_ERROR 1

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

class FDMSLevel3ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass FDMSLevel3 and override this emitter function.
virtual int FireError(FDMSLevel3ErrorEventParams *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.

FDMSLineItem Type

Contains a single Level 3 line item.

Syntax

DPaymentsSDKFDMSLineItem (declared in dpaymentssdk.h)

Remarks

This type contains a single line item, used for Level 3 settlements. The fields contained by this type are listed below.

The following fields are available:

Fields

CommodityCode
char*
Default Value: ""

Code indicating the type of goods or services sold.

This field should contain an international description code of the overall goods or services being supplied. The acquirer bank or processor should provide the merchant an updated listing of currently defined codes.

The maximum length of this field is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

Description
char*
Default Value: ""

Description of the item.

This field contains an alphanumeric description of the item(s) being supplied.

The maximum length of this field is 26 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

DiscountAmount
char*
Default Value: ""

Amount of the discount for each line item (if any).

This field contains the amount of any discount applied by the merchant to this line item. This field should be empty (or zero) if the UnitCost reflects a discount price or if no line item discount applies.

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. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

NationalTaxAmount
char*
Default Value: ""

National tax amount included in the transaction amount.

This optional field is applicable to Visa International. It contains the amount of national tax that is included in the transaction amount. This value must be expressed in the same currency as the source 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.

The maximum length of this field is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

OtherTaxAmount
char*
Default Value: ""

City or county tax amount.

This optional field is applicable to International merchants only. It is used when city or multiple county taxes need to be broken out separately.

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.

The maximum length of this field is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

ProductCode
char*
Default Value: ""

Product code of the item purchased.

This field contains a code assigned to the product by the merchant. This may be a UPC or any other code with which the merchant wishes to identify an individual product. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

Quantity
int
Default Value: 0

Quantity of items in this Line Item.

This field contains the quantity of items being purchased, in whole numbers. This amount is to be presented with an implied decimal point. The position of the implied decimal is set using the QuantityExponent property.

For example, quantity 1.25 must be represented as 125 with QuantityExponent being set to 2.

Note: The maximum length of this field for Mastercard is 5 digits.

For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 

 
 Copy
       
  FDMSLevel3.LineItemsCount = 1
  FDMSLevel3.LineItemsQuantity[0] = 3                                                      
  FDMSLevel3.LineItemsUnitCost[0] = "1399"                                
  FDMSLevel3.LineItemsUnits[0] = "each"       
  FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97
All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

QuantityExponent
char*
Default Value: ""

QuantityExponent of items in this Line Item.

This field determines the position of the implied decimal point in the quantity of items puchased, in whole numbers.

For Visa transactions, the valid values for this property are between 0-4.

For MasterCard transactions, the valid values are between 0-5.

For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 

 
 Copy
       
  FDMSLevel3.LineItemsCount = 1
  FDMSLevel3.LineItemsQuantity[0] = 3                                                      
  FDMSLevel3.LineItemsUnitCost[0] = "1399"                                
  FDMSLevel3.LineItemsUnits[0] = "each"       
  FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97
All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

TaxAmount
char*
Default Value: ""

Tax on this individual item.

This field contains the amount of any Value Added Taxes (VAT) which can be associated with the purchased item.

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.

Note: The maximum length of this field is 12 characters for Visa and 9 characters for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

TaxIncluded
int
Default Value: FALSE

Net/Gross Indicator.

If this field is True, the Total already contains the TaxAmount. If False, the TaxAmount has not yet been added to the Total. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

TaxRate
char*
Default Value: ""

Tax rate used to calculate the TaxAmount.

This field contains the tax rate used to calculate the TaxAmount. This field has a two-digit implied decimal position, and the maximum length is 4 characters for Visa and 5 digits for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

TaxType
int
Default Value: 0

Type of tax charged in TaxAmount.

This field designates the type of value-added taxes (VAT) that are being charged in TaxAmount All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

Total
char*
Default Value: ""

Total cost of this line item.

This field contains the total amount of the individual item, typically calculated as UnitCost multiplied by Quantity, with any TaxAmount and DiscountAmount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 

 
 Copy
       
  FDMSLevel3.LineItemsCount = 1
  FDMSLevel3.LineItemsQuantity[0] = 3                                                      
  FDMSLevel3.LineItemsUnitCost[0] = "1399"                                
  FDMSLevel3.LineItemsUnits[0] = "each"       
  FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97

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. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

UnitCost
char*
Default Value: ""

Cost of each individual item.

This field contains the cost of each item in this Line Item. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 

 
 Copy
       
  FDMSLevel3.LineItemsCount = 1
  FDMSLevel3.LineItemsQuantity[0] = 3                                                      
  FDMSLevel3.LineItemsUnitCost[0] = "1399"                                
  FDMSLevel3.LineItemsUnits[0] = "each"       
  FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97

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. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

Units
char*
Default Value: ""

Unit of measure for this Line Item.

This field contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the UnitCost is calculated. If you're selling rope by the foot, the Units might be "feet". If you're selling chemicals, it might be by the "ounce". For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 

 
 Copy
       
  FDMSLevel3.LineItemsCount = 1
  FDMSLevel3.LineItemsQuantity[0] = 3                                                      
  FDMSLevel3.LineItemsUnitCost[0] = "1399"                                
  FDMSLevel3.LineItemsUnits[0] = "each"       
  FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97

The maximum length of this field is 12 characters for Visa Cards and 3 characters for MasterCard.

Some examples from the list of valid values for MasterCard are:

Unit Name Alpha Code Numeric Code
Barrel BLL 146
Cubic Foot FTQ 132
Cubic Yard YDQ 133
Day DAY 359
Dozen DZN 641
Gallon GLI 139
Gross GRO 638
Hour HUR 356
Hundred Boxes BHX 683
Kilogram KGM 166
Liter LTR 112
Minute MIN 355
Month MON 362
Number of Packs NMP 778
Number of Pairs NPR 715
Pound LBR 186
Quart QTI 138
Shipping Ton SHT 183
Square Yard YDK 075
Thousand MIL 798
All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

Constructors

FDMSLineItem()

DPaymentsSDKList Type

Syntax

DPaymentsSDKList<T> (declared in dpaymentssdk.h)

Remarks

DPaymentsSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the FDMSLevel3 class.

Methods

GetCount This method returns the current size of the collection. 

int GetCount() {}
SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. 

int SetCount(int count) {}
Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. 

T* Get(int index) {}
Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. 

T* Set(int index, T* value) {}

Config Settings (FDMSLevel3 Class)

The class accepts one or more of the following configuration settings. Configuration 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.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

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

FDMSLevel3 Errors

501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.
605   Invalid CardType.