Level2Extension Component [IBiz Vital/TSYS Integrator V4]
Properties
Methods
Events
Configuration Settings
The Level2Extension component is a tool used to create Level2 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
The type of addendum created by this component depends upon the value of the CardType property. If
the CardType is ctVisa or ctMasterCard a Group 22 addendum will be created by the
GetAddendum method. Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax,
and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2
addendum to a detail record in the settlement:
| | CCECommerce.Authorize()
CCSettle.DetailRecordCount = 1
CCSettle.DetailAggregate[0] = CCECommerce.GetDetailAggregate()
Level2Extension.CardType = ctVisa
Level2Extension.IsTaxExempt = False
Level2Extension.LocalSalesTax = "423" '$4.23
Level2Extension.PurchaseOrderNumber = "12345678901234567"
CCSettle.DetailAddendum[0] = Level2Extension.GetAddendum() |
If the CardType is ctAmericanExpress, the addendum created will be Group 21 instead of Group 22. Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:
| | CCECommerce.Authorize()
CCSettle.DetailRecordCount = 2
CCSettle.DetailAggregate[1] = CCECommerce.GetDetailAggregate()
Level2Extension.CardType = ctAmericanExpress
Level2Extension.AmexCardholderReference = "INV12345678"
Level2Extension.AmexChargeDescriptor = "Test transaction"
Level2Extension.AmexSalesTax = "373"
Level2Extension.AmexShippedToZip = "90210"
Level2Extension.AmexSupplierNumber = "SUP244568"
CCSettle.DetailAddendum[1] = Level2Extension.GetAddendum() |
Note that while Level2 addendum data is only applicable to corporate purchasing cards, you may send Level2 data for all Visa, Master Card, and American Express cards if you wish.
Note: If you are attempting to settle American Express transactions which include Level2 commercial card data, and you receive an error indicating that the "Record Type is missing or invalid" for the Detail Record containing that transaction, the problem is that your merchant account is not set up to settle American Express commercial cards.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.
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 Level2 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).
|