Level2 Class

Properties Methods Events Config Settings Errors

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

Class Name

InPay_Level2

Procedural Interface

 inpay_level2_open();
 inpay_level2_close($res);
 inpay_level2_register_callback($res, $id, $function);
 inpay_level2_get_last_error($res);
 inpay_level2_get_last_error_code($res);
 inpay_level2_set($res, $id, $index, $value);
 inpay_level2_get($res, $id, $index);
 inpay_level2_do_addspecialfield($res, $name, $value);
 inpay_level2_do_config($res, $configurationstring);
 inpay_level2_do_getaggregate($res);

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.


Gateway	PONumber	TaxAmount	TaxExempt	ShipFromZip	ShipToZip	DutyAmount	FreightAmount
gwAuthorizeNet (1)	X	X	X			X	X
gwEprocessing (2)	X	X
gwNetBilling (5)	X	X					X
gwPayFlowPro (6)	X	X	X	X	X	X	X
gwUSAePay (7)	X	X	X			X	X
gwPlugNPay (8)	X	X
gwMPCS (10)	X	X	X			X	X
gwRTWare (11)	X	X	X			X	X
gwECX (12)	X	X	X			X	X
gwBankOfAmerica (13)		X		X	X	X	X
gwInnovative (14)	X	X	X		X	X	X
gwMerchantAnywhere (15)	X	X	X		X
gw3DSI (18)	X	X		X		X	X
gwTrustCommerce (19)	X	X	X			X	X
gwPSIGate (20)	X	X	X		X
gwPayFuse (21)	X	X	X			X	X
gwPayFlowLink (22)	X	X
gwOrbital (23)	X	X	X	X	X	X	X
gwLinkPoint (24)	X	X	X				X
gwFastTransact (27)	X	X					X
gwNetworkMerchants (28)	X	X		X		X	X
gwPRIGate (30)	X	X	X		X
gwMerchantPartners (31)	X	X	X
gwCyberCash (32)	X	X
gwFirstData (33)	X	X	X				X
gwYourPay (34)	X	X	X				X
gwACHPayments (35)		X
gwForte (36)		X
gwCyberSource (37)	X		X	X		X	X
gwGoEMerchant (39)		X	X
gwTransFirst (40)	X	X	X		X
gwChase (41)	X	X	X				X
gwTransactionCentral (44)	X	X	X		X
gwSterling (45)	X	X		X	X	X	X
gwPayJunction (46)		X					X
gwMyVirtualMerchant (49)		X
gwSagePayments (50)		X					X
gwMonerisUSA (52)	X	X
gwBambora (53)		X					X
gwVerifi (54)	X	X		X		X	X
gwMerchantESolutions (56)		X		X		X	X
gwPayLeap (57)	X	X
gwQBMS (61)		X
gwLitle (63)	X	X	X	X	X	X	X
gwBrainTree (64)	X	X	X
gwJetPay (65)	X	X
gwHSBC (66)	X	X	X			X	X
gwBluePay (67)	X	X
gwPayTrace (70)	X	X		X		X	X
gwTransNationalBankcard (74)	X	X		X		X	X
gwDataCash (77)		X
gwACHFederal (78)	X	X					X
gwFirstDataE4 (80)		X		X	X	X	X
gwBluefin (82)	X	X			X
gwPayscape (83)	X	X		X		X	X
gwAuthorizeNetCIM (85)	X	X	X			X	X
gw5thDimension (86)	X	X					X
gwWorldPayLink (87)	X	X	X
gwPaymentWorkSuite (88)	X	X		X		X	X
gwPSIGateXML (89)	X	X					X
gwFirstDataPayPoint (90)		X
gwConverge (93)		X
gwPayeezy (94)		X		X	X	X	X
gwAmericanPaymentSolutions (105)	X	X		X	X	X	X

Property List

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


DutyAmount	Duty fees (if any) for imported goods.
FreightAmount	Shipping charges associated with this transaction.
PONumber	Purchase order number assigned by the merchant.
ShipFromZip	Zip code the goods are being shipped from.
ShipToZip	Zip code the goods are being shipped TO.
SpecialFieldCount	The number of records in the SpecialField arrays.
SpecialFieldName	Name of special configuration property to submit in this transaction.
SpecialFieldValue	Value of special configuration property to submit in this transaction.
TaxAmount	Sales tax charged in addition to the original TransactionAmount.
TaxExempt	Specifies the tax exempt status of the transaction.

Method List

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


AddSpecialField	Adds a special field name and the corresponding value.
Config	Sets or retrieves a configuration setting.
GetAggregate	Returns an aggregate containing level 2 details for a transaction.

Event List

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


