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

Level2

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.

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.

DutyAmount Property (Level2 Class)

Duty fees (if any) for imported goods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutyAmount();
int SetDutyAmount(const char* lpszDutyAmount);

Unicode (Windows)
LPWSTR GetDutyAmount();
INT SetDutyAmount(LPCWSTR lpszDutyAmount);

char* inpay_level2_getdutyamount(void* lpObj);
int inpay_level2_setdutyamount(void* lpObj, const char* lpszDutyAmount);

QString GetDutyAmount();
int SetDutyAmount(QString qsDutyAmount);

Default Value

""

Remarks

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

Data Type

String

FreightAmount Property (Level2 Class)

Shipping charges associated with this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightAmount();
int SetFreightAmount(const char* lpszFreightAmount);

Unicode (Windows)
LPWSTR GetFreightAmount();
INT SetFreightAmount(LPCWSTR lpszFreightAmount);

char* inpay_level2_getfreightamount(void* lpObj);
int inpay_level2_setfreightamount(void* lpObj, const char* lpszFreightAmount);

QString GetFreightAmount();
int SetFreightAmount(QString qsFreightAmount);

Default Value

""

Remarks

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

Data Type

String

PONumber Property (Level2 Class)

Purchase order number assigned by the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPONumber();
int SetPONumber(const char* lpszPONumber);

Unicode (Windows)
LPWSTR GetPONumber();
INT SetPONumber(LPCWSTR lpszPONumber);

char* inpay_level2_getponumber(void* lpObj);
int inpay_level2_setponumber(void* lpObj, const char* lpszPONumber);

QString GetPONumber();
int SetPONumber(QString qsPONumber);

Default Value

""

Remarks

This property is used by the merchant to specify a purchase order number for the transaction.

Data Type

String

ShipFromZip Property (Level2 Class)

Zip code the goods are being shipped from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipFromZip();
int SetShipFromZip(const char* lpszShipFromZip);

Unicode (Windows)
LPWSTR GetShipFromZip();
INT SetShipFromZip(LPCWSTR lpszShipFromZip);

char* inpay_level2_getshipfromzip(void* lpObj);
int inpay_level2_setshipfromzip(void* lpObj, const char* lpszShipFromZip);

QString GetShipFromZip();
int SetShipFromZip(QString qsShipFromZip);

Default Value

""

Remarks

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

Data Type

String

ShipToZip Property (Level2 Class)

Zip code the goods are being shipped TO.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipToZip();
int SetShipToZip(const char* lpszShipToZip);

Unicode (Windows)
LPWSTR GetShipToZip();
INT SetShipToZip(LPCWSTR lpszShipToZip);

char* inpay_level2_getshiptozip(void* lpObj);
int inpay_level2_setshiptozip(void* lpObj, const char* lpszShipToZip);

QString GetShipToZip();
int SetShipToZip(QString qsShipToZip);

Default Value

""

Remarks

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

Data Type

String

SpecialFieldCount Property (Level2 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_level2_getspecialfieldcount(void* lpObj);
int inpay_level2_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 (Level2 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_level2_getspecialfieldname(void* lpObj, int fieldindex);
int inpay_level2_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 (Level2 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_level2_getspecialfieldvalue(void* lpObj, int fieldindex);
int inpay_level2_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

TaxAmount Property (Level2 Class)

Sales tax charged in addition to the original TransactionAmount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxAmount();
int SetTaxAmount(const char* lpszTaxAmount);

Unicode (Windows)
LPWSTR GetTaxAmount();
INT SetTaxAmount(LPCWSTR lpszTaxAmount);

char* inpay_level2_gettaxamount(void* lpObj);
int inpay_level2_settaxamount(void* lpObj, const char* lpszTaxAmount);

QString GetTaxAmount();
int SetTaxAmount(QString qsTaxAmount);

Default Value

""

Remarks

This property contains the amount of state or provincial (or VAT) tax included in the transaction amount.

Data Type

String

TaxExempt Property (Level2 Class)

Specifies the tax exempt status of the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTaxExempt();
int SetTaxExempt(int iTaxExempt);

Unicode (Windows)
INT GetTaxExempt();
INT SetTaxExempt(INT iTaxExempt);

TE_NOT_PROVIDED(0), 
TE_TRUE(1), 
TE_FALSE(2)

int inpay_level2_gettaxexempt(void* lpObj);
int inpay_level2_settaxexempt(void* lpObj, int iTaxExempt);

int GetTaxExempt();
int SetTaxExempt(int iTaxExempt);

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)

Data Type

Integer

AddSpecialField Method (Level2 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_level2_addspecialfield(void* lpObj, const char* lpszName, const char* lpszValue);

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

Remarks

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 (Level2 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_level2_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 (Level2 Class)

Returns an aggregate containing level 2 details for a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAggregate();

Unicode (Windows)
LPWSTR GetAggregate();

char* inpay_level2_getaggregate(void* lpObj);

QString GetAggregate();

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

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

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_LEVEL2_ERROR 1

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

class Level2ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass Level2 and override this emitter function.
virtual int FireError(Level2ErrorEventParams *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 (Level2 Class)

Trappable Errors (Level2 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.

Level2 Errors

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