TSYSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSLevel2 class is a tool used to create Level2 Corporate Purchasing Card addendum aggregates, which can then be passed to the TSYSSETTLE class and settled.

Syntax

TSYSLevel2

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax, and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.GetAddendum();

Note that while Level2 addendum data is only applicable to corporate purchasing cards, you may send Level2 data for all Visa, Master Card, and American Express cards if you wish.

Note: If you are attempting to settle American Express transactions which include Level2 commercial card data, and you receive an error indicating that the "Record Type is missing or invalid" for the Detail Record containing that transaction, the problem is that your merchant account is not set up to settle American Express commercial cards.

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.

AmexCardholderReference Property (TSYSLevel2 Class)

Reference number supplied by the card holder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmexCardholderReference();
int SetAmexCardholderReference(const char* lpszAmexCardholderReference);

Unicode (Windows)
LPWSTR GetAmexCardholderReference();
INT SetAmexCardholderReference(LPCWSTR lpszAmexCardholderReference);

char* dpaymentssdk_tsyslevel2_getamexcardholderreference(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexcardholderreference(void* lpObj, const char* lpszAmexCardholderReference);

QString GetAmexCardholderReference();
int SetAmexCardholderReference(QString qsAmexCardholderReference);

Default Value

""

Remarks

This property is defined by the card member and entered by the merchant at the point-of-sale. This information will be displayed within the Statement/Reporting process and may include accounting information specific to the client.

The maximum length for this property is 17 characters.

Data Type

String

AmexChargeDescriptor Property (TSYSLevel2 Class)

Description of this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmexChargeDescriptor();
int SetAmexChargeDescriptor(const char* lpszAmexChargeDescriptor);

Unicode (Windows)
LPWSTR GetAmexChargeDescriptor();
INT SetAmexChargeDescriptor(LPCWSTR lpszAmexChargeDescriptor);

char* dpaymentssdk_tsyslevel2_getamexchargedescriptor(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexchargedescriptor(void* lpObj, const char* lpszAmexChargeDescriptor);

QString GetAmexChargeDescriptor();
int SetAmexChargeDescriptor(QString qsAmexChargeDescriptor);

Default Value

""

Remarks

This property may contain up to 40 characters of free text (Spaces allowed). This is a required property for an American Express addendum.

Data Type

String

AmexSalesTax Property (TSYSLevel2 Class)

Portion of the transaction amount which is sales tax.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmexSalesTax();
int SetAmexSalesTax(const char* lpszAmexSalesTax);

Unicode (Windows)
LPWSTR GetAmexSalesTax();
INT SetAmexSalesTax(LPCWSTR lpszAmexSalesTax);

char* dpaymentssdk_tsyslevel2_getamexsalestax(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexsalestax(void* lpObj, const char* lpszAmexSalesTax);

QString GetAmexSalesTax();
int SetAmexSalesTax(QString qsAmexSalesTax);

Default Value

""

Remarks

The sales tax charged must be included in the TransactionAmount of the original transaction.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The maximum length of this field is 6 digits, thus the maximum AmexSalesTax is "999999", yielding a US dollar amount of $9,999.99. This field may not contain a negative number.

Data Type

String

AmexShippedToZip Property (TSYSLevel2 Class)

The zip code to which the commodity was shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmexShippedToZip();
int SetAmexShippedToZip(const char* lpszAmexShippedToZip);

Unicode (Windows)
LPWSTR GetAmexShippedToZip();
INT SetAmexShippedToZip(LPCWSTR lpszAmexShippedToZip);

char* dpaymentssdk_tsyslevel2_getamexshippedtozip(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexshippedtozip(void* lpObj, const char* lpszAmexShippedToZip);

QString GetAmexShippedToZip();
int SetAmexShippedToZip(QString qsAmexShippedToZip);

Default Value

""

Remarks

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place.

The maximum length for this property is 6 characters.

Data Type

String

AmexSupplierNumber Property (TSYSLevel2 Class)

Supplier Reference Number contained in the American Express Level 2 addendum.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmexSupplierNumber();
int SetAmexSupplierNumber(const char* lpszAmexSupplierNumber);

Unicode (Windows)
LPWSTR GetAmexSupplierNumber();
INT SetAmexSupplierNumber(LPCWSTR lpszAmexSupplierNumber);

char* dpaymentssdk_tsyslevel2_getamexsuppliernumber(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexsuppliernumber(void* lpObj, const char* lpszAmexSupplierNumber);

QString GetAmexSupplierNumber();
int SetAmexSupplierNumber(QString qsAmexSupplierNumber);

Default Value

""

Remarks

This property contains a reference number that is used by American Express to obtain supporting information on a charge from a Merchant. Supporting documentation should be readily available in case of inquiry. The number can be any combination of characters and numerals defined by the Merchant or Authorized Processor. However, it must be an index to the Merchant's record, so that charge information can be readily retrieved and promptly submitted within 10 calendar days (or within the period stipulated in the contractual agreement). This number appears on the card member descriptive billing and Merchant inquiry reports.

The maximum length for this property is 9 characters.

Data Type

String

CardType Property (TSYSLevel2 Class)

The card type for which a Level2 or Level3 addendum will be created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardType();
int SetCardType(int iCardType);

Unicode (Windows)
INT GetCardType();
INT SetCardType(INT iCardType);

TCT_VISA(0), 
TCT_MASTER_CARD(1), 
TCT_AMERICAN_EXPRESS(2)

int dpaymentssdk_tsyslevel2_getcardtype(void* lpObj);
int dpaymentssdk_tsyslevel2_setcardtype(void* lpObj, int iCardType);

int GetCardType();
int SetCardType(int iCardType);

Default Value

0

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

Data Type

Integer

IsTaxExempt Property (TSYSLevel2 Class)

Indicates whether this purchasing card qualifies for tax-exempt status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsTaxExempt();
int SetIsTaxExempt(int bIsTaxExempt);

Unicode (Windows)
BOOL GetIsTaxExempt();
INT SetIsTaxExempt(BOOL bIsTaxExempt);

int dpaymentssdk_tsyslevel2_getistaxexempt(void* lpObj);
int dpaymentssdk_tsyslevel2_setistaxexempt(void* lpObj, int bIsTaxExempt);

bool GetIsTaxExempt();
int SetIsTaxExempt(bool bIsTaxExempt);

Default Value

FALSE

Remarks

This property cannot be True if there is a LocalTax amount set.

Data Type

Boolean

LocalSalesTax Property (TSYSLevel2 Class)

Sales tax charged in addition to the original TransactionAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalSalesTax();
int SetLocalSalesTax(const char* lpszLocalSalesTax);

Unicode (Windows)
LPWSTR GetLocalSalesTax();
INT SetLocalSalesTax(LPCWSTR lpszLocalSalesTax);

char* dpaymentssdk_tsyslevel2_getlocalsalestax(void* lpObj);
int dpaymentssdk_tsyslevel2_setlocalsalestax(void* lpObj, const char* lpszLocalSalesTax);

QString GetLocalSalesTax();
int SetLocalSalesTax(QString qsLocalSalesTax);

Default Value

""

Remarks

Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The maximum length of this property is 12 digits.

Data Type

String

PurchaseOrderNumber Property (TSYSLevel2 Class)

Optional customer-specified purchase order number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPurchaseOrderNumber();
int SetPurchaseOrderNumber(const char* lpszPurchaseOrderNumber);

Unicode (Windows)
LPWSTR GetPurchaseOrderNumber();
INT SetPurchaseOrderNumber(LPCWSTR lpszPurchaseOrderNumber);

char* dpaymentssdk_tsyslevel2_getpurchaseordernumber(void* lpObj);
int dpaymentssdk_tsyslevel2_setpurchaseordernumber(void* lpObj, const char* lpszPurchaseOrderNumber);

QString GetPurchaseOrderNumber();
int SetPurchaseOrderNumber(QString qsPurchaseOrderNumber);

Default Value

""

Remarks

This property contains a 16, 17, or 25-character Purchase Order Number or Customer Reference Identifier supplied by the Visa or MasterCard Purchasing Card cardholder.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

Config Method (TSYSLevel2 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* dpaymentssdk_tsyslevel2_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.

GetAddendum Method (TSYSLevel2 Class)

Returns a Level2 Purchasing card addendum based on the specified CardType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAddendum();

Unicode (Windows)
LPWSTR GetAddendum();

char* dpaymentssdk_tsyslevel2_getaddendum(void* lpObj);

QString GetAddendum();

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax, and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.GetAddendum();

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.

Reset Method (TSYSLevel2 Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsyslevel2_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

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

Error Event (TSYSLevel2 Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TSYSLEVEL2_ERROR 1

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

class TSYSLevel2ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Base Config Settings

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

TSYSLevel2 Errors