TSYSLevel2 Component

Properties Methods Events Config Settings Errors

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

Syntax

DPayments.DPaymentsSDK.Tsyslevel2

Remarks

The type of addendum created by this component 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 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.


BuildInfo	Information about the product's build.
GUIAvailable	Tells the component 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.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

AmexCardholderReference Property (TSYSLevel2 Component)

Reference number supplied by the card holder.

public string AmexCardholderReference { get; set; }

Public Property AmexCardholderReference As String

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

Description of this transaction.

Syntax

C#
VB.NET

public string AmexChargeDescriptor { get; set; }

Public Property AmexChargeDescriptor As String

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

Portion of the transaction amount which is sales tax.

Syntax

C#
VB.NET

public string AmexSalesTax { get; set; }

Public Property AmexSalesTax As String

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

The zip code to which the commodity was shipped.

Syntax

C#
VB.NET

public string AmexShippedToZip { get; set; }

Public Property AmexShippedToZip As String

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

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

Syntax

C#
VB.NET

public string AmexSupplierNumber { get; set; }

Public Property AmexSupplierNumber As String

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

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

Syntax

C#
VB.NET

public Tsyslevel2CardTypes CardType { get; set; }

enum Tsyslevel2CardTypes {
  tctVisa,
  tctMasterCard,
  tctAmericanExpress
}

Public Property CardType As Tsyslevel2CardTypes

Enum Tsyslevel2CardTypes
  tctVisa
  tctMasterCard
  tctAmericanExpress
End Enum

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

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

Syntax

C#
VB.NET

public bool IsTaxExempt { get; set; }

Public Property IsTaxExempt As Boolean

Default Value

False

Remarks

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

LocalSalesTax Property (TSYSLevel2 Component)

Sales tax charged in addition to the original TransactionAmount

Syntax

C#
VB.NET

public string LocalSalesTax { get; set; }

Public Property LocalSalesTax As String

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

Optional customer-specified purchase order number.

Syntax

C#
VB.NET

public string PurchaseOrderNumber { get; set; }

Public Property PurchaseOrderNumber As String

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

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

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 (TSYSLevel2 Component)

Returns a Level2 Purchasing card addendum based on the specified CardType

Syntax

C#
VB.NET

public string GetAddendum();

Public Function GetAddendum() As String

Remarks

Reset Method (TSYSLevel2 Component)

Clears all properties to their default values.

Syntax

C#
VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Error Event (TSYSLevel2 Component)

Information about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, Tsyslevel2ErrorEventArgs e);

public class Tsyslevel2ErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As Tsyslevel2ErrorEventArgs)

Public Class Tsyslevel2ErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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

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: Tells the component 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 component 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 component 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 component 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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Tells the component whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to true.

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (TSYSLevel2 Component)

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.