Level3 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

Gateway

Quantity

CommodityCode

Name

Description

Units

UnitCost

ProductCode

DiscountAmount

DiscountRate

Total

Taxable

TaxAmount

TaxRate

TaxType

gwAuthorizeNet (1)

X

X

X

X

X

X

gwPayFlowPro (6)

X

X

X

X

X

X

X

X

X

X

X

gwUSAePay (7)

X

X

X

X

X

X

X

X

X

X

X

X

gwPlugNPay (8)

X

X

X

X

X

X

X

X

gwMPCS (10)

X

X

X

X

X

X

gwRTWare (11)

X

X

X

X

X

X

gwECX (12)

X

X

X

X

X

X

gwBankOfAmerica (13)

X

X

X

X

X

X

X

X

X

X

X

gw3DSI (18)

X

X

X

X

X

X

gwTrustCommerce (19)

X

X

X

X

X

X

X

X

gwPSIGate (20)

X

X

X

X

gwPayFuse (21)

X

X

X

X

X

X

X

X

X

X

X

X

X

X

gwOrbital (23)

X

X

X

X

X

X

X

X

X

X

X

X

X

gwLinkPoint (24)

X

X

X

X

gwMoneris (25)

X

X

X

X

gwNetworkMerchants (28)

X

X

X

X

X

X

X

X

X

X

X

X

gwIngenico (29)

X

X

X

X

X

X

X

gwFirstData (33)

X

X

X

X

gwYourPay (34)

X

X

X

X

gwCyberSource (37)

X

X

X

X

X

X

X

X

X

X

X

gwGoEMerchant (39)

X

X

X

X

gwChase (41)

X

X

X

X

gwSterling (45)

X

X

X

X

X

X

X

X

X

X

X

X

gwMonerisUSA (52)

X

X

X

X

gwBambora (53)

X

X

X

X

gwVerifi (54)

X

X

X

X

X

X

X

X

X

X

X

X

gwLitle (63)

X

X

X

X

X

X

X

X

gwHSBC (66)

X

X

X

X

X

X

X

X

X

X

X

X

X

X

gwBluePay (67)

X

X

X

X

X

X

X

X

X

X

gwBarclay (69)

X

X

X

X

X

X

X

gwPayTrace (70)

X

X

X

X

X

X

X

X

X

X

X

gwTransNationalBankcard (74)

X

X

X

X

X

X

X

X

X

X

X

X

gwDataCash (77)

X

X

X

X

X

X

X

X

X

gwFirstDataE4 (80)

X

X

X

X

X

X

X

X

X

X

X

gwPayscape (83)

X

X

X

X

X

X

X

X

X

X

X

X

gwAuthorizeNetCIM (85)

X

X

X

X

X

X

gw5thDimension (86)

X

X

X

X

gwPaymentWorkSuite (88)

X

X

X

X

X

X

X

X

X

gwPSIGateXML (89)

X

X

X

X

gwPayeezy (94)

X

X

X

X

X

X

X

X

X

X

X

gwAmericanPaymentSolutions (105)

X

X

X

X

X

X

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.

line_item_count	The number of records in the Item arrays.
item_commodity_code	Code indicating the type of goods or services sold.
item_description	Description of the item.
item_discount_amount	Amount of the discount for each line item (if any).
item_discount_rate	Rate of the discount for each line item (if any).
item_name	Name of the item.
item_product_code	Product code of the item purchased.
item_quantity	Quantity of items in this Line Item.
item_taxable	Specifies whether the items in this Line Item are taxable.
item_tax_amount	Tax on this individual item.
item_tax_rate	Tax rate used to calculate the TaxAmount .
item_tax_type	Type of tax charged in TaxAmount .
item_total	Total cost of this line item.
item_unit_cost	Cost of each individual item.
item_units	Unit of measure for this Line Item.
special_field_count	The number of records in the SpecialField arrays.
special_field_name	Name of special configuration property to submit in this transaction.
special_field_value	Value of special configuration property to submit in this 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.

add_special_field	Adds a special field name and the corresponding value.
config	Sets or retrieves a configuration setting.
get_aggregate	Returns an aggregate containing level 3 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.

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

line_item_count Property

The number of records in the Item arrays.

Syntax

def get_line_item_count() -> int: ...
def set_line_item_count(value: int) -> None: ...

