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

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.

Property List

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

Method List

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

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

LineItemCount Property (Level3 Class)

The number of records in the Item arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLineItemCount();
int SetLineItemCount(int iLineItemCount);

Unicode (Windows)
INT GetLineItemCount();
INT SetLineItemCount(INT iLineItemCount);

int inpay_level3_getlineitemcount(void* lpObj);
int inpay_level3_setlineitemcount(void* lpObj, int iLineItemCount);

int GetLineItemCount();
int SetLineItemCount(int iLineItemCount);

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

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

This property is not available at design time.

Data Type

Integer

ItemCommodityCode Property (Level3 Class)

Code indicating the type of goods or services sold.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCommodityCode(int iItemIndex);
int SetItemCommodityCode(int iItemIndex, const char* lpszItemCommodityCode);

Unicode (Windows)
LPWSTR GetItemCommodityCode(INT iItemIndex);
INT SetItemCommodityCode(INT iItemIndex, LPCWSTR lpszItemCommodityCode);

char* inpay_level3_getitemcommoditycode(void* lpObj, int itemindex);
int inpay_level3_setitemcommoditycode(void* lpObj, int itemindex, const char* lpszItemCommodityCode);

QString GetItemCommodityCode(int iItemIndex);
int SetItemCommodityCode(int iItemIndex, QString qsItemCommodityCode);

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 Class)

Description of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, const char* lpszItemDescription);

Unicode (Windows)
LPWSTR GetItemDescription(INT iItemIndex);
INT SetItemDescription(INT iItemIndex, LPCWSTR lpszItemDescription);

char* inpay_level3_getitemdescription(void* lpObj, int itemindex);
int inpay_level3_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDiscountAmount(int iItemIndex);
int SetItemDiscountAmount(int iItemIndex, const char* lpszItemDiscountAmount);

Unicode (Windows)
LPWSTR GetItemDiscountAmount(INT iItemIndex);
INT SetItemDiscountAmount(INT iItemIndex, LPCWSTR lpszItemDiscountAmount);

char* inpay_level3_getitemdiscountamount(void* lpObj, int itemindex);
int inpay_level3_setitemdiscountamount(void* lpObj, int itemindex, const char* lpszItemDiscountAmount);

QString GetItemDiscountAmount(int iItemIndex);
int SetItemDiscountAmount(int iItemIndex, QString qsItemDiscountAmount);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDiscountRate(int iItemIndex);
int SetItemDiscountRate(int iItemIndex, const char* lpszItemDiscountRate);

Unicode (Windows)
LPWSTR GetItemDiscountRate(INT iItemIndex);
INT SetItemDiscountRate(INT iItemIndex, LPCWSTR lpszItemDiscountRate);

char* inpay_level3_getitemdiscountrate(void* lpObj, int itemindex);
int inpay_level3_setitemdiscountrate(void* lpObj, int itemindex, const char* lpszItemDiscountRate);

QString GetItemDiscountRate(int iItemIndex);
int SetItemDiscountRate(int iItemIndex, QString qsItemDiscountRate);

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 Class)

Name of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, const char* lpszItemName);

Unicode (Windows)
LPWSTR GetItemName(INT iItemIndex);
INT SetItemName(INT iItemIndex, LPCWSTR lpszItemName);

char* inpay_level3_getitemname(void* lpObj, int itemindex);
int inpay_level3_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

QString GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, QString qsItemName);

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 Class)

Product code of the item purchased.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemProductCode(int iItemIndex);
int SetItemProductCode(int iItemIndex, const char* lpszItemProductCode);

Unicode (Windows)
LPWSTR GetItemProductCode(INT iItemIndex);
INT SetItemProductCode(INT iItemIndex, LPCWSTR lpszItemProductCode);

char* inpay_level3_getitemproductcode(void* lpObj, int itemindex);
int inpay_level3_setitemproductcode(void* lpObj, int itemindex, const char* lpszItemProductCode);

