FDMSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSLevel2 class is a tool used to create Level2 Corporate Purchasing Card addendum aggregates, which can then be passed to the FDMSSETTLE class and settled.

Syntax

class dpaymentssdk.FDMSLevel2

Remarks

The properties required to build a Level 2 addendum depends upon the value of the card_type property. The following tables indicate which properties are valid for what card type:

American Express

Visa

MasterCard

The following example illustrates how to add Level 2 data to a transaction to be settled:

FDMSECommerce.Authorize() FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "060828" 'September 28th, 2006 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.InvoiceNumber = "CUSTCODE" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum()

Note that while Level 2 addendum data is only applicable to corporate purchasing cards, you may send Level 2 data for all Visa, Master Card, and American Express cards if you wish.

Property List

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

card_typeThe card type for which a Level 2 or Level 3 addendum will be created.
commercial_card_typeIndicates the type of commercial card being settled.
destination_countryCountry the goods are to be shipped to.
destination_stateState or province to which the goods are to be shipped.
destination_zipThe zip code to which the commodity was shipped.
discount_amountAmount of any discount subtracted from the line item totals.
duty_amountDuty fees (if any) for imported goods.
freight_amountShipping charges associated with this transaction.
freight_tax_amountPortion of the FreightAmount that is tax.
freight_tax_rateRate used to calculate the FreightTaxAmount .
invoice_numberCustomer Reference Identifier.
merchant_referenceMerchant Reference Number.
merchant_tax_idMerchant's government tax Id number.
merchant_typeMasterCard merchant classification code.
order_dateDate of the order in YYMMDD format.
purchase_identifierUsed to identify the purchase.
shipped_from_zipZip code the goods are being shipped from.
tax_amountSales tax charged in addition to the original TransactionAmount .

Method List

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

configSets or retrieves a configuration setting.
get_addendumReturns a Level 2 Purchasing card addendum based on the specified CardType .
resetClears all properties to their default values.

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_errorFired when information is available 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.

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.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

card_type Property

The card type for which a Level 2 or Level 3 addendum will be created.

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

Default Value

0

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

fctVisa (1)Creates a Group 22 addendum for Visa or MasterCards.
fctMasterCard (2)Creates a Group 22 addendum for Visa or MasterCards.
fctAmericanExpress (3)Creates a Group 21 addendum for American Express cards (NOTE: American Express is not available for Level 3).

commercial_card_type Property

Indicates the type of commercial card being settled.

Syntax

def get_commercial_card_type() -> int: ...
def set_commercial_card_type(value: int) -> None: ...

commercial_card_type = property(get_commercial_card_type, set_commercial_card_type)

Default Value

0

Remarks

Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data in the settlement when this property indicates a commercial card was used. The following table indicates the type of commercial card:

fccNotCommercial (0)Card presented for authorization is not a commercial card
fccPurchaseCard (1)Card presented for authorization is a Purchasing Card.
fccCorporateCard (2)Card presented for authorization is a Corporate Card.
fccBusinessCard (3)Card presented for authorization is a Business Card.
fccUnknown (4)Unable to obtain information from processor.

Note: Commercial card transactions settled with Level 2 or Level 3 data must include tax amounts to receive the best interchange rate.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

destination_country Property

Country the goods are to be shipped to.

Syntax

def get_destination_country() -> str: ...
def set_destination_country(value: str) -> None: ...

destination_country = property(get_destination_country, set_destination_country)

Default Value

""

Remarks

For Visa and MasterCard transactions, this property contains the three-digit numeric code of the country where the goods are being shipped. These codes are specified by ISO-3166. For the United States, use "840".

The maximum length of this property is 3 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

destination_state Property

State or province to which the goods are to be shipped.

Syntax

def get_destination_state() -> str: ...
def set_destination_state(value: str) -> None: ...

destination_state = property(get_destination_state, set_destination_state)

Default Value

""

Remarks

