FDMSLevel3 Class

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.

Class Name

InPayDirect_FDMSLevel3

Procedural Interface

 inpaydirect_fdmslevel3_open();
 inpaydirect_fdmslevel3_close($res);
 inpaydirect_fdmslevel3_register_callback($res, $id, $function);
 inpaydirect_fdmslevel3_get_last_error($res);
 inpaydirect_fdmslevel3_get_last_error_code($res);
 inpaydirect_fdmslevel3_set($res, $id, $index, $value);
 inpaydirect_fdmslevel3_get($res, $id, $index);
 inpaydirect_fdmslevel3_do_config($res, $configurationstring);
 inpaydirect_fdmslevel3_do_getaddendum($res);
 inpaydirect_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)
• LineItemUnitCost (required)
• LineItemCommodityCode (optional)
• LineItemDescription (optional)
• LineItemDiscountAmount (optional)
• LineItemProductCode (optional)
• LineItemTaxAmount (optional)
• LineItemTaxRate (optional)
• LineItemTotal (optional)
• LineItemUnits (optional)

List of valid Line Item properties for Mastercard:

• LineItemDescription (required)
• LineItemProductCode (required)
• LineItemQuantity (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 ctVisa CardType:

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