TSYSLevel3 Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibcTSYSLevel3

Remarks

This TSYSLevel3 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 tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• LineItemDescription
• LineItemDiscountAmount
• LineItemProductCode
• LineItemQuantity
• LineItemTaxAmount
• LineItemTaxRate
• LineItemTotal
• LineItemUnits

Additional properties for the tctVisa CardType include:

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• LineItemCommodityCode
• LineItemUnitCost

Additional properties for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• LineItemDiscountRate
• LineItemTaxIncluded
• LineItemTaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType: 'First authorize the credit card TSYSECommerce1.TransactionAmount = "53" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. 'The following properties are required for a Visa Corporate Purchasing Card: TSYSLevel3.CardType = tctVisa TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "purchOrdNum" TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number TSYSLevel3.CommodityCode = "fake" TSYSLevel3.DiscountAmount = "0" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "840" TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo" TSYSLevel3.OrderDate = "060526" TSYSLevel3.FreightTaxAmount = "0" TSYSLevel3.FreightTaxRate = "0" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()

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

'First authorize the credit card TSYSECommerce1.TransactionAmount = "200" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. TSYSLevel3.cardType = tctMasterCard TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "cardholderRefId" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "USA" TSYSLevel3.AlternateTaxAmount = "0" TSYSLevel3.AlternateTaxId = "altTaxId" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemDescription(0) = "bolt" TSYSLevel3.LineItemProductCode(0) = "BOLT6x20" TSYSLevel3.LineItemQuantity(0) = 2 TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemTaxType(0) = "taxType" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTaxIncluded(0) = False TSYSLevel3.LineItemTotal(0) = "100" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemDiscountRate(0) = "0" TSYSLevel3.LineItemDescription(1) = "flange nut" TSYSLevel3.LineItemProductCode(1) = "FLANGE6" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "each" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemTaxType(1) = "taxType" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTaxIncluded(1) = False TSYSLevel3.LineItemTotal(1) = "100" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemDiscountRate(1) = "0" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle1.DetailAddendum(1) = TSYSLevel3.GetAddendum()

Note that while Level3 addendum data is only applicable to corporate purchasing cards, however 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 further details.

Method List

---

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

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.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AlternateTaxAmount Property (TSYSLevel3 Component)

Secondary tax amount (only applicable in some countries).

Syntax

__property String AlternateTaxAmount = { read=FAlternateTaxAmount, write=FSetAlternateTaxAmount };

Default Value

""

Remarks

This property is used to record the second tax amount in countries where more than one type of tax can be applied to purchases. This amount must be included in the TransactionAmount of the original transaction.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. This property is only used for MasterCard Corporate Purchasing Cards.

Data Type

String

AlternateTaxId Property (TSYSLevel3 Component)

Tax Id number of the merchant that reported the AlternateTaxAmount .

Syntax

__property String AlternateTaxId = { read=FAlternateTaxId, write=FSetAlternateTaxId };

Default Value

""

Remarks

This property contains the tax identification number of the merchant that reported the AlternateTaxAmount This property is only used for MasterCard Corporate Purchasing Cards.

This property is not available at design time.

Data Type

String

CardType Property (TSYSLevel3 Component)

The card type for which a Level2 or Level3 addendum will be created.

Syntax

__property TibcTSYSLevel3CardTypes CardType = { read=FCardType, write=FSetCardType };

enum TibcTSYSLevel3CardTypes {
  tctVisa=0,
  tctMasterCard=1,
  tctAmericanExpress=2
};

Default Value

tctVisa

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

Data Type

Integer

CommodityCode Property (TSYSLevel3 Component)

Code indicating the type of goods or services sold.

Syntax

__property String CommodityCode = { read=FCommodityCode, write=FSetCommodityCode };

Default Value

""

Remarks

This property should contain an international description code of the overall goods or services being supplied. The acquirer bank or processor should provide the merchant an updated listing of currently defined codes.

The maximum length of this property is 4 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

CustomerTaxId Property (TSYSLevel3 Component)

Customer's Value Added Tax registration number.

Syntax

__property String CustomerTaxId = { read=FCustomerTaxId, write=FSetCustomerTaxId };

Default Value

""

Remarks

This property contains a Value Added Tax registration number supplied by the Commercial Card cardholder.

The maximum length of this property is 13 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

DestinationCountry Property (TSYSLevel3 Component)

Country the goods are to be shipped to.

Syntax

__property String DestinationCountry = { read=FDestinationCountry, write=FSetDestinationCountry };

Default Value

""

Remarks

For Visa transactions, this property contains the three-digit numeric code of the country where the goods are being shipped. These codes are specified by ISO-3166. For the United States, use "840".

