Level3 Component
Properties Methods Events Config Settings Errors
The Level3 component is a tool used to create Level3 Corporate Purchasing Card aggregates, which can then be passed to the ICharge or Retail components.
Syntax
TibpLevel3
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 component with short descriptions. Click on the links for further details.
LineItemCount | The number of records in the Item arrays. |
ItemCommodityCode | Code indicating the type of goods or services sold. |
ItemDescription | Description of the item. |
ItemDiscountAmount | Amount of the discount for each line item (if any). |
ItemDiscountRate | Rate of the discount for each line item (if any). |
ItemName | Name of the item. |
ItemProductCode | Product code of the item purchased. |
ItemQuantity | Quantity of items in this Line Item. |
ItemTaxable | Specifies whether the items in this Line Item are taxable. |
ItemTaxAmount | Tax on this individual item. |
ItemTaxRate | Tax rate used to calculate the TaxAmount . |
ItemTaxType | Type of tax charged in TaxAmount . |
ItemTotal | Total cost of this line item. |
ItemUnitCost | Cost of each individual item. |
ItemUnits | Unit of measure for this Line Item. |
SpecialFieldCount | The number of records in the SpecialField arrays. |
SpecialFieldName | Name of special configuration property to submit in this transaction. |
SpecialFieldValue | Value of special configuration property to submit in this 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 3 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. |
LineItemCount Property (Level3 Component)
The number of records in the Item arrays.
Syntax
__property int LineItemCount = { read=FLineItemCount, write=FSetLineItemCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- ItemCommodityCode
- ItemDescription
- ItemDiscountAmount
- ItemDiscountRate
- ItemName
- ItemProductCode
- ItemQuantity
- ItemTaxable
- ItemTaxAmount
- ItemTaxRate
- ItemTaxType
- ItemTotal
- ItemUnitCost
- ItemUnits
This property is not available at design time.
Data Type
Integer
ItemCommodityCode Property (Level3 Component)
Code indicating the type of goods or services sold.
Syntax
__property String ItemCommodityCode[int ItemIndex] = { read=FItemCommodityCode, write=FSetItemCommodityCode };
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 ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemDescription Property (Level3 Component)
Description of the item.
Syntax
__property String ItemDescription[int ItemIndex] = { read=FItemDescription, write=FSetItemDescription };
Default Value
""
Remarks
Description of the item.
This property contains an alphanumeric description of the item(s) being supplied.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemDiscountAmount Property (Level3 Component)
Amount of the discount for each line item (if any).
Syntax
__property String ItemDiscountAmount[int ItemIndex] = { read=FItemDiscountAmount, write=FSetItemDiscountAmount };
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 ItemUnitCost reflects a discount price or if no line item discount applies.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemDiscountRate Property (Level3 Component)
Rate of the discount for each line item (if any).
Syntax
__property String ItemDiscountRate[int ItemIndex] = { read=FItemDiscountRate, write=FSetItemDiscountRate };
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 ItemUnitCost reflects a discount price or if no line item discount applies.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemName Property (Level3 Component)
Name of the item.
Syntax
__property String ItemName[int ItemIndex] = { read=FItemName, write=FSetItemName };
Default Value
""
Remarks
Name of the item.
This property contains the name of the item(s) being supplied.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemProductCode Property (Level3 Component)
Product code of the item purchased.
Syntax
__property String ItemProductCode[int ItemIndex] = { read=FItemProductCode, write=FSetItemProductCode };
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 ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemQuantity Property (Level3 Component)
Quantity of items in this Line Item.
Syntax
__property int ItemQuantity[int ItemIndex] = { read=FItemQuantity, write=FSetItemQuantity };
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 ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
Integer
ItemTaxable Property (Level3 Component)
Specifies whether the items in this Line Item are taxable.
Syntax
__property bool ItemTaxable[int ItemIndex] = { read=FItemTaxable, write=FSetItemTaxable };
Default Value
false
Remarks
Specifies whether the items in this Line Item are taxable.
This property identifies whether this line item is taxable.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
Boolean
ItemTaxAmount Property (Level3 Component)
Tax on this individual item.
Syntax
__property String ItemTaxAmount[int ItemIndex] = { read=FItemTaxAmount, write=FSetItemTaxAmount };
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 ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemTaxRate Property (Level3 Component)
Tax rate used to calculate the TaxAmount .
Syntax
__property String ItemTaxRate[int ItemIndex] = { read=FItemTaxRate, write=FSetItemTaxRate };
Default Value
""
Remarks
Tax rate used to calculate the ItemTaxAmount.
This property contains the tax rate used to calculate the ItemTaxAmount.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemTaxType Property (Level3 Component)
Type of tax charged in TaxAmount .
Syntax
__property String ItemTaxType[int ItemIndex] = { read=FItemTaxType, write=FSetItemTaxType };
Default Value
""
Remarks
Type of tax charged in ItemTaxAmount.
This property designates the type of value-added taxes (VAT) that are being charged in ItemTaxAmount
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemTotal Property (Level3 Component)
Total cost of this line item.
Syntax
__property String ItemTotal[int ItemIndex] = { read=FItemTotal, write=FSetItemTotal };
Default Value
""
Remarks
Total cost of this line item.
This property contains the total amount of the individual item, typically calculated as ItemUnitCost multiplied by ItemQuantity, with any ItemTaxAmount and ItemDiscountAmount taken into account.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemUnitCost Property (Level3 Component)
Cost of each individual item.
Syntax
__property String ItemUnitCost[int ItemIndex] = { read=FItemUnitCost, write=FSetItemUnitCost };
Default Value
""
Remarks
Cost of each individual item.
This property contains the cost of each item in this Line Item.
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
ItemUnits Property (Level3 Component)
Unit of measure for this Line Item.
Syntax
__property String ItemUnits[int ItemIndex] = { read=FItemUnits, write=FSetItemUnits };
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 ItemUnitCost is calculated. If you're selling rope by the foot, the ItemUnits might be "feet". If you're selling chemicals, it might be by the "ounce".
The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.
This property is not available at design time.
Data Type
String
SpecialFieldCount Property (Level3 Component)
The number of records in the SpecialField arrays.
Syntax
__property int SpecialFieldCount = { read=FSpecialFieldCount, write=FSetSpecialFieldCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SpecialFieldCount - 1.This property is not available at design time.
Data Type
Integer
SpecialFieldName Property (Level3 Component)
Name of special configuration property to submit in this transaction.
Syntax
__property String SpecialFieldName[int FieldIndex] = { read=FSpecialFieldName, write=FSetSpecialFieldName };
Default Value
""
Remarks
Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this component by submitting additional information to the gateway.
This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.
This property is not available at design time.
Data Type
String
SpecialFieldValue Property (Level3 Component)
Value of special configuration property to submit in this transaction.
Syntax
__property String SpecialFieldValue[int FieldIndex] = { read=FSpecialFieldValue, write=FSetSpecialFieldValue };
Default Value
""
Remarks
Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this component by submitting additional information to the gateway.
Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.
This property is not available at design time.
Data Type
String
AddSpecialField Method (Level3 Component)
Adds a special field name and the corresponding value.
Syntax
void __fastcall AddSpecialField(String Name, String Value);
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 LineItems. 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 LineItems 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 SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.
Config Method (Level3 Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
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 (Level3 Component)
Returns an aggregate containing level 3 details for a transaction.
Syntax
String __fastcall GetAggregate();
Remarks
This method returns an aggregate containing the level 3 data specified. This aggregate must be passed to the ICharge component'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"
Error Event (Level3 Component)
Information about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TibpLevel3ErrorEventParams; typedef void __fastcall (__closure *TibpLevel3ErrorEvent)(System::TObject* Sender, TibpLevel3ErrorEventParams *e); __property TibpLevel3ErrorEvent OnError = { 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.
Config Settings (Level3 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.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 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 (Level3 Component)
Level3 Errors
501 Data field invalid length. | |
502 Data field invalid format. | |
503 Data field out of range. |