Level2 Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

DutyAmount Property (Level2 Module)

Duty fees (if any) for imported goods.

Syntax

• Swift
• Objective-C

public var dutyAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=dutyAmount,setter=setDutyAmount:) NSString* dutyAmount;

- (NSString*)dutyAmount;
- (void)setDutyAmount :(NSString*)newDutyAmount;

Default Value

""

Remarks

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

FreightAmount Property (Level2 Module)

Shipping charges associated with this transaction.

Syntax

• Swift
• Objective-C

public var freightAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=freightAmount,setter=setFreightAmount:) NSString* freightAmount;

- (NSString*)freightAmount;
- (void)setFreightAmount :(NSString*)newFreightAmount;

Default Value

""

Remarks

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

PONumber Property (Level2 Module)

Purchase order number assigned by the merchant.

Syntax

• Swift
• Objective-C

public var poNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=PONumber,setter=setPONumber:) NSString* PONumber;

- (NSString*)PONumber;
- (void)setPONumber :(NSString*)newPONumber;

Default Value

""

Remarks

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

ShipFromZip Property (Level2 Module)

Zip code the goods are being shipped from.

Syntax

• Swift
• Objective-C

public var shipFromZip: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipFromZip,setter=setShipFromZip:) NSString* shipFromZip;

- (NSString*)shipFromZip;
- (void)setShipFromZip :(NSString*)newShipFromZip;

Default Value

""

Remarks

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

ShipToZip Property (Level2 Module)

Zip code the goods are being shipped TO.

Syntax

• Swift
• Objective-C

public var shipToZip: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipToZip,setter=setShipToZip:) NSString* shipToZip;

- (NSString*)shipToZip;
- (void)setShipToZip :(NSString*)newShipToZip;

Default Value

""

Remarks

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

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

0

Remarks

This property contains a properties 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.

TaxAmount Property (Level2 Module)

Sales tax charged in addition to the original TransactionAmount.

Syntax

• Swift
• Objective-C

public var taxAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=taxAmount,setter=setTaxAmount:) NSString* taxAmount;

- (NSString*)taxAmount;
- (void)setTaxAmount :(NSString*)newTaxAmount;

Default Value

""

Remarks

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

TaxExempt Property (Level2 Module)

Specifies the tax exempt status of the transaction.

Syntax

• Swift
• Objective-C

public var taxExempt: Level2TaxExempts {
  get {...}
  set {...}
}

public enum Level2TaxExempts: Int32 {
  case teNotProvided = 0
  case teTrue = 1
  case teFalse = 2
}

@property (nonatomic,readwrite,assign,getter=taxExempt,setter=setTaxExempt:) int taxExempt;

- (int)taxExempt;
- (void)setTaxExempt :(int)newTaxExempt;

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

Please refer to the SpecialFieldsName and SpecialFieldsValue properties for more information on form variables and how they are managed.

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

Returns an aggregate containing level 2 details for a transaction.

Syntax

• Swift
• Objective-C

public func getAggregate() throws -> String

- (NSString*)getAggregate;

Remarks

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

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

• Name
• Value

Fields

Constructors

public init()

public init(name: , value: )

Config Settings (Level2 Module)

Level2 Config Settings

Base Config Settings

Trappable Errors (Level2 Module)

Level2 Errors