TSYSLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

dpaymentssdk.Tsyslevel3

Remarks

This TSYSLevel3 class 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 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.

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

Additional fields for the tctVisa CardType include:

Additional fields for the tctMasterCard CardType include:

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.DetailRecords.Add(new TSYSRecordType()); TSYSSettle.DetailRecords[0].DetailAggregate = 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.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].CommodityCode = "fake"; TSYSLevel3.LineItems[0].Description = "hardware"; TSYSLevel3.LineItems[0].ProductCode = "productCode123"; TSYSLevel3.LineItems[0].Quantity = 1; TSYSLevel3.LineItems[0].Units = ""; TSYSLevel3.LineItems[0].UnitCost = "33"; TSYSLevel3.LineItems[0].TaxAmount = "0"; TSYSLevel3.LineItems[0].TaxRate = "0"; TSYSLevel3.LineItems[0].DiscountAmount = "0"; TSYSLevel3.LineItems[0].Total = "33"; TSYSLevel3.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[1].CommodityCode = "fake"; TSYSLevel3.LineItems[1].Description = "hardware"; TSYSLevel3.LineItems[1].ProductCode = "productCode124"; TSYSLevel3.LineItems[1].Quantity = 1; TSYSLevel3.LineItems[1].Units = ""; TSYSLevel3.LineItems[1].UnitCost = "20"; TSYSLevel3.LineItems[1].TaxAmount = "0"; TSYSLevel3.LineItems[1].TaxRate = "0"; TSYSLevel3.LineItems[1].DiscountAmount = "0"; TSYSLevel3.LineItems[1].Total = "20"; // Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel3.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.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0]. TSYSLevel3.LineItems[0].Description = "bolt" TSYSLevel3.LineItems[0].ProductCode = "BOLT6x20" TSYSLevel3.LineItems[0].Quantity = 2 TSYSLevel3.LineItems[0].Units = "each" TSYSLevel3.LineItems[0].TaxRate = "0" TSYSLevel3.LineItems[0].TaxType = "taxType" TSYSLevel3.LineItems[0].TaxAmount = "0" TSYSLevel3.LineItems[0].DiscountAmount = "0" TSYSLevel3.LineItems[0].TaxIncluded = False TSYSLevel3.LineItems[0].Total = "100" TSYSLevel3.LineItems[0].DiscountAmount = "0" TSYSLevel3.LineItems[0].DiscountRate = "0" TSYSLevel3.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[1].Description = "flange nut" TSYSLevel3.LineItems[1].ProductCode = "FLANGE6" TSYSLevel3.LineItems[1].Quantity = 1 TSYSLevel3.LineItems[1].Units = "each" TSYSLevel3.LineItems[1].TaxRate = "0" TSYSLevel3.LineItems[1].TaxType = "taxType" TSYSLevel3.LineItems[1].TaxAmount = "0" TSYSLevel3.LineItems[1].DiscountAmount = "0" TSYSLevel3.LineItems[1].TaxIncluded = False TSYSLevel3.LineItems[1].Total = "100" TSYSLevel3.LineItems[1].DiscountAmount = "0" TSYSLevel3.LineItems[1].DiscountRate = "0" // Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle1.DetailRecords[1].AddendumAggregate = 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 class with short descriptions. Click on the links for further details.

AlternateTaxAmountSecondary tax amount (only applicable in some countries).
AlternateTaxIdTax Id number of the merchant that reported the AlternateTaxAmount .
CardTypeThe card type for which a Level2 or Level3 addendum will be created.
CommodityCodeCode indicating the type of goods or services sold.
CustomerTaxIdCustomer's Value Added Tax registration number.
DestinationCountryCountry the goods are to be shipped to.
DestinationZipZip code the goods are to be shipped to.
DiscountAmountAmount of any discount subtracted from the line item totals.
DutyAmountDuty fees (if any) for imported goods.
FreightAmountShipping charges associated with this transaction.
FreightTaxAmountPortion of the FreightAmount that is tax.
FreightTaxRateRate used to calculate the FreightTaxAmount .
LineItemsA collection of line items to be included in the Level III addendum.
LocalTaxAmount of local or state taxes that are a part of this transaction.
MerchantTaxIdMerchant's government tax Id number.
NationalTaxAmount of federal or national taxes that are a part of this transaction.
OrderDateDate of the order in YYMMDD format.
PurchaseIdentifierOptional purchase order number assigned by the merchant.
PurchaseOrderPurchase Order Number supplied by the cardholder.
ShipFromZipZip code the goods are being shipped from.
TaxInvoiceNumberUnique Value Added Tax Invoice Reference Number.

