TSYSLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TSYSLevel3

Remarks

This TSYSLevel3 class creates Level III addendum data, which can be sent in the settlement to achieve a better interchange rate when accepting corporate purchasing cards. The Level III addendum allows the merchant to send very detailed information about every item that was purchased by the card holder, as well as tax and shipping information.

This class creates a different addendum aggregate based on the CardType. Visa and MasterCard addendums differ slightly, and therefore a slightly different set of properties are required for each.

The following fields are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• Description
• DiscountAmount
• ProductCode
• Quantity
• TaxAmount
• TaxRate
• Total
• Units

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• CommodityCode
• UnitCost

Additional fields for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• DiscountRate
• TaxIncluded
• TaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType:

 
 Copy
  'First authorize the credit card
  TSYSECommerce1.TransactionAmount = "53"
  TSYSECommerce.Authorize()
  
  'Then, put the result into the settlement component
  TSYSSettle.DetailRecordCount = 1
  TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate()

  'Now build the Level3 Extension. 
  'The following properties are required for a Visa Corporate Purchasing Card:
  TSYSLevel3.CardType = tctVisa
  TSYSLevel3.LocalTax = "EXEMPT"
  TSYSLevel3.NationalTax = "0"
  TSYSLevel3.PurchaseOrder = "purchOrdNum"
  TSYSLevel3.MerchantTaxId = "merchantTaxId"   'Merchant VAT Registration Number
  TSYSLevel3.CustomerTaxId = "customerTaxId"   'Customer VAT Registration Number
  TSYSLevel3.CommodityCode = "fake"
  TSYSLevel3.DiscountAmount = "0"
  TSYSLevel3.FreightAmount = "0"
  TSYSLevel3.DutyAmount = "0"
  TSYSLevel3.DestinationZip = "27709"
  TSYSLevel3.ShipFromZip = "27709"
  TSYSLevel3.DestinationCountry = "840"
  TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo"
  TSYSLevel3.OrderDate = "060526"
  TSYSLevel3.FreightTaxAmount = "0"
  TSYSLevel3.FreightTaxRate = "0"
  
  'Begin adding line items:
  TSYSLevel3.LineItemCount = 2
  
  TSYSLevel3.LineItemCommodityCode(0) = "fake"
  TSYSLevel3.LineItemDescription(0) = "hardware"
  TSYSLevel3.LineItemProductCode(0) = "productCode123"
  TSYSLevel3.LineItemQuantity(0) = 1
  TSYSLevel3.LineItemUnits(0) = ""
  TSYSLevel3.LineItemUnitCost(0) = "33"
  TSYSLevel3.LineItemTaxAmount(0) = "0"
  TSYSLevel3.LineItemTaxRate(0) = "0"
  TSYSLevel3.LineItemDiscountAmount(0) = "0"
  TSYSLevel3.LineItemTotal(0) = "33"
  
  TSYSLevel3.LineItemCommodityCode(1) = "fake"
  TSYSLevel3.LineItemDescription(1) = "hardware"
  TSYSLevel3.LineItemProductCode(1) = "productCode124"
  TSYSLevel3.LineItemQuantity(1) = 1
  TSYSLevel3.LineItemUnits(1) = ""
  TSYSLevel3.LineItemUnitCost(1) = "20"
  TSYSLevel3.LineItemTaxAmount(1) = "0"
  TSYSLevel3.LineItemTaxRate(1) = "0"
  TSYSLevel3.LineItemDiscountAmount(1) = "0"
  TSYSLevel3.LineItemTotal(1) = "20"
  
  'Finally, add the Level3 addendum to the same index in the settlement.
  TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()