QString GetItemProductCode(int iItemIndex);
int SetItemProductCode(int iItemIndex, QString qsItemProductCode);

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 Class)

Quantity of items in this Line Item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, int iItemQuantity);

Unicode (Windows)
INT GetItemQuantity(INT iItemIndex);
INT SetItemQuantity(INT iItemIndex, INT iItemQuantity);

int inpay_level3_getitemquantity(void* lpObj, int itemindex);
int inpay_level3_setitemquantity(void* lpObj, int itemindex, int iItemQuantity);

int GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, int iItemQuantity);

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 Class)

Specifies whether the items in this Line Item are taxable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemTaxable(int iItemIndex);
int SetItemTaxable(int iItemIndex, int bItemTaxable);

Unicode (Windows)
BOOL GetItemTaxable(INT iItemIndex);
INT SetItemTaxable(INT iItemIndex, BOOL bItemTaxable);

int inpay_level3_getitemtaxable(void* lpObj, int itemindex);
int inpay_level3_setitemtaxable(void* lpObj, int itemindex, int bItemTaxable);

bool GetItemTaxable(int iItemIndex);
int SetItemTaxable(int iItemIndex, bool bItemTaxable);

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 Class)

Tax on this individual item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTaxAmount(int iItemIndex);
int SetItemTaxAmount(int iItemIndex, const char* lpszItemTaxAmount);

Unicode (Windows)
LPWSTR GetItemTaxAmount(INT iItemIndex);
INT SetItemTaxAmount(INT iItemIndex, LPCWSTR lpszItemTaxAmount);

char* inpay_level3_getitemtaxamount(void* lpObj, int itemindex);
int inpay_level3_setitemtaxamount(void* lpObj, int itemindex, const char* lpszItemTaxAmount);

QString GetItemTaxAmount(int iItemIndex);
int SetItemTaxAmount(int iItemIndex, QString qsItemTaxAmount);

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 Class)

Tax rate used to calculate the TaxAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTaxRate(int iItemIndex);
int SetItemTaxRate(int iItemIndex, const char* lpszItemTaxRate);

Unicode (Windows)
LPWSTR GetItemTaxRate(INT iItemIndex);
INT SetItemTaxRate(INT iItemIndex, LPCWSTR lpszItemTaxRate);

char* inpay_level3_getitemtaxrate(void* lpObj, int itemindex);
int inpay_level3_setitemtaxrate(void* lpObj, int itemindex, const char* lpszItemTaxRate);

QString GetItemTaxRate(int iItemIndex);
int SetItemTaxRate(int iItemIndex, QString qsItemTaxRate);

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 Class)

Type of tax charged in TaxAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTaxType(int iItemIndex);
int SetItemTaxType(int iItemIndex, const char* lpszItemTaxType);

Unicode (Windows)
LPWSTR GetItemTaxType(INT iItemIndex);
INT SetItemTaxType(INT iItemIndex, LPCWSTR lpszItemTaxType);

char* inpay_level3_getitemtaxtype(void* lpObj, int itemindex);
int inpay_level3_setitemtaxtype(void* lpObj, int itemindex, const char* lpszItemTaxType);

QString GetItemTaxType(int iItemIndex);
int SetItemTaxType(int iItemIndex, QString qsItemTaxType);

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 Class)

Total cost of this line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTotal(int iItemIndex);
int SetItemTotal(int iItemIndex, const char* lpszItemTotal);

Unicode (Windows)
LPWSTR GetItemTotal(INT iItemIndex);
INT SetItemTotal(INT iItemIndex, LPCWSTR lpszItemTotal);

char* inpay_level3_getitemtotal(void* lpObj, int itemindex);
int inpay_level3_setitemtotal(void* lpObj, int itemindex, const char* lpszItemTotal);

QString GetItemTotal(int iItemIndex);
int SetItemTotal(int iItemIndex, QString qsItemTotal);

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 Class)