For MasterCard transactions, this property should contain the three-character alpha code specified by that same ISO spec. For the United States, use "USA".

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

DestinationZip Property (TSYSLevel3 Component)

Zip code the goods are to be shipped to.

Syntax

__property String DestinationZip = { read=FDestinationZip, write=FSetDestinationZip };

Default Value

""

Remarks

This property contains the Postal/Zip code of the address where purchased goods will be delivered. This property can be identical to the ShipFromZip if the customer is present and takes immediate possession of the goods.

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

DiscountAmount Property (TSYSLevel3 Component)

Amount of any discount subtracted from the line item totals.

Syntax

__property String DiscountAmount = { read=FDiscountAmount, write=FSetDiscountAmount };

Default Value

""

Remarks

This property contains the amount of any discount applied by the merchant to the entire order. This field should be empty if the LineItemUnitCost for each line item reflects a discount price, or if no discount applies.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

DutyAmount Property (TSYSLevel3 Component)

Duty fees (if any) for imported goods.

Syntax

__property String DutyAmount = { read=FDutyAmount, write=FSetDutyAmount };

Default Value

""

Remarks

This property contains the fee amount associated with the import of the purchased goods.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

FreightAmount Property (TSYSLevel3 Component)

Shipping charges associated with this transaction.

Syntax

__property String FreightAmount = { read=FFreightAmount, write=FSetFreightAmount };

Default Value

""

Remarks

This property contains the freight or shipping portion of the total transaction amount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

FreightTaxAmount Property (TSYSLevel3 Component)

Portion of the FreightAmount that is tax.

Syntax

__property String FreightTaxAmount = { read=FFreightTaxAmount, write=FSetFreightTaxAmount };

Default Value

""

Remarks

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the freight or shipping charges for the purchased item.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

FreightTaxRate Property (TSYSLevel3 Component)

Rate used to calculate the FreightTaxAmount .

Syntax

__property String FreightTaxRate = { read=FFreightTaxRate, write=FSetFreightTaxRate };

Default Value

""

Remarks

This property contains the tax rate used to calculate the FreightTaxAmount. This field has a two-digit implied decimal position, and the maximum length is 4 digits.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

LineItemCount Property (TSYSLevel3 Component)

The number of records in the LineItem arrays.

Syntax

