E-Payment Integrator 2022 macOS Edition
Version 22.0 [Build 8593]

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.

GatewayQuantityCommodityCodeNameDescriptionUnitsUnitCostProductCodeDiscountAmountDiscountRateTotalTaxableTaxAmountTaxRateTaxType
gwAuthorizeNet (1)XXXXXX
gwPayFlowPro (6)XXXXXXXXXXX
gwUSAePay (7)XXXXXXXXXXXX
gwPlugNPay (8)XXXXXXXX
gwMPCS (10)XXXXXX
gwRTWare (11)XXXXXX
gwECX (12)XXXXXX
gwBankOfAmerica (13)XXXXXXXXXXX
gw3DSI (18)XXXXXX
gwTrustCommerce (19)XXXXXXXX
gwPSIGate (20)XXXX
gwPayFuse (21)XXXXXXXXXXXXXX
gwOrbital (23)XXXXXXXXXXXXX
gwLinkPoint (24)XXXX
gwMoneris (25)XXXX
gwNetworkMerchants (28)XXXXXXXXXXXX
gwIngenico (29)XXXXXXX
gwFirstData (33)XXXX
gwYourPay (34)XXXX
gwCyberSource (37)XXXXXXXXXXX
gwGoEMerchant (39)XXXX
gwChase (41)XXXX
gwSterling (45)XXXXXXXXXXXX
gwMonerisUSA (52)XXXX
gwBambora (53)XXXX
gwVerifi (54)XXXXXXXXXXXX
gwLitle (63)XXXXXXXX
gwHSBC (66)XXXXXXXXXXXXXX
gwBluePay (67)XXXXXXXXXX
gwBarclay (69)XXXXXXX
gwPayTrace (70)XXXXXXXXXXX
gwTransNationalBankcard (74)XXXXXXXXXXXX
gwDataCash (77)XXXXXXXXX
gwFirstDataE4 (80)XXXXXXXXXXX
gwPayscape (83)XXXXXXXXXXXX
gwAuthorizeNetCIM (85)XXXXXX
gw5thDimension (86)XXXX
gwPaymentWorkSuite (88)XXXXXXXXX
gwPSIGateXML (89)XXXX
gwPayeezy (94)XXXXXXXXXXX
gwAmericanPaymentSolutions (105)XXXXXXXXXXXX

Property List


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

LineItemsA collection of line items to be included in the Level 3 addendum.
SpecialFieldsA list of additional fields to send in the request.

Method List


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

AddSpecialFieldAdds a special field name and the corresponding value.
ConfigSets or retrieves a configuration setting.
GetAggregateReturns an aggregate containing level 3 details for a transaction.

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.

ErrorInformation about errors during data delivery.

Config Settings


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

EscapeXMLAutomatically escape the data in the aggregate.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

LineItems Property (Level3 Module)

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

Syntax

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

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

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

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

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

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

commodityCode
String

Code indicating the type of goods or services sold.

This property 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 property contains an alphanumeric description of the item(s) being supplied.

discountAmount
String

Amount of the discount for each line item (if any).

This property contains the amount of any discount applied by the merchant to this line item. This property should be empty (or zero) if the reflects a discount price or if no line item discount applies.

discountRate
String

Rate of the discount for each line item (if any).

This property contains the discount percentage applied by the merchant to this line item. This property should be empty (or zero) if the reflects a discount price or if no line item discount applies.

name
String

Name of the item.

This property contains the name of the item(s) being supplied.

productCode
String

Product code of the item purchased.

This property 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
Int32

Quantity of items in this Line Item.

This property contains the quantity of items being purchased, in whole numbers.

For Orbital Gateway this property must include 4 decimals without the decimal separator. For example for 1 quantity this property must be set to 10000.

taxable
Bool

Specifies whether the items in this Line Item are taxable.

This property identifies whether this line item is taxable.

taxAmount
String

Tax on this individual item.

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

This property contains the tax rate used to calculate the .

taxType
String

Type of tax charged in .

This property designates the type of value-added taxes (VAT) that are being charged in

total
String

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as multiplied by , with any and taken into account.

unitCost
String

Cost of each individual item.

This property contains the cost of each item in this Line Item.

units
String

Unit of measure for this Line Item.

This property contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the is calculated. If you're selling rope by the foot, the might be "feet". If you're selling chemicals, it might be by the "ounce".

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

name
String

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

This property 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 and properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

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

Constructors

public init()
public init(name: , value: )

Config Settings (Level3 Module)

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.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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 to mask sensitive data. The default is .

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.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (Level3 Module)

Level3 Errors

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

Copyright (c) 2023 4D Payments Inc.
E-Payment Integrator 2022 macOS Edition - Version 22.0 [Build 8593]