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.

Class Name

DPaymentsSDK_FDMSLevel3

Procedural Interface

 dpaymentssdk_fdmslevel3_open();
 dpaymentssdk_fdmslevel3_close($res);
 dpaymentssdk_fdmslevel3_register_callback($res, $id, $function);
 dpaymentssdk_fdmslevel3_get_last_error($res);
 dpaymentssdk_fdmslevel3_get_last_error_code($res);
 dpaymentssdk_fdmslevel3_set($res, $id, $index, $value);
 dpaymentssdk_fdmslevel3_get($res, $id, $index);
 dpaymentssdk_fdmslevel3_do_config($res, $configurationstring);
 dpaymentssdk_fdmslevel3_do_getaddendum($res);
 dpaymentssdk_fdmslevel3_do_reset($res);

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:

• LineItemQuantity (required)
• ItemQuantityExponent (optional)
• LineItemUnitCost (required)
• LineItemCommodityCode (optional)
• LineItemDescription (optional)
• LineItemDiscountAmount (optional)
• LineItemProductCode (optional)
• LineItemTaxAmount (optional)
• LineItemTaxRate (optional)
• LineItemTotal (optional)
• LineItemUnits (optional)
• ItemNationalTaxAmount (optional)
• ItemOtherTaxAmount (optional)

List of valid Line Item properties for Mastercard:

• LineItemDescription (required)
• LineItemProductCode (required)
• LineItemQuantity (required)
• ItemQuantityExponent (required)
• LineItemUnits (required)
• LineItemUnitCost (optional)
• LineItemTotal (required)
• LineItemDiscountAmount (optional)
• LineItemTaxIncluded (required)
• LineItemTaxRate (required)
• LineItemTaxAmount (required)
• LineItemTaxType (required)

The following example illustrates how to build a Level 3 addendum for the fctVisa CardType: '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.

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

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

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 1 );


dpaymentssdk_fdmslevel3_set($res, 1, $value );

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

LineItemCount Property (DPaymentsSDK_FDMSLevel3 Class)

The number of records in the Item arrays.

Object Oriented Interface

public function getLineItemCount();


public function setLineItemCount($value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 2 );


dpaymentssdk_fdmslevel3_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemCommodityCode
• ItemDescription
• ItemDiscountAmount
• ItemNationalTaxAmount
• ItemOtherTaxAmount
• ItemProductCode
• ItemQuantity
• ItemQuantityExponent
• ItemTaxAmount
• ItemTaxIncluded
• ItemTaxRate
• ItemTaxType
• ItemTotal
• ItemUnitCost
• ItemUnits

The array indices start at 0 and end at LineItemCount - 1.

This property is not available at design time.

Data Type

Integer

ItemCommodityCode Property (DPaymentsSDK_FDMSLevel3 Class)

Code indicating the type of goods or services sold.

Object Oriented Interface

public function getItemCommodityCode($itemindex);


public function setItemCommodityCode($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 3 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 3, $value , $itemindex);

Default Value

''

Remarks

Code indicating the type of goods or services sold.

This property 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 property is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (DPaymentsSDK_FDMSLevel3 Class)

Description of the item.

Object Oriented Interface

public function getItemDescription($itemindex);


public function setItemDescription($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 4 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 4, $value , $itemindex);

Default Value

''

Remarks

Description of the item.

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

The maximum length of this property 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemDiscountAmount Property (DPaymentsSDK_FDMSLevel3 Class)

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

Object Oriented Interface

public function getItemDiscountAmount($itemindex);


public function setItemDiscountAmount($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 5 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 5, $value , $itemindex);

Default Value

''

Remarks

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

This property contains the amount of any discount applied by the merchant to this line item. This property should be empty (or zero) if the ItemUnitCost 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemNationalTaxAmount Property (DPaymentsSDK_FDMSLevel3 Class)

National tax amount included in the transaction amount.

Object Oriented Interface

public function getItemNationalTaxAmount($itemindex);


public function setItemNationalTaxAmount($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 6 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 6, $value , $itemindex);

Default Value

''

Remarks

National tax amount included in the transaction amount.

This optional property 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 property is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemOtherTaxAmount Property (DPaymentsSDK_FDMSLevel3 Class)

City or county tax amount.

Object Oriented Interface

public function getItemOtherTaxAmount($itemindex);


public function setItemOtherTaxAmount($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 7 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 7, $value , $itemindex);

Default Value

''

Remarks

City or county tax amount.

This optional property 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 property is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemProductCode Property (DPaymentsSDK_FDMSLevel3 Class)

Product code of the item purchased.

Object Oriented Interface

public function getItemProductCode($itemindex);


public function setItemProductCode($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 8 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 8, $value , $itemindex);

Default Value

''

Remarks

Product code of the item purchased.

This property 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemQuantity Property (DPaymentsSDK_FDMSLevel3 Class)

Quantity of items in this Line Item.

Object Oriented Interface

public function getItemQuantity($itemindex);


public function setItemQuantity($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 9 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 9, $value , $itemindex);

Default Value

0

Remarks

Quantity of items in this Line Item.

This property 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 ItemQuantityExponent property.

For example, quantity 1.25 must be represented as 125 with ItemQuantityExponent 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: 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

Integer