Cost of each individual item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemUnitCost(int iItemIndex);
int SetItemUnitCost(int iItemIndex, const char* lpszItemUnitCost);

Unicode (Windows)
LPWSTR GetItemUnitCost(INT iItemIndex);
INT SetItemUnitCost(INT iItemIndex, LPCWSTR lpszItemUnitCost);

char* inpay_level3_getitemunitcost(void* lpObj, int itemindex);
int inpay_level3_setitemunitcost(void* lpObj, int itemindex, const char* lpszItemUnitCost);

QString GetItemUnitCost(int iItemIndex);
int SetItemUnitCost(int iItemIndex, QString qsItemUnitCost);

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 Class)

Unit of measure for this Line Item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemUnits(int iItemIndex);
int SetItemUnits(int iItemIndex, const char* lpszItemUnits);

Unicode (Windows)
LPWSTR GetItemUnits(INT iItemIndex);
INT SetItemUnits(INT iItemIndex, LPCWSTR lpszItemUnits);

char* inpay_level3_getitemunits(void* lpObj, int itemindex);
int inpay_level3_setitemunits(void* lpObj, int itemindex, const char* lpszItemUnits);

QString GetItemUnits(int iItemIndex);
int SetItemUnits(int iItemIndex, QString qsItemUnits);

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 Class)

The number of records in the SpecialField arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount);

Unicode (Windows)
INT GetSpecialFieldCount();
INT SetSpecialFieldCount(INT iSpecialFieldCount);

int inpay_level3_getspecialfieldcount(void* lpObj);
int inpay_level3_setspecialfieldcount(void* lpObj, int iSpecialFieldCount);

int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• SpecialFieldName
• SpecialFieldValue

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 Class)

Name of special configuration property to submit in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, const char* lpszSpecialFieldName);

Unicode (Windows)
LPWSTR GetSpecialFieldName(INT iFieldIndex);
INT SetSpecialFieldName(INT iFieldIndex, LPCWSTR lpszSpecialFieldName);

char* inpay_level3_getspecialfieldname(void* lpObj, int fieldindex);
int inpay_level3_setspecialfieldname(void* lpObj, int fieldindex, const char* lpszSpecialFieldName);

QString GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, QString qsSpecialFieldName);

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 class 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 Class)

Value of special configuration property to submit in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, const char* lpszSpecialFieldValue);

Unicode (Windows)
LPWSTR GetSpecialFieldValue(INT iFieldIndex);
INT SetSpecialFieldValue(INT iFieldIndex, LPCWSTR lpszSpecialFieldValue);

char* inpay_level3_getspecialfieldvalue(void* lpObj, int fieldindex);
int inpay_level3_setspecialfieldvalue(void* lpObj, int fieldindex, const char* lpszSpecialFieldValue);

QString GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, QString qsSpecialFieldValue);

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 class 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 Class)

Adds a special field name and the corresponding value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddSpecialField(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddSpecialField(LPCWSTR lpszName, LPCWSTR lpszValue);

int inpay_level3_addspecialfield(void* lpObj, const char* lpszName, const char* lpszValue);

int AddSpecialField(const QString& qsName, const QString& qsValue);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Level3 Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inpay_level3_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetAggregate Method (Level3 Class)

Returns an aggregate containing level 3 details for a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAggregate();

Unicode (Windows)
LPWSTR GetAggregate();

char* inpay_level3_getaggregate(void* lpObj);

QString GetAggregate();

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"

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (Level3 Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(Level3ErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} Level3ErrorEventParams;


Unicode (Windows)
virtual INT FireError(Level3ErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} Level3ErrorEventParams;

#define EID_LEVEL3_ERROR 1

virtual INT INPAY_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class Level3ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(Level3ErrorEventParams *e);

// Or, subclass Level3 and override this emitter function.
virtual int FireError(Level3ErrorEventParams *e) {...}

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 Class)

Trappable Errors (Level3 Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Level3 Errors

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