__property int LineItemCount = { read=FLineItemCount, write=FSetLineItemCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• LineItemCommodityCode
• LineItemDebitCreditIndicator
• LineItemDescription
• LineItemDiscountAmount
• LineItemDiscountRate
• LineItemProductCode
• LineItemQuantity
• LineItemTaxAmount
• LineItemTaxIncluded
• LineItemTaxRate
• LineItemTaxType
• LineItemTotal
• LineItemUnitCost
• LineItemUnits

The array indices start at 0 and end at LineItemCount - 1.

This property is not available at design time.

Data Type

Integer

LineItemCommodityCode Property (TSYSLevel3 Component)

Code describing the good or service being supplied.

Syntax

__property String LineItemCommodityCode[int LineItemIndex] = { read=FLineItemCommodityCode, write=FSetLineItemCommodityCode };

Default Value

""

Remarks

Code describing the good or service being supplied.

This property will contain an international description code of the individual good or service being supplied. The acquirer's bank will provide the merchant an updated listing of currently defined codes. It is recommended to use a National or International list of standardized codes.

The maximum length for this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is only used for Visa Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemDebitCreditIndicator Property (TSYSLevel3 Component)

Debit/Credit Indicator.

Syntax

__property String LineItemDebitCreditIndicator[int LineItemIndex] = { read=FLineItemDebitCreditIndicator, write=FSetLineItemDebitCreditIndicator };

Default Value

"D"

Remarks

Debit/Credit Indicator.

This 1-character property represents the sign of the LineItemTotal. Possible values are:

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemDescription Property (TSYSLevel3 Component)

Description of the item.

Syntax

__property String LineItemDescription[int LineItemIndex] = { read=FLineItemDescription, write=FSetLineItemDescription };

Default Value

""

Remarks

Description of the item.

This property contains an alphanumeric description of the item(s) being supplied.

The maximum length of this property is 35 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemDiscountAmount Property (TSYSLevel3 Component)

Amount of the discount for each line item (if any).

Syntax

__property String LineItemDiscountAmount[int LineItemIndex] = { read=FLineItemDiscountAmount, write=FSetLineItemDiscountAmount };

Default Value

""

Remarks

Amount of the discount for each line item (if any).

This property contains the amount of any discount applied by the merchant to this line item. This property should be empty (or zero) if the LineItemUnitCost reflects a discount price or if no line item discount applies.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemDiscountRate Property (TSYSLevel3 Component)

Rate used to calculate the DiscountAmount .

Syntax

__property String LineItemDiscountRate[int LineItemIndex] = { read=FLineItemDiscountRate, write=FSetLineItemDiscountRate };

Default Value

""

Remarks

Rate used to calculate the LineItemDiscountAmount.

This property contains the rate used to calculate the LineItemDiscountAmount. This property is a two decimal value. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemProductCode Property (TSYSLevel3 Component)

Merchant-defined product code for this Line Item.

Syntax

__property String LineItemProductCode[int LineItemIndex] = { read=FLineItemProductCode, write=FSetLineItemProductCode };

Default Value

""

Remarks

Merchant-defined product code for this Line Item.

This property can contain a merchant-defined description of the individual item contained in this Line Item.

The maximum length of this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemQuantity Property (TSYSLevel3 Component)

Quantity of items in this Line Item.

Syntax

__property int LineItemQuantity[int LineItemIndex] = { read=FLineItemQuantity, write=FSetLineItemQuantity };

Default Value

0

Remarks

Quantity of items in this Line Item.

This property contains the quantity of items being purchased, in whole numbers. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97 All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

Integer

LineItemTaxAmount Property (TSYSLevel3 Component)

Tax on this individual item.

Syntax

__property String LineItemTaxAmount[int LineItemIndex] = { read=FLineItemTaxAmount, write=FSetLineItemTaxAmount };

Default Value

""

Remarks

Tax on this individual item.

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the purchased item.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemTaxIncluded Property (TSYSLevel3 Component)

Net/Gross Indicator.

Syntax

__property bool LineItemTaxIncluded[int LineItemIndex] = { read=FLineItemTaxIncluded, write=FSetLineItemTaxIncluded };

Default Value

false

Remarks

Net/Gross Indicator.

If this property is true, the LineItemTotal already contains the LineItemTaxAmount. If false, the LineItemTaxAmount has not yet been added to the LineItemTotal. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

Boolean

LineItemTaxRate Property (TSYSLevel3 Component)

Tax rate used to calculate the TaxAmount .

Syntax

__property String LineItemTaxRate[int LineItemIndex] = { read=FLineItemTaxRate, write=FSetLineItemTaxRate };

Default Value

""

Remarks

Tax rate used to calculate the LineItemTaxAmount.

This property contains the tax rate used to calculate the LineItemTaxAmount. This property has a two-digit implied decimal position, and the maximum length is 4 digits. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemTaxType Property (TSYSLevel3 Component)

Type of tax charged in TaxAmount .

Syntax

__property String LineItemTaxType[int LineItemIndex] = { read=FLineItemTaxType, write=FSetLineItemTaxType };

Default Value

""

Remarks

Type of tax charged in LineItemTaxAmount.

This 4-character property designates the type of value-added taxes that are being used.

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemTotal Property (TSYSLevel3 Component)

Total cost of this line item.

Syntax

__property String LineItemTotal[int LineItemIndex] = { read=FLineItemTotal, write=FSetLineItemTotal };

Default Value

""

Remarks

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as LineItemUnitCost multiplied by LineItemQuantity, with any LineItemTaxAmount and LineItemDiscountAmount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Note: This property is 12 digits in length for Visa, but only 9 for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemUnitCost Property (TSYSLevel3 Component)

Cost of each individual item.

Syntax

__property String LineItemUnitCost[int LineItemIndex] = { read=FLineItemUnitCost, write=FSetLineItemUnitCost };

Default Value

""

Remarks

Cost of each individual item.

This property contains the cost of each item in this Line Item. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is only used for Visa Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LineItemUnits Property (TSYSLevel3 Component)

Unit of measure for this Line Item.

Syntax

__property String LineItemUnits[int LineItemIndex] = { read=FLineItemUnits, write=FSetLineItemUnits };

Default Value

""

Remarks

Unit of measure for this Line Item.

This property contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the LineItemUnitCost is calculated. If you're selling rope by the foot, the LineItemUnits might be "feet". If you're selling chemicals, it might be by the "ounce". For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

The maximum length of this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The LineItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String

LocalTax Property (TSYSLevel3 Component)

Amount of local or state taxes that are a part of this transaction.

Syntax

__property String LocalTax = { read=FLocalTax, write=FSetLocalTax };

Default Value

""

Remarks

This property contains the sales tax associated with the purchase. If the transaction is exempt from local or state taxes, set this property to the text "EXEMPT".

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

MerchantTaxId Property (TSYSLevel3 Component)

Merchant's government tax Id number.

Syntax

__property String MerchantTaxId = { read=FMerchantTaxId, write=FSetMerchantTaxId };

Default Value

""

Remarks

This property contains the government-assigned tax identification number of the merchant from whom the goods or services were purchased.

The maximum length of this field is 20 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

NationalTax Property (TSYSLevel3 Component)

Amount of federal or national taxes that are a part of this transaction.

Syntax

__property String NationalTax = { read=FNationalTax, write=FSetNationalTax };

Default Value

""

Remarks

This property contains the national tax included in the TransactionAmount of the original transaction.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

OrderDate Property (TSYSLevel3 Component)

Date of the order in YYMMDD format.

Syntax

__property String OrderDate = { read=FOrderDate, write=FSetOrderDate };

Default Value

""

Remarks

This property contains the purchase order date, and must be supplied in the YYMMDD format.

The maximum length of this field is 6 digits.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

PurchaseIdentifier Property (TSYSLevel3 Component)

Optional purchase order number assigned by the merchant.

Syntax

__property String PurchaseIdentifier = { read=FPurchaseIdentifier, write=FSetPurchaseIdentifier };

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and will be automatically left-justified, space-filled to 25 spaces.

This field is applicable to E-Commerce, Hotel, and Auto Rental transactions.

Note: For the Hotel IndustryType, this property will contain the Hotel Folio Number. For the Auto Rental IndustryType, it should indicate the Rental Agreement Number.

Failure to set a PurchaseIdentifier for the e-commerce IndustryType may result in a CPS downgrade when the transaction is settled. This can result in higher interchange rates.

Data Type

String

PurchaseOrder Property (TSYSLevel3 Component)

Purchase Order Number supplied by the cardholder.

Syntax

__property String PurchaseOrder = { read=FPurchaseOrder, write=FSetPurchaseOrder };

Default Value

""

Remarks

This property contains a 16, 17, or 25-character Purchase Order Number or Customer Reference Identifier supplied by the Visa or MasterCard Purchasing Card cardholder.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

ShipFromZip Property (TSYSLevel3 Component)

Zip code the goods are being shipped from.

Syntax

__property String ShipFromZip = { read=FShipFromZip, write=FSetShipFromZip };

Default Value

""

Remarks

This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

TaxInvoiceNumber Property (TSYSLevel3 Component)

Unique Value Added Tax Invoice Reference Number.

Syntax

__property String TaxInvoiceNumber = { read=FTaxInvoiceNumber, write=FSetTaxInvoiceNumber };

Default Value

""

Remarks

This property contains the invoice number that is associated with the Value Added Tax (VAT) invoice.

The maximum length of this property is 15 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

Config Method (TSYSLevel3 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetAddendum Method (TSYSLevel3 Component)

Returns a Level III Purchasing card addendum based on the specified CardType .

Syntax

String __fastcall GetAddendum();

Remarks

The type of addendum created by this component depends upon the value of the CardType property. Different addendums are created when the CardType is set to tctVisa or tctMasterCard, and different properties are required for the two different CardTypes.

The following properties are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• LineItemDescription
• LineItemDiscountAmount
• LineItemProductCode
• LineItemQuantity
• LineItemTaxAmount
• LineItemTaxRate
• LineItemTotal
• LineItemUnits

Additional properties for the tctVisa CardType include:

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• LineItemCommodityCode
• LineItemUnitCost

Additional properties for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• LineItemDiscountRate
• LineItemTaxIncluded
• LineItemTaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType: 'First authorize the credit card TSYSECommerce1.TransactionAmount = "53" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. 'The following properties are required for a Visa Corporate Purchasing Card: TSYSLevel3.CardType = tctVisa TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "purchOrdNum" TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number TSYSLevel3.CommodityCode = "fake" TSYSLevel3.DiscountAmount = "0" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "840" TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo" TSYSLevel3.OrderDate = "060526" TSYSLevel3.FreightTaxAmount = "0" TSYSLevel3.FreightTaxRate = "0" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()

Reset Method (TSYSLevel3 Component)

Clears all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

This method clears all properties to their default values.

Error Event (TSYSLevel3 Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibcTSYSLevel3ErrorEventParams;
typedef void __fastcall (__closure *TibcTSYSLevel3ErrorEvent)(System::TObject* Sender, TibcTSYSLevel3ErrorEventParams *e);
__property TibcTSYSLevel3ErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (TSYSLevel3 Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

TSYSLevel3 Config Settings

Base Config Settings

Trappable Errors (TSYSLevel3 Component)

TSYSLevel3 Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	592   Invalid or unparseable aggregate.
	605   Invalid CardType.