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

FDMSLevel3 Component

Properties   Methods   Events   Configuration 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 FDMSSETTLE 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 ctVisa 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 = ctVisa;
  FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard;
  FDMSLevel2.OrderDate = "060828"; //September 28th, 2006
  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 = ctVisa
  
  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 ctMasterCard 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.

ErrorInformation about errors during data delivery.

Configuration Settings


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

GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

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