Level2 Component
Properties Methods Events Config Settings Errors
The Level2 component is a tool used to create Level2 Corporate Purchasing Card aggregates, which can then be passed to the ICharge or Retail components.
Syntax
TibpLevel2
Remarks
The available fields for each gateway supporting Level 2 data can be found below. Note: ShipToZip is only used for gateways that use a different parameter than the ShippingZip property. Note: This list of fields does not designate what is required but rather only the fields made available by the gateway. For the required fields required to obtain the best rates, please consult your gateway for further information.
| Gateway | PONumber | TaxAmount | TaxExempt | ShipFromZip | ShipToZip | DutyAmount | FreightAmount |
| gwAuthorizeNet (1) | X | X | X | X | X | ||
| gwEprocessing (2) | X | X | |||||
| gwNetBilling (5) | X | X | X | ||||
| gwPayFlowPro (6) | X | X | X | X | X | X | X |
| gwUSAePay (7) | X | X | X | X | X | ||
| gwPlugNPay (8) | X | X | |||||
| gwMPCS (10) | X | X | X | X | X | ||
| gwRTWare (11) | X | X | X | X | X | ||
| gwECX (12) | X | X | X | X | X | ||
| gwBankOfAmerica (13) | X | X | X | X | X | ||
| gwInnovative (14) | X | X | X | X | X | X | |
| gwMerchantAnywhere (15) | X | X | X | X | |||
| gw3DSI (18) | X | X | X | X | X | ||
| gwTrustCommerce (19) | X | X | X | X | X | ||
| gwPSIGate (20) | X | X | X | X | |||
| gwPayFuse (21) | X | X | X | X | X | ||
| gwPayFlowLink (22) | X | X | |||||
| gwOrbital (23) | X | X | X | X | X | X | X |
| gwLinkPoint (24) | X | X | X | X | |||
| gwFastTransact (27) | X | X | X | ||||
| gwNetworkMerchants (28) | X | X | X | X | X | ||
| gwPRIGate (30) | X | X | X | X | |||
| gwMerchantPartners (31) | X | X | X | ||||
| gwCyberCash (32) | X | X | |||||
| gwFirstData (33) | X | X | X | X | |||
| gwYourPay (34) | X | X | X | X | |||
| gwACHPayments (35) | X | ||||||
| gwForte (36) | X | ||||||
| gwCyberSource (37) | X | X | X | X | X | ||
| gwGoEMerchant (39) | X | X | |||||
| gwTransFirst (40) | X | X | X | X | |||
| gwChase (41) | X | X | X | X | |||
| gwTransactionCentral (44) | X | X | X | X | |||
| gwSterling (45) | X | X | X | X | X | X | |
| gwPayJunction (46) | X | X | |||||
| gwMyVirtualMerchant (49) | X | ||||||
| gwSagePayments (50) | X | X | |||||
| gwMonerisUSA (52) | X | X | |||||
| gwBambora (53) | X | X | |||||
| gwVerifi (54) | X | X | X | X | X | ||
| gwMerchantESolutions (56) | X | X | X | X | |||
| gwPayLeap (57) | X | X | |||||
| gwQBMS (61) | X | ||||||
| gwLitle (63) | X | X | X | X | X | X | X |
| gwBrainTree (64) | X | X | X | ||||
| gwJetPay (65) | X | X | |||||
| gwHSBC (66) | X | X | X | X | X | ||
| gwBluePay (67) | X | X | |||||
| gwPayTrace (70) | X | X | X | X | X | ||
| gwTransNationalBankcard (74) | X | X | X | X | X | ||
| gwDataCash (77) | X | ||||||
| gwACHFederal (78) | X | X | X | ||||
| gwFirstDataE4 (80) | X | X | X | X | X | ||
| gwBluefin (82) | X | X | X | ||||
| gwPayscape (83) | X | X | X | X | X | ||
| gwAuthorizeNetCIM (85) | X | X | X | X | X | ||
| gw5thDimension (86) | X | X | X | ||||
| gwWorldPayLink (87) | X | X | X | ||||
| gwPaymentWorkSuite (88) | X | X | X | X | X | ||
| gwPSIGateXML (89) | X | X | X | ||||
| gwFirstDataPayPoint (90) | X | ||||||
| gwConverge (93) | X | ||||||
| gwPayeezy (94) | X | X | X | X | X | ||
| gwAmericanPaymentSolutions (105) | X | X | X | X | X | X |
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| DutyAmount | Duty fees (if any) for imported goods. |
| FreightAmount | Shipping charges associated with this transaction. |
| PONumber | Purchase order number assigned by the merchant. |
| ShipFromZip | Zip code the goods are being shipped from. |
| ShipToZip | Zip code the goods are being shipped TO. |
| SpecialFields | A list of additional fields to send in the request. |
| TaxAmount | Sales tax charged in addition to the original TransactionAmount. |
| TaxExempt | Specifies the tax exempt status of the transaction. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddSpecialField | Adds a special field name and the corresponding value. |
| Config | Sets or retrieves a configuration setting. |
| GetAggregate | Returns an aggregate containing level 2 details for a transaction. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
Config Settings
The following is a list of config settings for the component 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. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
DutyAmount Property (Level2 Component)
Duty fees (if any) for imported goods.
Syntax
property DutyAmount: String read get_DutyAmount write set_DutyAmount;
Default Value
''
Remarks
This property contains the fee amount associated with the import of the purchased goods.
FreightAmount Property (Level2 Component)
Shipping charges associated with this transaction.
Syntax
property FreightAmount: String read get_FreightAmount write set_FreightAmount;
Default Value
''
Remarks
This property contains the freight or shipping portion of the total transaction amount.
PONumber Property (Level2 Component)
Purchase order number assigned by the merchant.
Syntax
property PONumber: String read get_PONumber write set_PONumber;
Default Value
''
Remarks
This property is used by the merchant to specify a purchase order number for the transaction.
ShipFromZip Property (Level2 Component)
Zip code the goods are being shipped from.
Syntax
property ShipFromZip: String read get_ShipFromZip write set_ShipFromZip;
Default Value
''
Remarks
This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.
ShipToZip Property (Level2 Component)
Zip code the goods are being shipped TO.
Syntax
property ShipToZip: String read get_ShipToZip write set_ShipToZip;
Default Value
''
Remarks
This property contains the Postal/Zip code of the address where the purchased goods are being shipped to.
SpecialFields Property (Level2 Component)
A list of additional fields to send in the request.
Syntax
property SpecialFields: TibpEPSpecialFieldList read get_SpecialFields write set_SpecialFields;
Remarks
This property contains a properties of EPSpecialField name/value pair objects. The Gateway may put some special configuration fields into this property which you can edit or add to. This allows you to extend the functionality of the component by adding fields for which there are not currently properties for.
This property is not available at design time.
TaxAmount Property (Level2 Component)
Sales tax charged in addition to the original TransactionAmount.
Syntax
property TaxAmount: String read get_TaxAmount write set_TaxAmount;
Default Value
''
Remarks
This property contains the amount of state or provincial (or VAT) tax included in the transaction amount.
TaxExempt Property (Level2 Component)
Specifies the tax exempt status of the transaction.
Syntax
property TaxExempt: TibpTaxExemptTypes read get_TaxExempt write set_TaxExempt;
TibpTaxExemptTypes = ( teNotProvided, teTrue, teFalse );
Default Value
teNotProvided
Remarks
This property is used to specify whether the transaction is tax exempt.
The available values are:
- teNotProvided (0) (default)
- teTrue (1)
- teFalse (2)
AddSpecialField Method (Level2 Component)
Adds a special field name and the corresponding value.
Syntax
procedure AddSpecialField(Name: String; Value: String);
Remarks
Please refer to the Name and Value properties for more information on form variables and how they are managed.
Config Method (Level2 Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): String;
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (Level2 Component)
Returns an aggregate containing level 2 details for a transaction.
Syntax
function GetAggregate(): String;
Remarks
This method returns an aggregate containing the level 2 data specified. This aggregate must be passed to the ICharge component'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 (Level2 Component)
Information about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
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.
EPSpecialField Type
Additional name/value pairs which can be added to a transaction.
Remarks
This type contains a Name and Value which may contain any additional information you wish to send to your gateway that this component does not currently send. You must know the field name in the gateway integration guide available from your gateway. For instance, the code below shows how to add a customer IP Address for the Authorize.Net gateway:
ICharge1.SpecialFields.add(new EPSpecialField("x_customer_ip", "255.123.456.78"));
Fields
|
Name String |
Name of special configuration field to submit in this transaction. The Name and 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 component by submitting additional information to the gateway. This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways. |
|
Value String |
Value of special configuration field to submit in this transaction. The Name and 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 component by submitting additional information to the gateway. Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways. |
Constructors
constructor Create();
constructor Create(valName: String; valValue: String);
Config Settings (Level2 Component)
The component 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 component, 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component 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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation.
When set to False, the component will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to True tells the component to use the internal implementation instead of using the system security libraries. This setting is set to False by default on all platforms. |
Trappable Errors (Level2 Component)
Level2 Errors
| 501 Data field invalid length. | |
| 502 Data field invalid format. | |
| 503 Data field out of range. |