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.
Syntax
class inpay.Level2
Remarks
The available fields for each gateway supporting Level 2 data can be found below. Note: ship_to_zip is only used for gateways that use a different parameter than the shipping_zip 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.
| duty_amount | Duty fees (if any) for imported goods. |
| freight_amount | Shipping charges associated with this transaction. |
| po_number | Purchase order number assigned by the merchant. |
| ship_from_zip | Zip code the goods are being shipped from. |
| ship_to_zip | Zip code the goods are being shipped TO. |
| 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. |
| tax_amount | Sales tax charged in addition to the original TransactionAmount. |
| tax_exempt | 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.
| 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 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.
| 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. |
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.
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.
po_number Property
Purchase order number assigned by the merchant.
Syntax
def get_po_number() -> str: ... def set_po_number(value: str) -> None: ...
po_number = property(get_po_number, set_po_number)
Default Value
""
Remarks
This property is used by the merchant to specify a purchase order number for the transaction.
ship_from_zip Property
Zip code the goods are being shipped from.
Syntax
def get_ship_from_zip() -> str: ... def set_ship_from_zip(value: str) -> None: ...
ship_from_zip = property(get_ship_from_zip, set_ship_from_zip)
Default Value
""
Remarks
This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.
ship_to_zip Property
Zip code the goods are being shipped TO.
Syntax
def get_ship_to_zip() -> str: ... def set_ship_to_zip(value: str) -> None: ...
ship_to_zip = property(get_ship_to_zip, set_ship_to_zip)
Default Value
""
Remarks
This property contains the Postal/Zip code of the address where the purchased goods are being shipped to.
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:
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.
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.
tax_exempt Property
Specifies the tax exempt status of the transaction.
Syntax
def get_tax_exempt() -> int: ... def set_tax_exempt(value: int) -> None: ...
tax_exempt = property(get_tax_exempt, set_tax_exempt)
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)
add_special_field Method
Adds a special field name and the corresponding value.
Syntax
def add_special_field(name: str, value: str) -> None: ...
Remarks
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 2 details for a transaction.
Syntax
def get_aggregate() -> str: ...
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()
on_error Event
Information about errors during data delivery.
Syntax
class Level2ErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class Level2: @property def on_error() -> Callable[[Level2ErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[Level2ErrorEventParams], 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.
Level2 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.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 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
Level2 Errors
Level2 Errors
| 501 Data field invalid length. | |
| 502 Data field invalid format. | |
| 503 Data field out of range. |