This property contains the State or Province where purchased goods will be delivered. The maximum length of this property is 3 characters. This property is only used for MasterCard Corporate Purchasing Cards.

destination_zip Property

The zip code to which the commodity was shipped.

Syntax

def get_destination_zip() -> str: ...
def set_destination_zip(value: str) -> None: ...

destination_zip = property(get_destination_zip, set_destination_zip)

Default Value

""

Remarks

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place. In this case, both destination_zip and shipped_from_zip should be identical.

The maximum length for this property is 10 characters.

This property is used for Visa, MasterCard, and American Express Corporate Purchasing Cards.

discount_amount Property

Amount of any discount subtracted from the line item totals.

Syntax

def get_discount_amount() -> str: ...
def set_discount_amount(value: str) -> None: ...

discount_amount = property(get_discount_amount, set_discount_amount)

Default Value

""

Remarks

This property contains the amount of any discount applied to the transaction by the merchant. This field should be empty if no line item discount applies, or if Level 3 data is attached to the transaction, and contains discount amounts for individual items on an item-by-item basis.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is only used for Visa Corporate Purchasing Cards.

duty_amount Property

Duty fees (if any) for imported goods.

Syntax

def get_duty_amount() -> str: ...
def set_duty_amount(value: str) -> None: ...

duty_amount = property(get_duty_amount, set_duty_amount)

Default Value

""

Remarks

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

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

freight_amount Property

Shipping charges associated with this transaction.

Syntax

def get_freight_amount() -> str: ...
def set_freight_amount(value: str) -> None: ...

freight_amount = property(get_freight_amount, set_freight_amount)

Default Value

""

Remarks

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

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

freight_tax_amount Property

Portion of the FreightAmount that is tax.

Syntax

def get_freight_tax_amount() -> str: ...
def set_freight_tax_amount(value: str) -> None: ...

freight_tax_amount = property(get_freight_tax_amount, set_freight_tax_amount)

Default Value

""

Remarks

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the freight or shipping charges of the overall purchase.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is only used for Visa Corporate Purchasing Cards.

freight_tax_rate Property

Rate used to calculate the FreightTaxAmount .

Syntax

def get_freight_tax_rate() -> str: ...
def set_freight_tax_rate(value: str) -> None: ...

freight_tax_rate = property(get_freight_tax_rate, set_freight_tax_rate)

Default Value

""

Remarks

This property contains the tax rate used to calculate the freight_tax_amount. This field has a two-digit implied decimal position, and the maximum length is 4 digits.

This property is only used for Visa Corporate Purchasing Cards.

invoice_number Property

Customer Reference Identifier.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

This property contains the Customer Reference Indicator, used by the customer to identify the purchase (e.g., the invoice number). The maximum length of this property is 17 characters.

This property is only used for Visa Corporate Purchasing Cards.

merchant_reference Property

Merchant Reference Number.

Syntax

def get_merchant_reference() -> str: ...
def set_merchant_reference(value: str) -> None: ...

merchant_reference = property(get_merchant_reference, set_merchant_reference)

Default Value

""

Remarks

For Master Card, this property contains the code that facilitates merchant/corporation communication and record keeping. For Visa, this property contains the invoice number associated with the VAT invoice (not applicable in the US).

The maximum length of this property is 15 characters for Visa and 17 characters for MasterCard.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

merchant_tax_id Property

Merchant's government tax Id number.

Syntax

def get_merchant_tax_id() -> str: ...
def set_merchant_tax_id(value: str) -> None: ...

merchant_tax_id = property(get_merchant_tax_id, set_merchant_tax_id)

Default Value

""

Remarks

This property contains the government-assigned tax identification number of the merchant from whom the goods or services were purchased.

The maximum length of this property is 15 characters. This property is only used for MasterCard Corporate Purchasing Cards.

merchant_type Property

MasterCard merchant classification code.

Syntax

def get_merchant_type() -> str: ...
def set_merchant_type(value: str) -> None: ...