line_item_count = property(get_line_item_count, set_line_item_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• item_commodity_code
• item_description
• item_discount_amount
• item_discount_rate
• item_name
• item_product_code
• item_quantity
• item_taxable
• item_tax_amount
• item_tax_rate
• item_tax_type
• item_total
• item_unit_cost
• item_units

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

item_commodity_code Property

Code indicating the type of goods or services sold.

Syntax

def get_item_commodity_code(item_index: int) -> str: ...
def set_item_commodity_code(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

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.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_description Property

Description of the item.

Syntax

def get_item_description(item_index: int) -> str: ...
def set_item_description(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Description of the item.

This property contains an alphanumeric description of the item(s) being supplied.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_discount_amount Property

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

Syntax

def get_item_discount_amount(item_index: int) -> str: ...
def set_item_discount_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

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 item_unit_cost reflects a discount price or if no line item discount applies.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_discount_rate Property

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

Syntax

def get_item_discount_rate(item_index: int) -> str: ...
def set_item_discount_rate(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

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 item_unit_cost reflects a discount price or if no line item discount applies.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_name Property

Name of the item.

Syntax

def get_item_name(item_index: int) -> str: ...
def set_item_name(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Name of the item.

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

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_product_code Property

Product code of the item purchased.

Syntax

def get_item_product_code(item_index: int) -> str: ...
def set_item_product_code(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

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.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_quantity Property

Quantity of items in this Line Item.

Syntax

def get_item_quantity(item_index: int) -> int: ...
def set_item_quantity(item_index: int, value: int) -> None: ...

Default Value

0

Remarks

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.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_taxable Property

Specifies whether the items in this Line Item are taxable.

Syntax

def get_item_taxable(item_index: int) -> bool: ...
def set_item_taxable(item_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Specifies whether the items in this Line Item are taxable.

This property identifies whether this line item is taxable.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_amount Property

Tax on this individual item.

Syntax

def get_item_tax_amount(item_index: int) -> str: ...
def set_item_tax_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tax on this individual item.

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the purchased item.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_rate Property

Tax rate used to calculate the TaxAmount .

Syntax

def get_item_tax_rate(item_index: int) -> str: ...
def set_item_tax_rate(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tax rate used to calculate the item_tax_amount.

This property contains the tax rate used to calculate the item_tax_amount.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_type Property

Type of tax charged in TaxAmount .

Syntax

def get_item_tax_type(item_index: int) -> str: ...
def set_item_tax_type(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Type of tax charged in item_tax_amount.

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

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_total Property

Total cost of this line item.

Syntax

def get_item_total(item_index: int) -> str: ...
def set_item_total(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Total cost of this line item.

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

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_unit_cost Property

Cost of each individual item.

Syntax

def get_item_unit_cost(item_index: int) -> str: ...
def set_item_unit_cost(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Cost of each individual item.

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

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_units Property

Unit of measure for this Line Item.

Syntax

def get_item_units(item_index: int) -> str: ...
def set_item_units(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

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 item_unit_cost is calculated. If you're selling rope by the foot, the item_units might be "feet". If you're selling chemicals, it might be by the "ounce".

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

special_field_count Property

The number of records in the SpecialField arrays.

Syntax

def get_special_field_count() -> int: ...
def set_special_field_count(value: int) -> None: ...

special_field_count = property(get_special_field_count, set_special_field_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• special_field_name
• special_field_value

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

special_field_name Property

Name of special configuration property to submit in this transaction.

Syntax

def get_special_field_name(field_index: int) -> str: ...
def set_special_field_name(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

Name of special configuration field to submit in this transaction. The special_field_name and special_field_value 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 field_index parameter specifies the index of the item in the array. The size of the array is controlled by the special_field_count property.

special_field_value Property

Value of special configuration property to submit in this transaction.

Syntax

def get_special_field_value(field_index: int) -> str: ...
def set_special_field_value(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

Value of special configuration field to submit in this transaction. The special_field_name and special_field_value 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 field_index parameter specifies the index of the item in the array. The size of the array is controlled by the special_field_count property.

add_special_field Method

Adds a special field name and the corresponding value.

Syntax

def add_special_field(name: str, value: str) -> None: ...

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 line_items. 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 line_items 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 special_field_name and special_field_value properties for more information on form variables and how they are managed.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

get_aggregate Method

Returns an aggregate containing level 3 details for a transaction.

Syntax

def get_aggregate() -> str: ...

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"

on_error Event

Information about errors during data delivery.

Syntax

class Level3ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Level3:
@property
def on_error() -> Callable[[Level3ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Level3ErrorEventParams], None]) -> None: ...

Remarks

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

Level3 Config Settings

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

Level3 Errors

Level3 Errors

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