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

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.

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

Property List


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

DutyAmountDuty fees (if any) for imported goods.
FreightAmountShipping charges associated with this transaction.
PONumberPurchase order number assigned by the merchant.
ShipFromZipZip code the goods are being shipped from.
ShipToZipZip code the goods are being shipped TO.
SpecialFieldCountThe number of records in the SpecialField arrays.
SpecialFieldNameName of special configuration property to submit in this transaction.
SpecialFieldValueValue of special configuration property to submit in this transaction.
TaxAmountSales tax charged in addition to the original TransactionAmount.
TaxExemptSpecifies 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.

AddSpecialFieldAdds a special field name and the corresponding value.
ConfigSets or retrieves a configuration setting.
GetAggregateReturns 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.

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

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.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells 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

0

Remarks

This property controls the size of the following arrays:

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

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)

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:

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

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