ItemQuantityExponent Property (DPaymentsSDK_FDMSLevel3 Class)

QuantityExponent of items in this Line Item.

Object Oriented Interface

public function getItemQuantityExponent($itemindex);


public function setItemQuantityExponent($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 10 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 10, $value , $itemindex);

Default Value

''

Remarks

QuantityExponent of items in this Line Item.

This property 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: 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxAmount Property (DPaymentsSDK_FDMSLevel3 Class)

Tax on this individual item.

Object Oriented Interface

public function getItemTaxAmount($itemindex);


public function setItemTaxAmount($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 11 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 11, $value , $itemindex);

Default Value

''

Remarks

Tax on this individual item.

This property 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 property 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxIncluded Property (DPaymentsSDK_FDMSLevel3 Class)

Net/Gross Indicator.

Object Oriented Interface

public function getItemTaxIncluded($itemindex);


public function setItemTaxIncluded($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 12 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 12, $value , $itemindex);

Default Value

false

Remarks

Net/Gross Indicator.

If this property is True, the ItemTotal already contains the ItemTaxAmount. If False, the ItemTaxAmount has not yet been added to the ItemTotal. 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

Boolean

ItemTaxRate Property (DPaymentsSDK_FDMSLevel3 Class)

Tax rate used to calculate the TaxAmount .

Object Oriented Interface

public function getItemTaxRate($itemindex);


public function setItemTaxRate($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 13 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 13, $value , $itemindex);

Default Value

''

Remarks

Tax rate used to calculate the ItemTaxAmount.

This property contains the tax rate used to calculate the ItemTaxAmount. This property 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxType Property (DPaymentsSDK_FDMSLevel3 Class)

Type of tax charged in TaxAmount .

Object Oriented Interface

public function getItemTaxType($itemindex);


public function setItemTaxType($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 14 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 14, $value , $itemindex);

Default Value

0

Remarks

Type of tax charged in ItemTaxAmount.

This property designates the type of value-added taxes (VAT) that are being charged in ItemTaxAmount 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

Integer

ItemTotal Property (DPaymentsSDK_FDMSLevel3 Class)

Total cost of this line item.

Object Oriented Interface

public function getItemTotal($itemindex);


public function setItemTotal($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 15 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 15, $value , $itemindex);

Default Value

''

Remarks

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as ItemUnitCost multiplied by ItemQuantity, with any ItemTaxAmount and ItemDiscountAmount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemUnitCost Property (DPaymentsSDK_FDMSLevel3 Class)

Cost of each individual item.

Object Oriented Interface

public function getItemUnitCost($itemindex);


public function setItemUnitCost($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 16 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 16, $value , $itemindex);

Default Value

''

Remarks

Cost of each individual item.

This property contains the cost of each item in this Line Item. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

ItemUnits Property (DPaymentsSDK_FDMSLevel3 Class)

Unit of measure for this Line Item.

Object Oriented Interface

public function getItemUnits($itemindex);


public function setItemUnits($itemindex, $value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 17 , $itemindex);


dpaymentssdk_fdmslevel3_set($res, 17, $value , $itemindex);

Default Value

''

Remarks

Unit of measure for this Line Item.

This property contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the ItemUnitCost is calculated. If you're selling rope by the foot, the ItemUnits 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: 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 property is 12 characters for Visa Cards and 3 characters for MasterCard.

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

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.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

MerchantTaxId Property (DPaymentsSDK_FDMSLevel3 Class)

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

Object Oriented Interface

public function getMerchantTaxId();


public function setMerchantTaxId($value);

Procedural Interface

dpaymentssdk_fdmslevel3_get($res, 18 );


dpaymentssdk_fdmslevel3_set($res, 18, $value );

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmslevel3_do_config($res, $configurationstring);

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.

GetAddendum Method (DPaymentsSDK_FDMSLevel3 Class)

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

Object Oriented Interface

public function doGetAddendum();

Procedural Interface

dpaymentssdk_fdmslevel3_do_getaddendum($res);

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:

• LineItemQuantity (required)
• ItemQuantityExponent (optional)
• LineItemUnitCost (required)
• LineItemCommodityCode (optional)
• LineItemDescription (optional)
• LineItemDiscountAmount (optional)
• LineItemProductCode (optional)
• LineItemTaxAmount (optional)
• LineItemTaxRate (optional)
• LineItemTotal (optional)
• LineItemUnits (optional)
• ItemNationalTaxAmount (optional)
• ItemOtherTaxAmount (optional)

List of valid Line Item properties for Mastercard:

• LineItemDescription (required)
• LineItemProductCode (required)
• LineItemQuantity (required)
• ItemQuantityExponent (required)
• LineItemUnits (required)
• LineItemUnitCost (optional)
• LineItemTotal (required)
• LineItemDiscountAmount (optional)
• LineItemTaxIncluded (required)
• LineItemTaxRate (required)
• LineItemTaxAmount (required)
• LineItemTaxType (required)

The following example illustrates how to build a Level 3 addendum for the fctVisa CardType: '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()

Reset Method (DPaymentsSDK_FDMSLevel3 Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmslevel3_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_FDMSLevel3 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmslevel3_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Trappable Errors (FDMSLevel3 Class)

FDMSLevel3 Errors

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