Method List

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

ConfigSets or retrieves a configuration setting.
GetAddendumReturns a Level III Purchasing card addendum based on the specified CardType .
ResetClears all properties to their default values.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.

Config Settings

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

UseFractionalQuantitiesAllows the use of fractional quantities in the ItemQuantity property.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AlternateTaxAmount Property (TSYSLevel3 Class)

Secondary tax amount (only applicable in some countries).

Syntax


public String getAlternateTaxAmount();


public void setAlternateTaxAmount(String alternateTaxAmount);

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.

AlternateTaxId Property (TSYSLevel3 Class)

Tax Id number of the merchant that reported the AlternateTaxAmount .

Syntax


public String getAlternateTaxId();


public void setAlternateTaxId(String alternateTaxId);

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.

CardType Property (TSYSLevel3 Class)

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

Syntax


public int getCardType();


public void setCardType(int cardType);


Enumerated values:
  public final static int tctVisa = 0;
  public final static int tctMasterCard = 1;
  public final static int tctAmericanExpress = 2;

Default Value

0

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:

tctVisa (0) Visa card.
tctMasterCard (1) MasterCard card.
tctAmericanExpress (2) American Express card. (NOTE: American Express is not available for Level3).

CommodityCode Property (TSYSLevel3 Class)

Code indicating the type of goods or services sold.

Syntax


public String getCommodityCode();


public void setCommodityCode(String commodityCode);

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.

CustomerTaxId Property (TSYSLevel3 Class)

Customer's Value Added Tax registration number.

Syntax


public String getCustomerTaxId();


public void setCustomerTaxId(String customerTaxId);

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.

DestinationCountry Property (TSYSLevel3 Class)

Country the goods are to be shipped to.

Syntax


public String getDestinationCountry();


public void setDestinationCountry(String destinationCountry);

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.

DestinationZip Property (TSYSLevel3 Class)

Zip code the goods are to be shipped to.

Syntax


public String getDestinationZip();


public void setDestinationZip(String destinationZip);

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.

DiscountAmount Property (TSYSLevel3 Class)

Amount of any discount subtracted from the line item totals.

Syntax


public String getDiscountAmount();


public void setDiscountAmount(String discountAmount);

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

DutyAmount Property (TSYSLevel3 Class)

Duty fees (if any) for imported goods.

Syntax


public String getDutyAmount();


public void setDutyAmount(String dutyAmount);

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.

FreightAmount Property (TSYSLevel3 Class)

Shipping charges associated with this transaction.

Syntax


public String getFreightAmount();


public void setFreightAmount(String freightAmount);

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.

FreightTaxAmount Property (TSYSLevel3 Class)

Portion of the FreightAmount that is tax.

Syntax


public String getFreightTaxAmount();


public void setFreightTaxAmount(String freightTaxAmount);

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.

FreightTaxRate Property (TSYSLevel3 Class)

Rate used to calculate the FreightTaxAmount .

Syntax


public String getFreightTaxRate();


public void setFreightTaxRate(String freightTaxRate);

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.

LineItems Property (TSYSLevel3 Class)

A collection of line items to be included in the Level III addendum.

Syntax


public TSYSLineItemList getLineItems();


public void setLineItems(TSYSLineItemList lineItems);

Remarks

This property contains a collection of line items to be included in the Level III addendum.

This property is used for both Visa and MasterCard Corporate Purchasing Cards. However, the line item fields that each card supports are different.

List of valid Line Item properties for Visa:

List of valid Line Item properties for Mastercard:

An example of setting two line items for a Visa Corporate purchasing card follows:

