FDMSLevel2 Component

Properties Methods Events Configuration Settings Errors

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

Syntax

nsoftware.InPayDirect.Fdmslevel2

Remarks

The properties required to build a Level 2 addendum depends upon the value of the CardType property. The following tables indicate which properties are valid for what card type:

American Express

DestinationZip (required)
PurchaseIdentifier (required)
TaxAmount (required)

Visa

PurchaseIdentifier (required)
CommercialCardType (optional)
InvoiceNumber (optional)
DestinationCountry (optional)
DestinationZip (optional)
DiscountAmount (optional)
DutyAmount (optional)
FreightAmount (optional)
FreightTaxAmount (optional)
FreightTaxRate (optional)
MerchantReference (optional)
OrderDate (optional)
ShippedFromZip (optional)
TaxAmount (optional)

MasterCard

MerchantTaxId (required)
MerchantType (required)
PurchaseIdentifier (required)
TaxAmount (required)
CommercialCardType (optional)
DestinationCountry (optional)
DestinationState (optional)
DestinationZip (optional)
DutyAmount (optional)
FreightAmount (optional)
MerchantReference (optional)
ShippedFromZip (optional)

The following example illustrates how to add Level 2 data to a transaction to be settled:

  FDMSECommerce.Authorize()

  FDMSLevel2.CardType = ctVisa
  FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard  
  FDMSLevel2.OrderDate = "060828" 'September 28th, 2006
  FDMSLevel2.FreightTaxAmount = "0"
  FDMSLevel2.FreightAmount = "600"
  FDMSLevel2.PurchaseIdentifier = "123456PURCHID"
  FDMSLevel2.InvoiceNumber = "CUSTCODE"
  FDMSLevel2.ShippedToZip = "90210"
  FDMSLevel2.ShippedFromZip = "90210"
  FDMSLevel2.TaxAmount = "120"

  FDMSSettle.DetailRecords.Add(New FDMSRecordType(FDMSECommerce.GetDetailAggregate(), FDMSLevel2.GetAddendum()))

Note that while Level 2 addendum data is only applicable to corporate purchasing cards, you may send Level 2 data for all Visa, Master Card, and American Express cards if you wish.

Property List

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


CardType	The card type for which a Level 2 or Level 3 addendum will be created.
CommercialCardType	Indicates the type of commercial card being settled.
DestinationCountry	Country the goods are to be shipped to.
DestinationState	State or province to which the goods are to be shipped.
DestinationZip	The zip code to which the commodity was shipped.
DiscountAmount	Amount of any discount subtracted from the line item totals.
DutyAmount	Duty fees (if any) for imported goods.
FreightAmount	Shipping charges associated with this transaction.
FreightTaxAmount	Portion of the FreightAmount that is tax.
FreightTaxRate	Rate used to calculate the FreightTaxAmount .
InvoiceNumber	Customer Reference Identifier.
MerchantReference	Merchant Reference Number.
MerchantTaxId	Merchant's government tax Id number.
MerchantType	MasterCard merchant classification code.
OrderDate	Date of the order in YYMMDD format.
PurchaseIdentifier	Optional purchase order number assigned by the merchant.
ShippedFromZip	Zip code the goods are being shipped from.
TaxAmount	Sales tax charged in addition to the original TransactionAmount .

Method List

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


Config	Sets or retrieves a configuration setting .
GetAddendum	Returns a Level 2 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 further details.


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 further details.


CodePage	The system code page used for Unicode to Multibyte translations.