Level3 Module

Properties   Methods   Events   Config Settings   Errors  

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

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.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

LineItems Property (Level3 Module)

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

Syntax

• Swift
• Objective-C

public var lineItems: Array<EPLineItem> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=lineItemCount,setter=setLineItemCount:) int lineItemCount;

- (int)lineItemCount;
- (void)setLineItemCount :(int)newLineItemCount;

- (NSString*)itemCommodityCode:(int)itemIndex;
- (void)setItemCommodityCode:(int)itemIndex :(NSString*)newItemCommodityCode;

- (NSString*)itemDescription:(int)itemIndex;
- (void)setItemDescription:(int)itemIndex :(NSString*)newItemDescription;

- (NSString*)itemDiscountAmount:(int)itemIndex;
- (void)setItemDiscountAmount:(int)itemIndex :(NSString*)newItemDiscountAmount;

- (NSString*)itemDiscountRate:(int)itemIndex;
- (void)setItemDiscountRate:(int)itemIndex :(NSString*)newItemDiscountRate;

- (NSString*)itemName:(int)itemIndex;
- (void)setItemName:(int)itemIndex :(NSString*)newItemName;

- (NSString*)itemProductCode:(int)itemIndex;
- (void)setItemProductCode:(int)itemIndex :(NSString*)newItemProductCode;

- (int)itemQuantity:(int)itemIndex;
- (void)setItemQuantity:(int)itemIndex :(int)newItemQuantity;

- (BOOL)itemTaxable:(int)itemIndex;
- (void)setItemTaxable:(int)itemIndex :(BOOL)newItemTaxable;

- (NSString*)itemTaxAmount:(int)itemIndex;
- (void)setItemTaxAmount:(int)itemIndex :(NSString*)newItemTaxAmount;

- (NSString*)itemTaxRate:(int)itemIndex;
- (void)setItemTaxRate:(int)itemIndex :(NSString*)newItemTaxRate;

- (NSString*)itemTaxType:(int)itemIndex;
- (void)setItemTaxType:(int)itemIndex :(NSString*)newItemTaxType;

- (NSString*)itemTotal:(int)itemIndex;
- (void)setItemTotal:(int)itemIndex :(NSString*)newItemTotal;

- (NSString*)itemUnitCost:(int)itemIndex;
- (void)setItemUnitCost:(int)itemIndex :(NSString*)newItemUnitCost;

- (NSString*)itemUnits:(int)itemIndex;
- (void)setItemUnits:(int)itemIndex :(NSString*)newItemUnits;

 

Default Value

""

Remarks

SpecialFields Property (Level3 Module)

A list of additional fields to send in the request.

Syntax

• Swift
• Objective-C

public var specialFields: Array<EPSpecialField> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=specialFieldCount,setter=setSpecialFieldCount:) int specialFieldCount;

- (int)specialFieldCount;
- (void)setSpecialFieldCount :(int)newSpecialFieldCount;

- (NSString*)specialFieldName:(int)fieldIndex;
- (void)setSpecialFieldName:(int)fieldIndex :(NSString*)newSpecialFieldName;

- (NSString*)specialFieldValue:(int)fieldIndex;
- (void)setSpecialFieldValue:(int)fieldIndex :(NSString*)newSpecialFieldValue;

 

Default Value

""

Remarks

AddSpecialField Method (Level3 Module)

Adds a special field name and the corresponding value.

Syntax

• Swift
• Objective-C

public func addSpecialField(name: String, value: String) throws -> Void

- (void)addSpecialField:(NSString*)name :(NSString*)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 SpecialFieldsName and SpecialFieldsValue properties for more information on form variables and how they are managed.

Config Method (Level3 Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 Module)

Returns an aggregate containing level 3 details for a transaction.

Syntax

• Swift
• Objective-C

public func getAggregate() throws -> String

- (NSString*)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:

Level2.PONumber = "123456789" Level2.ShipToZip = "27713" Level2.TaxAmount = "1.23" Level2.IsTaxExempt = false ICharge.Level2Aggregate = Level2.GetAggregate() Level3.LineItemCount = 2 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"

Error Event (Level3 Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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

Constructors

public init()

EPSpecialField Type

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

Remarks

This type contains a and 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

Constructors

public init()

public init(name: , value: )

Config Settings (Level3 Module)

Trappable Errors (Level3 Module)

Level3 Errors

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