TSYSLevel2 Class

Properties Methods Events Config Settings Errors

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

Syntax

dpaymentssdk.Tsyslevel2

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). 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:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). 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:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.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 class with short descriptions. Click on the links for further details.


AmexCardholderReference	Reference number supplied by the card holder.
AmexChargeDescriptor	Description of this transaction.
AmexSalesTax	Portion of the transaction amount which is sales tax.
AmexShippedToZip	The zip code to which the commodity was shipped.
AmexSupplierNumber	Supplier Reference Number contained in the American Express Level 2 addendum.
CardType	The card type for which a Level2 or Level3 addendum will be created.
IsTaxExempt	Indicates whether this purchasing card qualifies for tax-exempt status.
LocalSalesTax	Sales tax charged in addition to the original TransactionAmount .
PurchaseOrderNumber	Optional customer-specified purchase order 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.


Config	Sets or retrieves a 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 class with short descriptions. Click on the links for further details.


Error	Information 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.


BuildInfo	Information about the product's build.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AmexCardholderReference Property (TSYSLevel2 Class)

Reference number supplied by the card holder.

Syntax


public String getAmexCardholderReference();


public void setAmexCardholderReference(String amexCardholderReference);

Default Value

Remarks

This property is defined by the card member and entered by the merchant at the point-of-sale. This information will be displayed within the Statement/Reporting process and may include accounting information specific to the client.

The maximum length for this property is 17 characters.

AmexChargeDescriptor Property (TSYSLevel2 Class)

Description of this transaction.

Syntax


public String getAmexChargeDescriptor();


public void setAmexChargeDescriptor(String amexChargeDescriptor);

Default Value

Remarks

This property may contain up to 40 characters of free text (Spaces allowed). This is a required property for an American Express addendum.

AmexSalesTax Property (TSYSLevel2 Class)

Portion of the transaction amount which is sales tax.

Syntax


public String getAmexSalesTax();


public void setAmexSalesTax(String amexSalesTax);

Default Value

Remarks

The sales tax charged 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 maximum length of this field is 6 digits, thus the maximum AmexSalesTax is "999999", yielding a US dollar amount of $9,999.99. This field may not contain a negative number.

AmexShippedToZip Property (TSYSLevel2 Class)

The zip code to which the commodity was shipped.

Syntax


public String getAmexShippedToZip();


public void setAmexShippedToZip(String amexShippedToZip);

Default Value

Remarks

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place.

The maximum length for this property is 6 characters.

AmexSupplierNumber Property (TSYSLevel2 Class)

Supplier Reference Number contained in the American Express Level 2 addendum.

Syntax


public String getAmexSupplierNumber();


public void setAmexSupplierNumber(String amexSupplierNumber);

Default Value

Remarks

This property contains a reference number that is used by American Express to obtain supporting information on a charge from a Merchant. Supporting documentation should be readily available in case of inquiry. The number can be any combination of characters and numerals defined by the Merchant or Authorized Processor. However, it must be an index to the Merchant's record, so that charge information can be readily retrieved and promptly submitted within 10 calendar days (or within the period stipulated in the contractual agreement). This number appears on the card member descriptive billing and Merchant inquiry reports.

The maximum length for this property is 9 characters.

CardType Property (TSYSLevel2 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

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

IsTaxExempt Property (TSYSLevel2 Class)

Indicates whether this purchasing card qualifies for tax-exempt status.

Syntax


public boolean isIsTaxExempt();


public void setIsTaxExempt(boolean isTaxExempt);

Default Value

False

Remarks

This property cannot be True if there is a LocalTax amount set.

LocalSalesTax Property (TSYSLevel2 Class)

Sales tax charged in addition to the original TransactionAmount .

Syntax


public String getLocalSalesTax();


public void setLocalSalesTax(String localSalesTax);

Default Value

Remarks

Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale 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 maximum length of this property is 12 digits.

PurchaseOrderNumber Property (TSYSLevel2 Class)

Optional customer-specified purchase order number.

Syntax


public String getPurchaseOrderNumber();


public void setPurchaseOrderNumber(String purchaseOrderNumber);

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.

Config Method (Tsyslevel2 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 (Tsyslevel2 Class)

Returns a Level2 Purchasing card addendum based on the specified CardType .

Syntax

public String getAddendum();

Remarks

Reset Method (Tsyslevel2 Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

Error Event (Tsyslevel2 Class)

Information about errors during data delivery.

Syntax

public class DefaultTsyslevel2EventListener implements Tsyslevel2EventListener {
  ...
  public void error(Tsyslevel2ErrorEvent e) {}
  ...
}

public class Tsyslevel2ErrorEvent {
  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.

Config Settings (Tsyslevel2 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.

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 (Tsyslevel2 Class)

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