A Level III addendum for the tctMasterCard CardType is constructed similarly:

 
 Copy
  'First authorize the credit card
  TSYSECommerce1.TransactionAmount = "200"
  TSYSECommerce.Authorize()
  
  'Then, put the result into the settlement component
  TSYSSettle.DetailRecordCount = 2
  TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate()

  'Now build the Level3 Extension. 
  TSYSLevel3.cardType = tctMasterCard
  TSYSLevel3.LocalTax = "EXEMPT"
  TSYSLevel3.NationalTax = "0"
  TSYSLevel3.PurchaseOrder = "cardholderRefId"
  TSYSLevel3.FreightAmount = "0"
  TSYSLevel3.DutyAmount = "0"
  TSYSLevel3.DestinationZip = "27709"
  TSYSLevel3.ShipFromZip = "27709"
  TSYSLevel3.DestinationCountry = "USA"
  TSYSLevel3.AlternateTaxAmount = "0"
  TSYSLevel3.AlternateTaxId = "altTaxId"
  
  'Begin adding line items:
  
  TSYSLevel3.LineItemCount = 2 
  
  TSYSLevel3.LineItemDescription(0) = "bolt"
  TSYSLevel3.LineItemProductCode(0) = "BOLT6x20"
  TSYSLevel3.LineItemQuantity(0) = 2
  TSYSLevel3.LineItemUnits(0) = "each"  
  TSYSLevel3.LineItemTaxRate(0) = "0"
  TSYSLevel3.LineItemTaxType(0) = "taxType"
  TSYSLevel3.LineItemTaxAmount(0) = "0"
  TSYSLevel3.LineItemDiscountAmount(0) = "0"
  TSYSLevel3.LineItemTaxIncluded(0) = False
  TSYSLevel3.LineItemTotal(0) = "100"
  TSYSLevel3.LineItemDiscountAmount(0) = "0"
  TSYSLevel3.LineItemDiscountRate(0) = "0"
  
  TSYSLevel3.LineItemDescription(1) = "flange nut"
  TSYSLevel3.LineItemProductCode(1) = "FLANGE6"
  TSYSLevel3.LineItemQuantity(1) = 1
  TSYSLevel3.LineItemUnits(1) = "each"  
  TSYSLevel3.LineItemTaxRate(1) = "0"
  TSYSLevel3.LineItemTaxType(1) = "taxType"
  TSYSLevel3.LineItemTaxAmount(1) = "0"
  TSYSLevel3.LineItemDiscountAmount(1) = "0"
  TSYSLevel3.LineItemTaxIncluded(1) = False
  TSYSLevel3.LineItemTotal(1) = "100"
  TSYSLevel3.LineItemDiscountAmount(1) = "0"
  TSYSLevel3.LineItemDiscountRate(1) = "0"
  
  'Finally, add the Level3 addendum to the same index in the settlement.
  TSYSSettle1.DetailAddendum(1) = TSYSLevel3.GetAddendum()
  
  

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

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.

AlternateTaxAmount Property (TSYSLevel3 Class)

Secondary tax amount (only applicable in some countries).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlternateTaxAmount();
int SetAlternateTaxAmount(const char* lpszAlternateTaxAmount);

Unicode (Windows)
LPWSTR GetAlternateTaxAmount();
INT SetAlternateTaxAmount(LPCWSTR lpszAlternateTaxAmount);

char* dpaymentssdk_tsyslevel3_getalternatetaxamount(void* lpObj);
int dpaymentssdk_tsyslevel3_setalternatetaxamount(void* lpObj, const char* lpszAlternateTaxAmount);

QString GetAlternateTaxAmount();
int SetAlternateTaxAmount(QString qsAlternateTaxAmount);

Default Value

""

Remarks

This property is used to record the second tax amount in countries where more than one type of tax can be applied to purchases. This amount 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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. This property is only used for MasterCard Corporate Purchasing Cards.

Data Type

String

AlternateTaxId Property (TSYSLevel3 Class)

Tax Id number of the merchant that reported the AlternateTaxAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlternateTaxId();
int SetAlternateTaxId(const char* lpszAlternateTaxId);

Unicode (Windows)
LPWSTR GetAlternateTaxId();
INT SetAlternateTaxId(LPCWSTR lpszAlternateTaxId);

char* dpaymentssdk_tsyslevel3_getalternatetaxid(void* lpObj);
int dpaymentssdk_tsyslevel3_setalternatetaxid(void* lpObj, const char* lpszAlternateTaxId);

QString GetAlternateTaxId();
int SetAlternateTaxId(QString qsAlternateTaxId);

Default Value

""

Remarks

This property contains the tax identification number of the merchant that reported the AlternateTaxAmount This property is only used for MasterCard Corporate Purchasing Cards.

This property is not available at design time.

Data Type

String

