Products
Support
Downloads
Purchase
Company
Subscriptions
Search: 
Available in: VITALPS
Level3Extension Component [IBiz Vital/TSYS Integrator V4]

Properties   Methods   Events   Configuration Settings  

The Level3Extension component is a tool used to create Level3 Corporate Purchasing Card addendum aggregates, which can then be passed to the CCSETTLE 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.

The following properties are valid for both ctVisa and ctMasterCard CardTypes.

Additional properties for the ctVisa CardType include:

Additional properties for the ctMasterCard CardType include:

The following example illustrates how to build a Level III addendum for the ctVisa CardType:

   
  'First authorize the credit card
  CCECommerce1.TransactionAmount = "53"
  CCECommerce.Authorize()
  
  'Then, put the result into the settlement component
  CCSettle.DetailRecordCount = 1
  CCSettle.DetailAggregate[0] = CCECommerce.GetDetailAggregate()

  'Now build the Level3 Extension. 
  'The following properties are required for a Visa Corporate Purchasing Card:
  Level3Extension.CardType = ctVisa
  Level3Extension.LocalTax = "EXEMPT"
  Level3Extension.NationalTax = "0"
  Level3Extension.PurchaseOrder = "purchOrdNum"
  Level3Extension.MerchantTaxId = "merchantTaxId"
  Level3Extension.CustomerTaxId = "customerTaxId"
  Level3Extension.CommodityCode = "fake"
  Level3Extension.DiscountAmount = "0"
  Level3Extension.FreightAmount = "0"
  Level3Extension.DutyAmount = "0"
  Level3Extension.DestinationZip = "27709"
  Level3Extension.ShipFromZip = "27709"
  Level3Extension.DestinationCountry = "840"
  Level3Extension.TaxInvoiceNumber = "VATInvoiceRefNo"
  Level3Extension.OrderDate = "060526"
  Level3Extension.FreightTaxAmount = "0"
  Level3Extension.FreightTaxRate = "0"
  
  'Begin adding line items:
  Level3Extension.LineItemCount = 2
  
  Level3Extension.ItemCommodityCode[0] = "fake"
  Level3Extension.ItemDescription[0] = "hardware"
  Level3Extension.ItemProductCode[0] = "productCode123"
  Level3Extension.ItemQuantity[0] = 1
  Level3Extension.ItemUnits[0] = ""
  Level3Extension.ItemUnitCost[0] = "33"
  Level3Extension.ItemTaxAmount[0] = "0"
  Level3Extension.ItemTaxRate[0] = "0"
  Level3Extension.ItemDiscountAmount[0] = "0"
  Level3Extension.ItemTotal[0] = "33"
  
  Level3Extension.ItemCommodityCode[1] = "fake"
  Level3Extension.ItemDescription[1] = "hardware"
  Level3Extension.ItemProductCode[1] = "productCode124"
  Level3Extension.ItemQuantity[1] = 1
  Level3Extension.ItemUnits[1] = ""
  Level3Extension.ItemUnitCost[1] = "20"
  Level3Extension.ItemTaxAmount[1] = "0"
  Level3Extension.ItemTaxRate[1] = "0"
  Level3Extension.ItemDiscountAmount[1] = "0"
  Level3Extension.ItemTotal[1] = "20"
  
  'Finally, add the Level3 addendum to the same index in the settlement.
  CCSettle.DetailAddendum[0] = Level3Extension1.GetAddendum()

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

   
  'First authorize the credit card
  CCECommerce1.TransactionAmount = "200"
  CCECommerce.Authorize()
  
  'Then, put the result into the settlement component
  CCSettle.DetailRecordCount = 2
  CCSettle.DetailAggregate[1] = CCECommerce.GetDetailAggregate()

  'Now build the Level3 Extension. 
  Level3Extension1.cardType = ctMasterCard
  Level3Extension1.LocalTax = "EXEMPT"
  Level3Extension1.NationalTax = "0"
  Level3Extension1.PurchaseOrder = "cardholderRefId"
  Level3Extension1.FreightAmount = "0"
  Level3Extension1.DutyAmount = "0"
  Level3Extension1.DestinationZip = "27709"
  Level3Extension1.ShipFromZip = "27709"
  Level3Extension1.DestinationCountry = "USA"
  Level3Extension1.AlternateTaxAmount = "0"
  Level3Extension1.AlternateTaxId = "altTaxId"
  
  'Begin adding line items:
  Level3Extension1.LineItemCount = 2
  
  Level3Extension1.ItemDescription[0] = "bolt"
  Level3Extension1.ItemProductCode[0] = "BOLT6x20"
  Level3Extension1.ItemQuantity[0] = 2
  Level3Extension1.ItemUnits[0] = "each"  
  Level3Extension1.ItemTaxRate[0] = "0"
  Level3Extension1.ItemTaxType[0] = "taxType"
  Level3Extension1.ItemTaxAmount[0] = "0"
  Level3Extension1.ItemDiscountAmount[0] = "0"
  Level3Extension1.ItemTaxIncluded[0] = False
  Level3Extension1.ItemTotal[0] = "100"
  Level3Extension1.ItemDiscountAmount[0] = "0"
  Level3Extension1.ItemDiscountRate[0] = "0"
  
  Level3Extension1.ItemDescription[1] = "flange nut"
  Level3Extension1.ItemProductCode[1] = "FLANGE6"
  Level3Extension1.ItemQuantity[1] = 1
  Level3Extension1.ItemUnits[1] = "each"  
  Level3Extension1.ItemTaxRate[1] = "0"
  Level3Extension1.ItemTaxType[1] = "taxType"
  Level3Extension1.ItemTaxAmount[1] = "0"
  Level3Extension1.ItemDiscountAmount[1] = "0"
  Level3Extension1.ItemTaxIncluded[1] = False
  Level3Extension1.ItemTotal[1] = "100"
  Level3Extension1.ItemDiscountAmount[1] = "0"
  Level3Extension1.ItemDiscountRate[1] = "0"
  
  'Finally, add the Level3 addendum to the same index in the settlement.
  CCSettle1.DetailAddendum[1] = Level3Extension1.GetAddendum()

Note that while Level3 addendum data is only applicable to corporate purchasing cards, you may send Level3 data for all Visa and Master Card 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 complete descriptions.

AlternateTaxAmount Secondary tax amount (only applicable in some countries).
AlternateTaxId Tax Id number of the merchant that reported the AlternateTaxAmount.
CardType The card type for which a Level2 or Level3 addendum will be created.
CommodityCode Code indicating the type of goods or services sold.
CustomerTaxId Customer's Value Added Tax registration number.
DestinationCountry Country the goods are to be shipped to.
DestinationZip Zip code the goods are to be shipped to.
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.
ItemCommodityCode Code describing the good or service being supplied.
ItemDescription Description of the item.
ItemDiscountAmount Amount of the discount for each line item (if any).
ItemDiscountRate Rate used to calculate the ItemDiscountAmount.
ItemProductCode Merchant-defined product code for this Line Item.
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.
LocalTax Amount of local or state taxes that are a part of this transaction.
MerchantTaxId Merchant's government tax Id number.
NationalTax Amount of federal or national taxes that are a part of this transaction.
OrderDate Date of the order in YYMMDD format.
PurchaseIdentifier Optional purchase order number assigned by the merchant.
PurchaseOrder Purchase Order Number supplied by the cardholder.
ShipFromZip Zip code the goods are being shipped from.
TaxInvoiceNumber Unique Value Added Tax Invoice Reference Number

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.