FDMSLevel3 Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPayments.DPaymentsSDK.Fdmslevel3

Remarks

This Level3Extension component 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 component 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: //First, authorize the credit card FDMSECommerce.TransactionAmount = "2720"; // $27.20 FDMSECommerce.Authorize(); //Then, put the result into the settlement component FDMSSettle.DetailRecords.Add(New FDMSRecordType(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 FDMSLineItem item = new FDMSLineItem(); item.Quantity = 2; item.UnitCost = "500"; // $5.00 item.Units = "each"; item.TaxAmount = "60"; // $0.60 item.Total = "1060"; // $10.60 FDMSLevel3.LineItems.Add(item); item = new FDMSLineItem(); item.Quantity = 25; item.QuantityExponent = "1"; item.UnitCost = "400"; // $4.00 item.Units = "each"; item.TaxAmount = "60"; // $0.60 item.Total = "1060"; // $10.60 FDMSLevel3.LineItems.Add(item); //Finally, add the Level 2 and Level 3 addendum data to the settlement at the same index //as the associated transaction. FDMSSettle.DetailRecords[FDMSSettle.DetailRecords.Count()].AddendumAggregate = 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 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

CardType Property (FDMSLevel3 Component)

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

Syntax

public Fdmslevel3CardTypes CardType { get; set; }

enum Fdmslevel3CardTypes {
  fctUnknown,
  fctVisa,
  fctMasterCard,
  fctAmericanExpress
}

Public Property CardType As Fdmslevel3CardTypes

Enum Fdmslevel3CardTypes
  fctUnknown
  fctVisa
  fctMasterCard
  fctAmericanExpress
End Enum

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

LineItems Property (FDMSLevel3 Component)

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

Syntax

public FDMSLineItemList LineItems { get; }

Public Property LineItems As FDMSLineItemList

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:

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"

Please refer to the FDMSLineItem type for a complete list of fields.

MerchantTaxId Property (FDMSLevel3 Component)

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

Syntax

public string MerchantTaxId { get; set; }

Public Property MerchantTaxId As String

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.

Config Method (FDMSLevel3 Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (FDMSLevel3 Component)

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

Syntax

public string GetAddendum();

Public Function GetAddendum() As String

Remarks

The type of addendum created by this component 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: //First, authorize the credit card FDMSECommerce.TransactionAmount = "2720"; // $27.20 FDMSECommerce.Authorize(); //Then, put the result into the settlement component FDMSSettle.DetailRecords.Add(New FDMSRecordType(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 FDMSLineItem item = new FDMSLineItem(); item.Quantity = 2; item.UnitCost = "500"; // $5.00 item.Units = "each"; item.TaxAmount = "60"; // $0.60 item.Total = "1060"; // $10.60 FDMSLevel3.LineItems.Add(item); item = new FDMSLineItem(); item.Quantity = 25; item.QuantityExponent = "1"; item.UnitCost = "400"; // $4.00 item.Units = "each"; item.TaxAmount = "60"; // $0.60 item.Total = "1060"; // $10.60 FDMSLevel3.LineItems.Add(item); //Finally, add the Level 2 and Level 3 addendum data to the settlement at the same index //as the associated transaction. FDMSSettle.DetailRecords[FDMSSettle.DetailRecords.Count()].AddendumAggregate = FDMSLevel2.GetAddendum() + FDMSLevel3.GetAddendum()

Reset Method (FDMSLevel3 Component)

Clears all properties to their default values.

Syntax

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Error Event (FDMSLevel3 Component)

Fired when information is available about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, Fdmslevel3ErrorEventArgs e);

public class Fdmslevel3ErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As Fdmslevel3ErrorEventArgs)

Public Class Fdmslevel3ErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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.

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
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
string
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.

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

DiscountAmount
string
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.

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

NationalTaxAmount
string
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
string
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
string
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.

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

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

TaxIncluded
bool
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. This property is only used for MasterCard Corporate Purchasing Cards.

TaxRate
string
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.

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

TaxType
FDMSTaxTypes
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 This property is only used for MasterCard Corporate Purchasing Cards.

Total
string
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: 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
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: 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
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: 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

public FDMSLineItem();

Public FDMSLineItem()

Config Settings (FDMSLevel3 Component)

The component 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 component, 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.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component 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.
MaskSensitive:   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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component 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.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (FDMSLevel3 Component)

FDMSLevel3 Errors

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