Level3 Class

Properties Methods Events Config Settings Errors

The Level3 class is a tool used to create Level3 Corporate Purchasing Card aggregates, which can then be passed to the ICharge or Retail classes.

Syntax

inpay.Level3

Remarks

The available fields for each gateway supporting Level 3 data can be found below. Note: This list of fields does not designate what is required but rather only the fields made available by the gateway. For the required fields required to obtain the best rates, please consult your gateway for further information.

Gateway

Quantity

CommodityCode

Name

Description

Units

UnitCost

ProductCode

DiscountAmount

DiscountRate

Total

Taxable

TaxAmount

TaxRate

TaxType

gwAuthorizeNet (1)

gwPayFlowPro (6)

gwUSAePay (7)

gwPlugNPay (8)

gwMPCS (10)

gwRTWare (11)

gwECX (12)

gwBankOfAmerica (13)

gw3DSI (18)

gwTrustCommerce (19)

gwPSIGate (20)

gwPayFuse (21)

gwOrbital (23)

gwLinkPoint (24)

gwMoneris (25)

gwNetworkMerchants (28)

gwIngenico (29)

gwFirstData (33)

gwYourPay (34)

gwCyberSource (37)

gwGoEMerchant (39)

gwChase (41)

gwSterling (45)

gwMonerisUSA (52)

gwBambora (53)

gwVerifi (54)

gwLitle (63)

gwHSBC (66)

gwBluePay (67)

gwBarclay (69)

gwPayTrace (70)

gwTransNationalBankcard (74)

gwDataCash (77)

gwFirstDataE4 (80)

gwPayscape (83)

gwAuthorizeNetCIM (85)

gw5thDimension (86)

gwPaymentWorkSuite (88)

gwPSIGateXML (89)

gwPayeezy (94)

gwAmericanPaymentSolutions (105)

Property List

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


LineItems	A collection of line items to be included in the Level 3 addendum.
SpecialFields	A list of additional fields to send in the request.

Method List

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


AddSpecialField	Adds a special field name and the corresponding value.
Config	Sets or retrieves a configuration setting.
GetAggregate	Returns an aggregate containing level 3 details for a transaction.

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.


EscapeXML	Automatically escape the data in the aggregate.
BuildInfo	Information about the product's build.
GUIAvailable	Tells the class 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	Tells the class whether or not to use the system security libraries or an internal implementation.

LineItems Property (Level3 Class)

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

Syntax


public EPLineItemList getLineItems();


public void setLineItems(EPLineItemList lineItems);

Remarks

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

Please refer to Level3 to identify which LineItems are required for the gateway you are implementing.

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

Level3.LineItems.Add(new EPLineItem()); Level3.LineItems[0].CommodityCode = "4900"; // Books and printed materials Level3.LineItems[0].Description = "Reference manual"; Level3.LineItems[0].DiscountAmount = ""; // No discount Level3.LineItems[0].ProductCode = "ISBN123456"; Level3.LineItems[0].Quantity = "2"; Level3.LineItems[0].TaxAmount = "60"; Level3.LineItems[0].TaxRate = "600"; // 6.00 percent Level3.LineItems[0].Total = "1060"; Level3.LineItems[0].UnitCost = "500"; Level3.LineItems[0].Units = "each"; Level3.LineItems.Add(new EPLineItem()); Level3.LineItems[1].CommodityCode = "4900"; Level3.LineItems[1].Description = "Quick Start manual"; Level3.LineItems[1].DiscountAmount = ""; Level3.LineItems[1].ProductCode = "ISBN654321"; Level3.LineItems[1].Quantity = "1"; Level3.LineItems[1].TaxAmount = "60"; Level3.LineItems[1].TaxRate = "600"; // 6.00 percent Level3.LineItems[1].Total = "1060"; Level3.LineItems[1].UnitCost = "1000"; Level3.LineItems[1].Units = "each";

SpecialFields Property (Level3 Class)

A list of additional fields to send in the request.

Syntax


public EPSpecialFieldList getSpecialFields();


public void setSpecialFields(EPSpecialFieldList specialFields);

Remarks

This property contains a collection of EPSpecialField name/value pair objects. The Gateway may put some special configuration fields into this property which you can edit or add to. This allows you to extend the functionality of the class by adding fields for which there are not currently properties for.

