4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

FDMSLineItem Type

Contains a single Level 3 line item.

Remarks

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

Fields

CommodityCode
String

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 (CardType = ctVisa).

Description
String

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.

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

DiscountAmount
String

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.

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

NationalTaxAmount
String

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 (CardType = ctVisa).

OtherTaxAmount
String

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 (CardType = ctVisa).

ProductCode
String

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.

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

Quantity
Integer

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:

  FDMSLineItem item = new FDMSLineItem();
  item.Quantity = 3;
  item.QuantityExponent = "0"
  item.UnitCost = "1399"; // $13.99
  item.Units = "each";
  item.Total = "4197"; // $13.99 x 3 = $41.97

  FDMSLevel3.LineItems.Add(item);  

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

QuantityExponent
String

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:

  FDMSLineItem item = new FDMSLineItem();
  item.Quantity = 3;
  item.QuantityExponent = "0"
  item.UnitCost = "1399"; // $13.99
  item.Units = "each";
  item.Total = "4197"; // $13.99 x 3 = $41.97

  FDMSLevel3.LineItems.Add(item);  

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

TaxAmount
String

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.

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

TaxIncluded
Boolean

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. This property is only used for MasterCard Corporate Purchasing Cards (CardType = ctMasterCard).

TaxRate
String

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.

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

TaxType
FDMSTaxTypes

Type of tax charged in TaxAmount.

This field designates the type of value-added taxes (VAT) that are being charged in TaxAmount This property is only used for MasterCard Corporate Purchasing Cards (CardType = ctMasterCard).

Total
String

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:

  FDMSLineItem item = new FDMSLineItem();
  item.Quantity = 3;
  item.QuantityExponent = "0"
  item.UnitCost = "1399"; // $13.99
  item.Units = "each";
  item.Total = "4197"; // $13.99 x 3 = $41.97

  FDMSLevel3.LineItems.Add(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.

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

UnitCost
String

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:

  FDMSLineItem item = new FDMSLineItem();
  item.Quantity = 3;
  item.QuantityExponent = "0"
  item.UnitCost = "1399"; // $13.99
  item.Units = "each";
  item.Total = "4197"; // $13.99 x 3 = $41.97

  FDMSLevel3.LineItems.Add(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.

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

Units
String

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:

  FDMSLineItem item = new FDMSLineItem();
  item.Quantity = 3;
  item.QuantityExponent = "0"
  item.UnitCost = "1399"; // $13.99
  item.Units = "each";
  item.Total = "4197"; // $13.99 x 3 = $41.97

  FDMSLevel3.LineItems.Add(item);  

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

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

Constructors

[VB.NET]
Public FDMSLineItem()

[C#]
public FDMSLineItem();



 
 
Copyright (c) 2020 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 7502]