Error	Information about errors during data delivery.

Config Settings

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


EscapeXML	Automatically escape the data in the aggregate.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

DutyAmount Property (InPay_Level2 Class)

Duty fees (if any) for imported goods.

Object Oriented Interface


public function getDutyAmount();


public function setDutyAmount($value);

Procedural Interface


inpay_level2_get($res, 1 );


inpay_level2_set($res, 1, $value );

Default Value

Remarks

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

Data Type

String

FreightAmount Property (InPay_Level2 Class)

Shipping charges associated with this transaction.

Object Oriented Interface


public function getFreightAmount();


public function setFreightAmount($value);

Procedural Interface


inpay_level2_get($res, 2 );


inpay_level2_set($res, 2, $value );

Default Value

Remarks

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

Data Type

String

PONumber Property (InPay_Level2 Class)

Purchase order number assigned by the merchant.

Object Oriented Interface


public function getPONumber();


public function setPONumber($value);

Procedural Interface


inpay_level2_get($res, 3 );


inpay_level2_set($res, 3, $value );

Default Value

Remarks

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

Data Type

String

ShipFromZip Property (InPay_Level2 Class)

Zip code the goods are being shipped from.

Object Oriented Interface


public function getShipFromZip();


public function setShipFromZip($value);

Procedural Interface


inpay_level2_get($res, 4 );


inpay_level2_set($res, 4, $value );

Default Value

Remarks

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

Data Type

String

ShipToZip Property (InPay_Level2 Class)

Zip code the goods are being shipped TO.

Object Oriented Interface


public function getShipToZip();


public function setShipToZip($value);

Procedural Interface


inpay_level2_get($res, 5 );


inpay_level2_set($res, 5, $value );

Default Value

Remarks

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

Data Type

String

SpecialFieldCount Property (InPay_Level2 Class)

The number of records in the SpecialField arrays.

Object Oriented Interface


public function getSpecialFieldCount();


public function setSpecialFieldCount($value);

Procedural Interface


inpay_level2_get($res, 6 );


inpay_level2_set($res, 6, $value );

Default Value

Remarks

This property controls the size of the following arrays:

SpecialFieldName
SpecialFieldValue

The array indices start at 0 and end at SpecialFieldCount - 1.

This property is not available at design time.

Data Type

Integer

SpecialFieldName Property (InPay_Level2 Class)

Name of special configuration property to submit in this transaction.

Object Oriented Interface


public function getSpecialFieldName($fieldindex);


public function setSpecialFieldName($fieldindex, $value);

Procedural Interface


inpay_level2_get($res, 7 , $fieldindex);


inpay_level2_set($res, 7, $value , $fieldindex);

Default Value

Remarks

Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue 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.

The $fieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SpecialFieldValue Property (InPay_Level2 Class)

Value of special configuration property to submit in this transaction.

Object Oriented Interface


public function getSpecialFieldValue($fieldindex);


public function setSpecialFieldValue($fieldindex, $value);

Procedural Interface


inpay_level2_get($res, 8 , $fieldindex);


inpay_level2_set($res, 8, $value , $fieldindex);

Default Value

Remarks

Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue 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.

The $fieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

TaxAmount Property (InPay_Level2 Class)

Sales tax charged in addition to the original TransactionAmount.

Object Oriented Interface


public function getTaxAmount();


public function setTaxAmount($value);

Procedural Interface


inpay_level2_get($res, 9 );


inpay_level2_set($res, 9, $value );

Default Value

Remarks

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

Data Type

String

TaxExempt Property (InPay_Level2 Class)

Specifies the tax exempt status of the transaction.

Object Oriented Interface


public function getTaxExempt();


public function setTaxExempt($value);

Procedural Interface


inpay_level2_get($res, 10 );


inpay_level2_set($res, 10, $value );

Default Value

Remarks

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

The available values are:

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

Data Type

Integer

AddSpecialField Method (InPay_Level2 Class)

Adds a special field name and the corresponding value.

Object Oriented Interface

public function doAddSpecialField($name, $value);

Procedural Interface

inpay_level2_do_addspecialfield($res, $name, $value);

Remarks

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

Config Method (InPay_Level2 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inpay_level2_do_config($res, $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 (InPay_Level2 Class)

Returns an aggregate containing level 2 details for a transaction.

Object Oriented Interface

public function doGetAggregate();

Procedural Interface

inpay_level2_do_getaggregate($res);

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 (InPay_Level2 Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_level2_register_callback($res, 1, array($this, 'fireError'));

Parameter List

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

Config Settings (Level2 Class)

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.

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


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

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


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

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

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.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

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

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

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (Level2 Class)

Level2 Errors

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


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