Search: 
Available in: FDMS
FDMSLevel3 Component [IBiz FDMS Integrator V1]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This Level3Extension component creates Level III addendum data, which can be sent in the settlement to achieve a better interchange rate when accepting corporate purchasing cards. The Level III 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 III 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.DetailRecordCount = 1
  FDMSSettle.DetailAggregate[0] = FDMSECommerce.GetDetailAggregate()

  'Then build the Level2 portion
  FDMSLevel2.CardType = ctVisa
  FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard  
  FDMSLevel2.OrderDate = "060828" 'September 28th, 2006
  FDMSLevel2.FreightTaxAmount = "0"
  FDMSLevel2.FreightAmount = "600"
  FDMSLevel2.PurchaseIdentifier = "123456PURCHID"
  FDMSLevel2.CustomerCode = "CUSTCODE"
  FDMSLevel2.ShippedToZip = "90210"
  FDMSLevel2.ShippedFromZip = "90210"
  FDMSLevel2.TaxAmount = "120"
  
  'Now build the Level3 portion

  FDMSLevel3.CardType = ctVisa
  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.ItemQuantity[0] = "2"
  FDMSLevel3.ItemTaxAmount[0] = "60"
  FDMSLevel3.ItemTaxRate[0] = "600" ' 6.00 percent
  FDMSLevel3.ItemTotal[0] = "1060"
  FDMSLevel3.ItemUnitCost[0] = "500"
  FDMSLevel3.ItemUnits[0] = "each"

  FDMSLevel3.ItemCommodityCode[1] = "4900"
  FDMSLevel3.ItemDescription[1] = "Quick Start manual"
  FDMSLevel3.ItemDiscountAmount[1] = ""
  FDMSLevel3.ItemProductCode[1] = "ISBN654321"
  FDMSLevel3.ItemQuantity[1] = "1"
  FDMSLevel3.ItemTaxAmount[1] = "60"
  FDMSLevel3.ItemTaxRate[1] = "600" ' 6.00 percent
  FDMSLevel3.ItemTotal[1] = "1060"
  FDMSLevel3.ItemUnitCost[1] = "1000"
  FDMSLevel3.ItemUnits[1] = "each"

  'Finally, add the Level2 and Level3 addendum data to the settlement at the same index
  'as the associated transaction.
  FDMSSettle.DetailAddendum[0] = FDMSLevel2.GetAddendum() & FDMSLevel3.GetAddendum()

A Level III addendum for the ctMasterCard CardType is constructed similarly:

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

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

CardType The card type for which a Level2 or Level3 addendum will be created.
ItemCommodityCode Code indicating the type of goods or services sold.
ItemDescription Description of the item.
ItemDiscountAmount Amount of the discount for each line item (if any).
ItemProductCode Product code of the item purchased.
ItemQuantity Quantity of items in this Line Item.
ItemTaxAmount Tax on this individual item.
ItemTaxIncluded Net/Gross Indicator.
ItemTaxRate Tax rate used to calculate the ItemTaxAmount.
ItemTaxType Type of tax charged in ItemTaxAmount.
ItemTotal Total cost of this line item.
ItemUnitCost Cost of each individual item.
ItemUnits Unit of measure for this Line Item.
LineItemCount Total number of line items to be included in the Level III addendum.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component configuration setting.
GetAddendum Returns a Level III Purchasing card addendum based on the specified CardType
Reset Clears 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 complete descriptions.

Error Information 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 complete descriptions.

CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
UseFractionalQuantites Allows the use of fractional quantities in the ItemQuantity property.

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.