merchant_type = property(get_merchant_type, set_merchant_type)

Default Value

"0000"

Remarks

Merchant Type is a four-position field defined by MasterCard that describes various merchant classifications. Each position in the field has a separate, special meaning for categorizing the merchant. If the data for a particular position is not available, that position must contain a blank. If it is available, it must contain one of the following business codes:

Position 1 - Business Classification

0 Unknown
1 Corporation
2 Other Business Structure (e.g., Partnership, Sole Proprietorship, Joint Venture, etc.)

Position 2 - Type of Business Owner Classification

0 Unknown
1 No Applicable Classification (not female or handicapped)
2 Female Business Owner
3 Physically Handicapped Female Business Owner
4 Physically Handicapped Business Owner

Position 3 - Minority, Small Business, Disadvantaged Certification

0 Unknown
1 Certification Not Applicable
2 SBA Certification as Small Business
3 SBA Certification as Small Disadvantaged Business
4 Other Government or Agency Recognized Certification (e.g., Minority Supplier Development Council)
5 Self-certified Small Business
6 Definition 2 and Definition 4
7 Definition 3 and Definition 4
8 Definition 4 and Definition 5

Position 4 - Racial or Ethnic Type (Unconditional Majority Owner)

0 Unknown
1 African American
2 Asian Pacific American
3 Subcontinent Asian American
4 Hispanic American
5 Native American Indian
6 Native Hawaiian
7 Native Alaskan
8 Caucasian
9 Other

The maximum length of this property is 4 characters. This property is only used for MasterCard Corporate Purchasing Cards.

order_date Property

Date of the order in YYMMDD format.

Syntax

def get_order_date() -> str: ...
def set_order_date(value: str) -> None: ...

order_date = property(get_order_date, set_order_date)

Default Value

""

Remarks

This property contains the purchase order date, and must be supplied in the YYMMDD format.

The maximum length of this field is 6 digits.

This property is only used for Visa Corporate Purchasing Cards.

purchase_identifier Property

Used to identify the purchase.

Syntax

def get_purchase_identifier() -> str: ...
def set_purchase_identifier(value: str) -> None: ...

purchase_identifier = property(get_purchase_identifier, set_purchase_identifier)

Default Value

""

Remarks

This field is required for Visa, MasterCard and Amex Level2 transactions.For Visa this field should contain a merchant assigned value to identify the purchase such as the SKU number. For MasterCard this field should contain the code that was supplied to the merchant by the cardholder. For Amex this field should contain the customer reference number. The maximum length of this property is 25 characters.

shipped_from_zip Property

Zip code the goods are being shipped from.

Syntax

def get_shipped_from_zip() -> str: ...
def set_shipped_from_zip(value: str) -> None: ...

shipped_from_zip = property(get_shipped_from_zip, set_shipped_from_zip)

Default Value

""

Remarks

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

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

tax_amount Property

Sales tax charged in addition to the original TransactionAmount .

Syntax

def get_tax_amount() -> str: ...
def set_tax_amount(value: str) -> None: ...

tax_amount = property(get_tax_amount, set_tax_amount)

Default Value

""

Remarks

This property contains the amount of state or provincial (or VAT) tax included in the transaction amount. Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is used for Visa, MasterCard, and American Express Corporate Purchasing Cards.

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

Returns a Level 2 Purchasing card addendum based on the specified CardType .

Syntax

def get_addendum() -> str: ...

Remarks

The properties required to build a Level 2 addendum depends upon the value of the card_type property. The following tables indicate which properties are valid for what card type:

American Express

Visa

MasterCard

The following example illustrates how to add Level 2 data to a transaction to be settled:

FDMSECommerce.Authorize() FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "060828" 'September 28th, 2006 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.InvoiceNumber = "CUSTCODE" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum()

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

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

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 do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   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 configuration 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.

FDMSLevel2 Errors

FDMSLevel2 Errors

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