CardType Property (TSYSLevel3 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_tsyslevel3_getcardtype(void* lpObj);
int dpaymentssdk_tsyslevel3_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

CommodityCode Property (TSYSLevel3 Class)

Code indicating the type of goods or services sold.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityCode();
int SetCommodityCode(const char* lpszCommodityCode);

Unicode (Windows)
LPWSTR GetCommodityCode();
INT SetCommodityCode(LPCWSTR lpszCommodityCode);

char* dpaymentssdk_tsyslevel3_getcommoditycode(void* lpObj);
int dpaymentssdk_tsyslevel3_setcommoditycode(void* lpObj, const char* lpszCommodityCode);

QString GetCommodityCode();
int SetCommodityCode(QString qsCommodityCode);

Default Value

""

Remarks

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 maximum length of this property is 4 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

CustomerTaxId Property (TSYSLevel3 Class)

Customer's Value Added Tax registration number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerTaxId();
int SetCustomerTaxId(const char* lpszCustomerTaxId);

Unicode (Windows)
LPWSTR GetCustomerTaxId();
INT SetCustomerTaxId(LPCWSTR lpszCustomerTaxId);

char* dpaymentssdk_tsyslevel3_getcustomertaxid(void* lpObj);
int dpaymentssdk_tsyslevel3_setcustomertaxid(void* lpObj, const char* lpszCustomerTaxId);

QString GetCustomerTaxId();
int SetCustomerTaxId(QString qsCustomerTaxId);

Default Value

""

Remarks

This property contains a Value Added Tax registration number supplied by the Commercial Card cardholder.

The maximum length of this property is 13 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

DestinationCountry Property (TSYSLevel3 Class)

Country the goods are to be shipped to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationCountry();
int SetDestinationCountry(const char* lpszDestinationCountry);

Unicode (Windows)
LPWSTR GetDestinationCountry();
INT SetDestinationCountry(LPCWSTR lpszDestinationCountry);

char* dpaymentssdk_tsyslevel3_getdestinationcountry(void* lpObj);
int dpaymentssdk_tsyslevel3_setdestinationcountry(void* lpObj, const char* lpszDestinationCountry);

QString GetDestinationCountry();
int SetDestinationCountry(QString qsDestinationCountry);

Default Value

""

Remarks

For Visa transactions, this property contains the three-digit numeric code of the country where the goods are being shipped. These codes are specified by ISO-3166. For the United States, use "840".

For MasterCard transactions, this property should contain the three-character alpha code specified by that same ISO spec. For the United States, use "USA".

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

Data Type

String

DestinationZip Property (TSYSLevel3 Class)

Zip code the goods are to be shipped to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationZip();
int SetDestinationZip(const char* lpszDestinationZip);

Unicode (Windows)
LPWSTR GetDestinationZip();
INT SetDestinationZip(LPCWSTR lpszDestinationZip);

char* dpaymentssdk_tsyslevel3_getdestinationzip(void* lpObj);
int dpaymentssdk_tsyslevel3_setdestinationzip(void* lpObj, const char* lpszDestinationZip);

QString GetDestinationZip();
int SetDestinationZip(QString qsDestinationZip);

Default Value

""

Remarks

This property contains the Postal/Zip code of the address where purchased goods will be delivered. This property can be identical to the ShipFromZip if the customer is present and takes immediate possession of the goods.

The maximum length of this property is 10 characters.

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

Data Type

String

DiscountAmount Property (TSYSLevel3 Class)

Amount of any discount subtracted from the line item totals.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscountAmount();
int SetDiscountAmount(const char* lpszDiscountAmount);

Unicode (Windows)
LPWSTR GetDiscountAmount();
INT SetDiscountAmount(LPCWSTR lpszDiscountAmount);

char* dpaymentssdk_tsyslevel3_getdiscountamount(void* lpObj);
int dpaymentssdk_tsyslevel3_setdiscountamount(void* lpObj, const char* lpszDiscountAmount);

QString GetDiscountAmount();
int SetDiscountAmount(QString qsDiscountAmount);

Default Value

""

Remarks

This property contains the amount of any discount applied by the merchant to the entire order. This field should be empty if the UnitCost for each line item reflects a discount price, or if no discount applies.

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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

DutyAmount Property (TSYSLevel3 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* dpaymentssdk_tsyslevel3_getdutyamount(void* lpObj);
int dpaymentssdk_tsyslevel3_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.

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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

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

Data Type

String

FreightAmount Property (TSYSLevel3 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* dpaymentssdk_tsyslevel3_getfreightamount(void* lpObj);
int dpaymentssdk_tsyslevel3_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.

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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

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

Data Type

String

FreightTaxAmount Property (TSYSLevel3 Class)

Portion of the FreightAmount that is tax.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightTaxAmount();
int SetFreightTaxAmount(const char* lpszFreightTaxAmount);

Unicode (Windows)
LPWSTR GetFreightTaxAmount();
INT SetFreightTaxAmount(LPCWSTR lpszFreightTaxAmount);

char* dpaymentssdk_tsyslevel3_getfreighttaxamount(void* lpObj);
int dpaymentssdk_tsyslevel3_setfreighttaxamount(void* lpObj, const char* lpszFreightTaxAmount);

QString GetFreightTaxAmount();
int SetFreightTaxAmount(QString qsFreightTaxAmount);

Default Value

""

Remarks

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the freight or shipping charges for the purchased item.

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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

FreightTaxRate Property (TSYSLevel3 Class)

Rate used to calculate the FreightTaxAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightTaxRate();
int SetFreightTaxRate(const char* lpszFreightTaxRate);

Unicode (Windows)
LPWSTR GetFreightTaxRate();
INT SetFreightTaxRate(LPCWSTR lpszFreightTaxRate);

char* dpaymentssdk_tsyslevel3_getfreighttaxrate(void* lpObj);
int dpaymentssdk_tsyslevel3_setfreighttaxrate(void* lpObj, const char* lpszFreightTaxRate);

QString GetFreightTaxRate();
int SetFreightTaxRate(QString qsFreightTaxRate);

Default Value

""

Remarks

This property contains the tax rate used to calculate the FreightTaxAmount. This field has a two-digit implied decimal position, and the maximum length is 4 digits.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

LineItems Property (TSYSLevel3 Class)

A collection of line items to be included in the Level III addendum.

Syntax

• C++
• C
• Qt

DPaymentsSDKList<DPaymentsSDKTSYSLineItem>* GetLineItems();
int SetLineItems(DPaymentsSDKList<DPaymentsSDKTSYSLineItem>* val);

int dpaymentssdk_tsyslevel3_getlineitemcount(void* lpObj);
int dpaymentssdk_tsyslevel3_setlineitemcount(void* lpObj, int iLineItemCount);

char* dpaymentssdk_tsyslevel3_getlineitemcommoditycode(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemcommoditycode(void* lpObj, int lineitemindex, const char* lpszLineItemCommodityCode);

char* dpaymentssdk_tsyslevel3_getlineitemdebitcreditindicator(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemdebitcreditindicator(void* lpObj, int lineitemindex, const char* lpszLineItemDebitCreditIndicator);

char* dpaymentssdk_tsyslevel3_getlineitemdescription(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemdescription(void* lpObj, int lineitemindex, const char* lpszLineItemDescription);

char* dpaymentssdk_tsyslevel3_getlineitemdiscountamount(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemdiscountamount(void* lpObj, int lineitemindex, const char* lpszLineItemDiscountAmount);

char* dpaymentssdk_tsyslevel3_getlineitemdiscountrate(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemdiscountrate(void* lpObj, int lineitemindex, const char* lpszLineItemDiscountRate);

char* dpaymentssdk_tsyslevel3_getlineitemproductcode(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemproductcode(void* lpObj, int lineitemindex, const char* lpszLineItemProductCode);

int dpaymentssdk_tsyslevel3_getlineitemquantity(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemquantity(void* lpObj, int lineitemindex, int iLineItemQuantity);

char* dpaymentssdk_tsyslevel3_getlineitemtaxamount(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemtaxamount(void* lpObj, int lineitemindex, const char* lpszLineItemTaxAmount);

int dpaymentssdk_tsyslevel3_getlineitemtaxincluded(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemtaxincluded(void* lpObj, int lineitemindex, int bLineItemTaxIncluded);

char* dpaymentssdk_tsyslevel3_getlineitemtaxrate(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemtaxrate(void* lpObj, int lineitemindex, const char* lpszLineItemTaxRate);

char* dpaymentssdk_tsyslevel3_getlineitemtaxtype(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemtaxtype(void* lpObj, int lineitemindex, const char* lpszLineItemTaxType);

char* dpaymentssdk_tsyslevel3_getlineitemtotal(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemtotal(void* lpObj, int lineitemindex, const char* lpszLineItemTotal);

char* dpaymentssdk_tsyslevel3_getlineitemunitcost(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemunitcost(void* lpObj, int lineitemindex, const char* lpszLineItemUnitCost);

char* dpaymentssdk_tsyslevel3_getlineitemunits(void* lpObj, int lineitemindex);
int dpaymentssdk_tsyslevel3_setlineitemunits(void* lpObj, int lineitemindex, const char* lpszLineItemUnits);

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

QString GetLineItemCommodityCode(int iLineItemIndex);
int SetLineItemCommodityCode(int iLineItemIndex, QString qsLineItemCommodityCode);

QString GetLineItemDebitCreditIndicator(int iLineItemIndex);
int SetLineItemDebitCreditIndicator(int iLineItemIndex, QString qsLineItemDebitCreditIndicator);

QString GetLineItemDescription(int iLineItemIndex);
int SetLineItemDescription(int iLineItemIndex, QString qsLineItemDescription);

QString GetLineItemDiscountAmount(int iLineItemIndex);
int SetLineItemDiscountAmount(int iLineItemIndex, QString qsLineItemDiscountAmount);

QString GetLineItemDiscountRate(int iLineItemIndex);
int SetLineItemDiscountRate(int iLineItemIndex, QString qsLineItemDiscountRate);

QString GetLineItemProductCode(int iLineItemIndex);
int SetLineItemProductCode(int iLineItemIndex, QString qsLineItemProductCode);

int GetLineItemQuantity(int iLineItemIndex);
int SetLineItemQuantity(int iLineItemIndex, int iLineItemQuantity);

QString GetLineItemTaxAmount(int iLineItemIndex);
int SetLineItemTaxAmount(int iLineItemIndex, QString qsLineItemTaxAmount);

bool GetLineItemTaxIncluded(int iLineItemIndex);
int SetLineItemTaxIncluded(int iLineItemIndex, bool bLineItemTaxIncluded);

QString GetLineItemTaxRate(int iLineItemIndex);
int SetLineItemTaxRate(int iLineItemIndex, QString qsLineItemTaxRate);

QString GetLineItemTaxType(int iLineItemIndex);
int SetLineItemTaxType(int iLineItemIndex, QString qsLineItemTaxType);

QString GetLineItemTotal(int iLineItemIndex);
int SetLineItemTotal(int iLineItemIndex, QString qsLineItemTotal);

QString GetLineItemUnitCost(int iLineItemIndex);
int SetLineItemUnitCost(int iLineItemIndex, QString qsLineItemUnitCost);

QString GetLineItemUnits(int iLineItemIndex);
int SetLineItemUnits(int iLineItemIndex, QString qsLineItemUnits);

Remarks

This property contains a collection of line items to be included in the Level III addendum.

This property is used for both Visa and MasterCard Corporate Purchasing Cards. However, the line item fields that each card supports are different.

List of valid Line Item properties for Visa:

• CommodityCode
• Description
• DiscountAmount
• ProductCode
• Quantity
• TaxAmount
• TaxRate
• Total
• UnitCost
• Units

List of valid Line Item properties for Mastercard:

• Description
• DiscountAmount
• DiscountRate
• ProductCode
• Quantity
• TaxAmount
• TaxIncluded
• TaxRate
• TaxType
• DebitCreditIndicator
• Total
• Units

An example of setting two line items for a Visa Corporate purchasing card follows:

 
 Copy
  TSYSLevel3.LineItemCount = 2
  
  TSYSLevel3.LineItemCommodityCode(0) = "fake"
  TSYSLevel3.LineItemDescription(0) = "hardware"
  TSYSLevel3.LineItemProductCode(0) = "productCode123"
  TSYSLevel3.LineItemQuantity(0) = 1
  TSYSLevel3.LineItemUnits(0) = ""
  TSYSLevel3.LineItemUnitCost(0) = "33"
  TSYSLevel3.LineItemTaxAmount(0) = "0"
  TSYSLevel3.LineItemTaxRate(0) = "0"
  TSYSLevel3.LineItemDiscountAmount(0) = "0"
  TSYSLevel3.LineItemTotal(0) = "33"
  
  TSYSLevel3.LineItemCommodityCode(1) = "fake"
  TSYSLevel3.LineItemDescription(1) = "hardware"
  TSYSLevel3.LineItemProductCode(1) = "productCode124"
  TSYSLevel3.LineItemQuantity(1) = 1
  TSYSLevel3.LineItemUnits(1) = ""
  TSYSLevel3.LineItemUnitCost(1) = "20"
  TSYSLevel3.LineItemTaxAmount(1) = "0"
  TSYSLevel3.LineItemTaxRate(1) = "0"
  TSYSLevel3.LineItemDiscountAmount(1) = "0"
  TSYSLevel3.LineItemTotal(1) = "20"

Data Type

DPaymentsSDKTSYSLineItem

LocalTax Property (TSYSLevel3 Class)

Amount of local or state taxes that are a part of this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalTax();
int SetLocalTax(const char* lpszLocalTax);

Unicode (Windows)
LPWSTR GetLocalTax();
INT SetLocalTax(LPCWSTR lpszLocalTax);

char* dpaymentssdk_tsyslevel3_getlocaltax(void* lpObj);
int dpaymentssdk_tsyslevel3_setlocaltax(void* lpObj, const char* lpszLocalTax);

QString GetLocalTax();
int SetLocalTax(QString qsLocalTax);

Default Value

""

Remarks

This property contains the sales tax associated with the purchase. If the transaction is exempt from local or state taxes, set this property to the text "EXEMPT".

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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

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

Data Type

String

MerchantTaxId Property (TSYSLevel3 Class)

Merchant's government tax Id number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTaxId();
int SetMerchantTaxId(const char* lpszMerchantTaxId);

Unicode (Windows)
LPWSTR GetMerchantTaxId();
INT SetMerchantTaxId(LPCWSTR lpszMerchantTaxId);

char* dpaymentssdk_tsyslevel3_getmerchanttaxid(void* lpObj);
int dpaymentssdk_tsyslevel3_setmerchanttaxid(void* lpObj, const char* lpszMerchantTaxId);

QString GetMerchantTaxId();
int SetMerchantTaxId(QString qsMerchantTaxId);

Default Value

""

Remarks

This property contains the government-assigned tax identification number of the merchant from whom the goods or services were purchased.

The maximum length of this field is 20 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

NationalTax Property (TSYSLevel3 Class)

Amount of federal or national taxes that are a part of this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNationalTax();
int SetNationalTax(const char* lpszNationalTax);

Unicode (Windows)
LPWSTR GetNationalTax();
INT SetNationalTax(LPCWSTR lpszNationalTax);

char* dpaymentssdk_tsyslevel3_getnationaltax(void* lpObj);
int dpaymentssdk_tsyslevel3_setnationaltax(void* lpObj, const char* lpszNationalTax);

QString GetNationalTax();
int SetNationalTax(QString qsNationalTax);

Default Value

""

Remarks

This property contains the national tax 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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

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

Data Type

String

OrderDate Property (TSYSLevel3 Class)

Date of the order in YYMMDD format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrderDate();
int SetOrderDate(const char* lpszOrderDate);

Unicode (Windows)
LPWSTR GetOrderDate();
INT SetOrderDate(LPCWSTR lpszOrderDate);

char* dpaymentssdk_tsyslevel3_getorderdate(void* lpObj);
int dpaymentssdk_tsyslevel3_setorderdate(void* lpObj, const char* lpszOrderDate);

QString GetOrderDate();
int SetOrderDate(QString qsOrderDate);

Default Value

""

Remarks

This property contains the purchase order date, and must be supplied in the YYMMDD format.

The maximum length of this field is 6 digits.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

PurchaseIdentifier Property (TSYSLevel3 Class)

Optional purchase order number assigned by the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPurchaseIdentifier();
int SetPurchaseIdentifier(const char* lpszPurchaseIdentifier);

Unicode (Windows)
LPWSTR GetPurchaseIdentifier();
INT SetPurchaseIdentifier(LPCWSTR lpszPurchaseIdentifier);

char* dpaymentssdk_tsyslevel3_getpurchaseidentifier(void* lpObj);
int dpaymentssdk_tsyslevel3_setpurchaseidentifier(void* lpObj, const char* lpszPurchaseIdentifier);

QString GetPurchaseIdentifier();
int SetPurchaseIdentifier(QString qsPurchaseIdentifier);

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and will be automatically left-justified, space-filled to 25 spaces.

This field is applicable to E-Commerce, Hotel, and Auto Rental transactions.

Note: For the Hotel IndustryType, this property will contain the Hotel Folio Number. For the Auto Rental IndustryType, it should indicate the Rental Agreement Number.

Failure to set a PurchaseIdentifier for the e-commerce IndustryType may result in a CPS downgrade when the transaction is settled. This can result in higher interchange rates.

Data Type

String

PurchaseOrder Property (TSYSLevel3 Class)

Purchase Order Number supplied by the cardholder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPurchaseOrder();
int SetPurchaseOrder(const char* lpszPurchaseOrder);

Unicode (Windows)
LPWSTR GetPurchaseOrder();
INT SetPurchaseOrder(LPCWSTR lpszPurchaseOrder);

char* dpaymentssdk_tsyslevel3_getpurchaseorder(void* lpObj);
int dpaymentssdk_tsyslevel3_setpurchaseorder(void* lpObj, const char* lpszPurchaseOrder);

QString GetPurchaseOrder();
int SetPurchaseOrder(QString qsPurchaseOrder);

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

ShipFromZip Property (TSYSLevel3 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* dpaymentssdk_tsyslevel3_getshipfromzip(void* lpObj);
int dpaymentssdk_tsyslevel3_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.

The maximum length of this property is 10 characters.

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

Data Type

String

TaxInvoiceNumber Property (TSYSLevel3 Class)

Unique Value Added Tax Invoice Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxInvoiceNumber();
int SetTaxInvoiceNumber(const char* lpszTaxInvoiceNumber);

Unicode (Windows)
LPWSTR GetTaxInvoiceNumber();
INT SetTaxInvoiceNumber(LPCWSTR lpszTaxInvoiceNumber);

char* dpaymentssdk_tsyslevel3_gettaxinvoicenumber(void* lpObj);
int dpaymentssdk_tsyslevel3_settaxinvoicenumber(void* lpObj, const char* lpszTaxInvoiceNumber);

QString GetTaxInvoiceNumber();
int SetTaxInvoiceNumber(QString qsTaxInvoiceNumber);

Default Value

""

Remarks

This property contains the invoice number that is associated with the Value Added Tax (VAT) invoice.

The maximum length of this property is 15 characters.

This property is only used for Visa Corporate Purchasing Cards.

Data Type

String

Config Method (TSYSLevel3 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_tsyslevel3_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 (TSYSLevel3 Class)

Returns a Level III Purchasing card addendum based on the specified CardType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAddendum();

Unicode (Windows)
LPWSTR GetAddendum();

char* dpaymentssdk_tsyslevel3_getaddendum(void* lpObj);

QString GetAddendum();

Remarks

The type of addendum created by this class depends upon the value of the CardType property. Different addendums are created when the CardType is set to tctVisa or tctMasterCard, and different properties are required for the two different CardTypes.

The following fields are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• Description
• DiscountAmount
• ProductCode
• Quantity
• TaxAmount
• TaxRate
• Total
• Units

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• CommodityCode
• UnitCost

Additional fields for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• DiscountRate
• TaxIncluded
• TaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType:

 
 Copy
  'First authorize the credit card
  TSYSECommerce1.TransactionAmount = "53"
  TSYSECommerce.Authorize()
  
  'Then, put the result into the settlement component
  TSYSSettle.DetailRecordCount = 1
  TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate()

  'Now build the Level3 Extension. 
  'The following properties are required for a Visa Corporate Purchasing Card:
  TSYSLevel3.CardType = tctVisa
  TSYSLevel3.LocalTax = "EXEMPT"
  TSYSLevel3.NationalTax = "0"
  TSYSLevel3.PurchaseOrder = "purchOrdNum"
  TSYSLevel3.MerchantTaxId = "merchantTaxId"   'Merchant VAT Registration Number
  TSYSLevel3.CustomerTaxId = "customerTaxId"   'Customer VAT Registration Number
  TSYSLevel3.CommodityCode = "fake"
  TSYSLevel3.DiscountAmount = "0"
  TSYSLevel3.FreightAmount = "0"
  TSYSLevel3.DutyAmount = "0"
  TSYSLevel3.DestinationZip = "27709"
  TSYSLevel3.ShipFromZip = "27709"
  TSYSLevel3.DestinationCountry = "840"
  TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo"
  TSYSLevel3.OrderDate = "060526"
  TSYSLevel3.FreightTaxAmount = "0"
  TSYSLevel3.FreightTaxRate = "0"
  
  'Begin adding line items:
  TSYSLevel3.LineItemCount = 2
  
  TSYSLevel3.LineItemCommodityCode(0) = "fake"
  TSYSLevel3.LineItemDescription(0) = "hardware"
  TSYSLevel3.LineItemProductCode(0) = "productCode123"
  TSYSLevel3.LineItemQuantity(0) = 1
  TSYSLevel3.LineItemUnits(0) = ""
  TSYSLevel3.LineItemUnitCost(0) = "33"
  TSYSLevel3.LineItemTaxAmount(0) = "0"
  TSYSLevel3.LineItemTaxRate(0) = "0"
  TSYSLevel3.LineItemDiscountAmount(0) = "0"
  TSYSLevel3.LineItemTotal(0) = "33"
  
  TSYSLevel3.LineItemCommodityCode(1) = "fake"
  TSYSLevel3.LineItemDescription(1) = "hardware"
  TSYSLevel3.LineItemProductCode(1) = "productCode124"
  TSYSLevel3.LineItemQuantity(1) = 1
  TSYSLevel3.LineItemUnits(1) = ""
  TSYSLevel3.LineItemUnitCost(1) = "20"
  TSYSLevel3.LineItemTaxAmount(1) = "0"
  TSYSLevel3.LineItemTaxRate(1) = "0"
  TSYSLevel3.LineItemDiscountAmount(1) = "0"
  TSYSLevel3.LineItemTotal(1) = "20"
  
  'Finally, add the Level3 addendum to the same index in the settlement.
  TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.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 (TSYSLevel3 Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsyslevel3_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 (TSYSLevel3 Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TSYSLEVEL3_ERROR 1

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

class TSYSLevel3ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass TSYSLevel3 and override this emitter function.
virtual int FireError(TSYSLevel3ErrorEventParams *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.

TSYSLineItem Type

Contains a single Level 3 line item.

Syntax

DPaymentsSDKTSYSLineItem (declared in dpaymentssdk.h)

Remarks

This type contains a single line item, used for Level 3 settlements. The fields contained by this type are listed below.

• CommodityCode
• DebitCreditIndicator
• Description
• DiscountAmount
• DiscountRate
• ProductCode
• Quantity
• TaxAmount
• TaxIncluded
• TaxRate
• TaxType
• Total
• UnitCost
• Units

Fields

 
 Copy
  TSYSLevel3.LineItemCount = 1
  TSYSLevel3.LineItemQuantity(0) = 3
  TSYSLevel3.LineItemUnitCost(0) = "1399"
  TSYSLevel3.LineItemUnits(0) = "each"
  TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

 
 Copy
  TSYSLevel3.LineItemCount = 1
  TSYSLevel3.LineItemQuantity(0) = 3
  TSYSLevel3.LineItemUnitCost(0) = "1399"
  TSYSLevel3.LineItemUnits(0) = "each"
  TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

 
 Copy
  TSYSLevel3.LineItemCount = 1
  TSYSLevel3.LineItemQuantity(0) = 3
  TSYSLevel3.LineItemUnitCost(0) = "1399"
  TSYSLevel3.LineItemUnits(0) = "each"
  TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

 
 Copy
  TSYSLevel3.LineItemCount = 1
  TSYSLevel3.LineItemQuantity(0) = 3
  TSYSLevel3.LineItemUnitCost(0) = "1399"
  TSYSLevel3.LineItemUnits(0) = "each"
  TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

Constructors

TSYSLineItem()

DPaymentsSDKList Type

Syntax

DPaymentsSDKList<T> (declared in dpaymentssdk.h)

Remarks

DPaymentsSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the TSYSLevel3 class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (TSYSLevel3 Class)

TSYSLevel3 Config Settings

Base Config Settings

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

TSYSLevel3 Errors