Level2 Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPayments.InPay.Level2

Remarks

The available fields for each gateway supporting Level 2 data can be found below. Note: ShipToZip is only used for gateways that use a different parameter than the ShippingInfo property. 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.

DutyAmount Property (Level2 Component)

Duty fees (if any) for imported goods.

Syntax

• C#
• VB.NET

public string DutyAmount { get; set; }

Public Property DutyAmount As String

Default Value

""

Remarks

This property contains the fee amount associated with the import of the purchased goods.

FreightAmount Property (Level2 Component)

Shipping charges associated with this transaction.

Syntax

• C#
• VB.NET

public string FreightAmount { get; set; }

Public Property FreightAmount As String

Default Value

""

Remarks

This property contains the freight or shipping portion of the total transaction amount.

PONumber Property (Level2 Component)

Purchase order number assigned by the merchant.

Syntax

• C#
• VB.NET

public string PONumber { get; set; }

Public Property PONumber As String

Default Value

""

Remarks

This property is used by the merchant to specify a purchase order number for the transaction.

ShipFromZip Property (Level2 Component)

Zip code the goods are being shipped from.

Syntax

• C#
• VB.NET

public string ShipFromZip { get; set; }

Public Property ShipFromZip As String

Default Value

""

Remarks

This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.

ShipToZip Property (Level2 Component)

Zip code the goods are being shipped TO.

Syntax

• C#
• VB.NET

public string ShipToZip { get; set; }

Public Property ShipToZip As String

Default Value

""

Remarks

This property contains the Postal/Zip code of the address where the purchased goods are being shipped to.

SpecialFields Property (Level2 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.

TaxAmount Property (Level2 Component)

Sales tax charged in addition to the original TransactionAmount.

Syntax

• C#
• VB.NET

public string TaxAmount { get; set; }

Public Property TaxAmount As String

Default Value

""

Remarks

This property contains the amount of state or provincial (or VAT) tax included in the transaction amount.

TaxExempt Property (Level2 Component)

Specifies the tax exempt status of the transaction.

Syntax

• C#
• VB.NET

public Level2TaxExempts TaxExempt { get; set; }

enum Level2TaxExempts {
  teNotProvided,
  teTrue,
  teFalse
}

Public Property TaxExempt As Level2TaxExempts

Enum Level2TaxExempts
  teNotProvided
  teTrue
  teFalse
End Enum

Default Value

0

Remarks

This property is used to specify whether the transaction is tax exempt.

The available values are:

• teNotProvided (0) (default)
• teTrue (1)
• teFalse (2)

AddSpecialField Method (Level2 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

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

Config Method (Level2 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 (Level2 Component)

Returns an aggregate containing level 2 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 2 data specified. This aggregate must be passed to the ICharge component's Level2Aggregate property in order for the level 2 data to be sent in the transaction. Each gateway has different requirements when processing level 2 transactions. Please refer to Level2 to identify which properties are required for the gateway you are implementing.

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

Level2.PONumber = "123456789"; Level2.ShipToZip = "27713"; Level2.TaxAmount = "1.23"; Level2.IsTaxExempt = false; ICharge.Level2Aggregate = Level2.GetAggregate();

Error Event (Level2 Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

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

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

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

Level2 Config Settings

Base Config Settings

Trappable Errors (Level2 Component)

Level2 Errors

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