TSYSLevel3.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].CommodityCode = "fake" TSYSLevel3.LineItems[0].Description = "hardware" TSYSLevel3.LineItems[0].ProductCode = "productCode123" TSYSLevel3.LineItems[0].Quantity = 1 TSYSLevel3.LineItems[0].Units = "" TSYSLevel3.LineItems[0].UnitCost = "33" TSYSLevel3.LineItems[0].TaxAmount = "0" TSYSLevel3.LineItems[0].TaxRate = "0" TSYSLevel3.LineItems[0].DiscountAmount = "0" TSYSLevel3.LineItems[0].Total = "33" TSYSLevel3.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[1].CommodityCode = "fake" TSYSLevel3.LineItems[1].Description = "hardware" TSYSLevel3.LineItems[1].ProductCode = "productCode124" TSYSLevel3.LineItems[1].Quantity = 1 TSYSLevel3.LineItems[1].Units = "" TSYSLevel3.LineItems[1].UnitCost = "20" TSYSLevel3.LineItems[1].TaxAmount = "0" TSYSLevel3.LineItems[1].TaxRate = "0" TSYSLevel3.LineItems[1].DiscountAmount = "0" TSYSLevel3.LineItems[1].Total = "20"

Please refer to the TSYSLineItem type for a complete list of fields.

LocalTax Property (TSYSLevel3 Class)

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

Syntax


public String getLocalTax();


public void setLocalTax(String localTax);

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.

MerchantTaxId Property (TSYSLevel3 Class)

Merchant's government tax Id number.

Syntax


public String getMerchantTaxId();


public void setMerchantTaxId(String merchantTaxId);

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.

NationalTax Property (TSYSLevel3 Class)

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

Syntax


public String getNationalTax();


public void setNationalTax(String nationalTax);

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.

OrderDate Property (TSYSLevel3 Class)

Date of the order in YYMMDD format.

Syntax


public String getOrderDate();


public void setOrderDate(String orderDate);

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.

PurchaseIdentifier Property (TSYSLevel3 Class)

Optional purchase order number assigned by the merchant.

Syntax


public String getPurchaseIdentifier();


public void setPurchaseIdentifier(String purchaseIdentifier);

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.

PurchaseOrder Property (TSYSLevel3 Class)

Purchase Order Number supplied by the cardholder.

Syntax


public String getPurchaseOrder();


public void setPurchaseOrder(String purchaseOrder);

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.

ShipFromZip Property (TSYSLevel3 Class)

Zip code the goods are being shipped from.

Syntax


public String getShipFromZip();


public void setShipFromZip(String shipFromZip);

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.

TaxInvoiceNumber Property (TSYSLevel3 Class)

Unique Value Added Tax Invoice Reference Number.

Syntax


public String getTaxInvoiceNumber();


public void setTaxInvoiceNumber(String taxInvoiceNumber);

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.

Config Method (Tsyslevel3 Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Class)

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

Syntax

public String getAddendum();

Remarks

The type of addendum created by this class 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 fields are valid for both tctVisa and tctMasterCard CardTypes.

Additional fields for the tctVisa CardType include:

Additional fields for the tctMasterCard CardType include:

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.DetailRecords.Add(new TSYSRecordType()); TSYSSettle.DetailRecords[0].DetailAggregate = 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.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].CommodityCode = "fake"; TSYSLevel3.LineItems[0].Description = "hardware"; TSYSLevel3.LineItems[0].ProductCode = "productCode123"; TSYSLevel3.LineItems[0].Quantity = 1; TSYSLevel3.LineItems[0].Units = ""; TSYSLevel3.LineItems[0].UnitCost = "33"; TSYSLevel3.LineItems[0].TaxAmount = "0"; TSYSLevel3.LineItems[0].TaxRate = "0"; TSYSLevel3.LineItems[0].DiscountAmount = "0"; TSYSLevel3.LineItems[0].Total = "33"; TSYSLevel3.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[1].CommodityCode = "fake"; TSYSLevel3.LineItems[1].Description = "hardware"; TSYSLevel3.LineItems[1].ProductCode = "productCode124"; TSYSLevel3.LineItems[1].Quantity = 1; TSYSLevel3.LineItems[1].Units = ""; TSYSLevel3.LineItems[1].UnitCost = "20"; TSYSLevel3.LineItems[1].TaxAmount = "0"; TSYSLevel3.LineItems[1].TaxRate = "0"; TSYSLevel3.LineItems[1].DiscountAmount = "0"; TSYSLevel3.LineItems[1].Total = "20"; // Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel3.GetAddendum();