This property is not available at design time.

AddSpecialField Method (Level3 Class)

Adds a special field name and the corresponding value.

Syntax

public void addSpecialField(String name, String value);

Remarks

This method allows for specifying special fields for level 3 details at a transaction as well as a line item level. Typically level 3 details pertain to item details, however some gateways expose fields that are not item specific. This method allows you to specify these fields. Additionally you can specify item specific fields that aren't exposed via LineItems. Please consult the gateways specifications to obtain available fields and their format.

Gateways implemented using XML may require the elements to be split into their own line item elements. In such a case, the specified Name value can be specified in the form "[index]:[name]" (where 'index' is the LineItems index and 'name' is the name of the element you wish to add). The component will then parse the format and place line item data within the correct element in the request.

The following gateways are implemented using XML and support indexed special field values:

gwBankOfAmerica (13)
gwOrbital (23)
gwSterling (45)
gwLitle (63)
gwPayTrace (70)
gwDataCash (77)
gwFirstDataE4 (80)

Please refer to the Name and Value fields for more information on form variables and how they are managed.

Config Method (Level3 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.

GetAggregate Method (Level3 Class)

Returns an aggregate containing level 3 details for a transaction.

Syntax

public String getAggregate();

Remarks

This method returns an aggregate containing the level 3 data specified. This aggregate must be passed to the ICharge class's Level3Aggregate property in order for the level 3 data to be sent in the transaction. Each gateway has different requirements when processing level 3 transactions. Please refer to Level3 to identify which properties are required for the gateway you are implementing.

An example of how this method is used is shown below:

Error Event (Level3 Class)

Information about errors during data delivery.

Syntax

public class DefaultLevel3EventListener implements Level3EventListener {
  ...
  public void error(Level3ErrorEvent e) {}
  ...
}

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

EPLineItem 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	Code indicating the type of goods or services sold. This field 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.
Description String	Description of the item. This field contains an alphanumeric description of the item(s) being supplied.
DiscountAmount String	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.
DiscountRate String	Rate of the discount for each line item (if any). This field contains the discount percentage 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.
Name String	Name of the item. This field contains the name of the item(s) being supplied.
ProductCode String	Product code of the item purchased. This field contains a code assigned to the product by the merchant. This may be a UPC or any other code with which the merchant wishes to identify an individual product.
Quantity int	Quantity of items in this Line Item. This field contains the quantity of items being purchased, in whole numbers. For Orbital Gateway this field must include 4 decimals without the decimal separator. For example for 1 quantity this field must be set to 10000.
Taxable boolean	Specifies whether the items in this Line Item are taxable. This field identifies whether this line item is taxable.
TaxAmount String	Tax on this individual item. This field contains the amount of any Value Added Taxes (VAT) which can be associated with the purchased item.
TaxRate String	Tax rate used to calculate the TaxAmount. This field contains the tax rate used to calculate the TaxAmount.
TaxType String	Type of tax charged in TaxAmount. This field designates the type of value-added taxes (VAT) that are being charged in TaxAmount
Total String	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.
UnitCost String	Cost of each individual item. This field contains the cost of each item in this Line Item.
Units String	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".

Constructors

public EPLineItem();

EPSpecialField Type

Additional name/value pairs which can be added to a transaction.

Remarks

This type contains a Name and Value which may contain any additional information you wish to send to your gateway that this class does not currently send. You must know the field name in the gateway integration guide available from your gateway. For instance, the code below shows how to add a customer IP Address for the Authorize.Net gateway:

ICharge1.SpecialFields.add(new EPSpecialField("x_customer_ip", "255.123.456.78"));

Fields

Name
String

Name of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.

This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

Value
String

Value of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.

Note: This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

Constructors

public EPSpecialField();

public EPSpecialField( name,  value);

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

Level3 Config Settings

EscapeXML: Automatically escape the data in the aggregate.

When set to true, this config will cause the component to automatically escape the XML data in the aggregate returned by GetAggregate. The default value is false.

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 class 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: Tells the class 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 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 (Level3 Class)

Level3 Errors

501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.


	501 Data field invalid length.
	502 Data field invalid format.
	503 Data field out of range.