Level3 Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

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.

LineItems Property (Level3 Component)

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

Syntax

• C#
• VB.NET

public EPLineItemList LineItems { get; }

Public Property LineItems As EPLineItemList

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

A list of additional fields to send in the request.

Syntax

• C#
• VB.NET

public EPSpecialFieldList SpecialFields { get; }

Public Property SpecialFields As EPSpecialFieldList

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 component by adding fields for which there are not currently properties for.

This property is not available at design time.

AddSpecialField Method (Level3 Component)

Adds a special field name and the corresponding value.

Syntax

• C#
• VB.NET

public void AddSpecialField(string name, string value);

Public Sub AddSpecialField(ByVal Name As String, ByVal Value As String)

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

GetAggregate Method (Level3 Component)

Returns an aggregate containing level 3 details for a transaction.

Syntax

• C#
• VB.NET

public string GetAggregate();

Public Function GetAggregate() As String

Remarks

This method returns an aggregate containing the level 3 data specified. This aggregate must be passed to the ICharge component'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:

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"; ICharge.Level3Aggregate = Level3.GetAggregate();

Error Event (Level3 Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class Level3ErrorEventArgs 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.

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.

• CommodityCode
• Description
• DiscountAmount
• DiscountRate
• Name
• ProductCode
• Quantity
• Taxable
• TaxAmount
• TaxRate
• TaxType
• Total
• UnitCost
• Units

Fields

Constructors

• C#
• VB.NET

public EPLineItem();

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 component 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"));

• Name
• Value

Fields

Constructors

• C#
• VB.NET

public EPSpecialField();

Public EPSpecialField()

• C#
• VB.NET

public EPSpecialField(string name, string value);

Public EPSpecialField(ByVal Name As String, ByVal Value As String)

Config Settings (Level3 Component)

Level3 Config Settings

Base Config Settings

Trappable Errors (Level3 Component)

Level3 Errors