Reset Method (Tsyslevel3 Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

Error Event (Tsyslevel3 Class)

Information about errors during data delivery.

Syntax

public class DefaultTsyslevel3EventListener implements Tsyslevel3EventListener {
  ...
  public void error(Tsyslevel3ErrorEvent e) {}
  ...
}

public class Tsyslevel3ErrorEvent {
  public int errorCode;
  public String description;
}

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.

TSYSLineItem Type

Contains a single Level 3 line item.

Remarks

This type contains a single line item, used for Level 3 settlements. The fields contained by this type are listed below.

Fields

CommodityCode
String
Default Value: ""

Code describing the good or service being supplied.

This field 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 field is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

DebitCreditIndicator
String
Default Value: "D"

Debit/Credit Indicator.

This 1-character field represents the sign of the Total. Possible values are:

C - Line Item Amount is a Credit (negative amount)
D - Line Item Amount is a Debit (positive amount)

This property is only used for MasterCard Corporate Purchasing Cards.

Description
String
Default Value: ""

Description of the item.

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

The maximum length of this field is 35 characters.

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

DiscountAmount
String
Default Value: ""

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

This field contains the amount of any discount applied by the merchant to this line item. This field should be empty (or zero) if the UnitCost 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.

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

DiscountRate
String
Default Value: ""

Rate used to calculate the DiscountAmount.

This field contains the rate used to calculate the DiscountAmount. This field is a two decimal value. This property is only used for MasterCard Corporate Purchasing Cards.

ProductCode
String
Default Value: ""

Merchant-defined product code for this Line Item.

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

The maximum length of this field is 12 characters.

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

Quantity
int
Default Value: 0

Quantity of items in this Line Item.

This field 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.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].Quantity = 3; TSYSLevel3.LineItems[0].UnitCost = "1399"; TSYSLevel3.LineItems[0].Units = "each"; TSYSLevel3.LineItems[0].Total = "4197"; // $13.99 x 3 = $41.97

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

TaxAmount
String
Default Value: ""

Tax on this individual item.

This field 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.

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

TaxIncluded
boolean
Default Value: False

Net/Gross Indicator.

If this field is true, the Total already contains the TaxAmount. If false, the TaxAmount has not yet been added to the Total. This property is only used for MasterCard Corporate Purchasing Cards.

TaxRate
String
Default Value: ""

Tax rate used to calculate the TaxAmount.

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

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

TaxType
String
Default Value: ""

Type of tax charged in TaxAmount.

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

This property is only used for MasterCard Corporate Purchasing Cards.

Total
String
Default Value: ""

Total cost of this line item.

This field contains the total amount of the individual item, typically calculated as UnitCost multiplied by Quantity, with any TaxAmount and DiscountAmount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].Quantity = 3; TSYSLevel3.LineItems[0].UnitCost = "1399"; TSYSLevel3.LineItems[0].Units = "each"; TSYSLevel3.LineItems[0].Total = "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 field is 12 digits in length for Visa, but only 9 for MasterCard.

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

UnitCost
String
Default Value: ""

Cost of each individual item.

This field 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.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].Quantity = 3; TSYSLevel3.LineItems[0].UnitCost = "1399"; TSYSLevel3.LineItems[0].Units = "each"; TSYSLevel3.LineItems[0].Total = "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.

This property is only used for Visa Corporate Purchasing Cards.

Units
String
Default Value: ""

Unit of measure for this Line Item.

This field contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the UnitCost is calculated. If you're selling rope by the foot, the Units 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.LineItems.Add(new TSYSLineItem()); TSYSLevel3.LineItems[0].Quantity = 3; TSYSLevel3.LineItems[0].UnitCost = "1399"; TSYSLevel3.LineItems[0].Units = "each"; TSYSLevel3.LineItems[0].Total = "4197"; // $13.99 x 3 = $41.97

The maximum length of this field is 12 characters.

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

Constructors

public TSYSLineItem();



Config Settings (Tsyslevel3 Class)

The class 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 class, access to these internal properties is provided through the Config method.

TSYSLevel3 Config Settings

UseFractionalQuantities:   Allows the use of fractional quantities in the ItemQuantity property.

Normally, the Quantity field is expressed as whole integer values. If you have two items on a particular line item, you set Quantity to 2. However, if you are selling fractional quantities, you may set the UseFractionalQuantites setting to True. Quantity will then contain an implied four decimal places. So the above example would change to Quantity[0] = 20000.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (Tsyslevel3 Class)

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.