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.

Class Name

DPaymentsSDK_TSYSLevel3

Procedural Interface

 dpaymentssdk_tsyslevel3_open();
 dpaymentssdk_tsyslevel3_close($res);
 dpaymentssdk_tsyslevel3_register_callback($res, $id, $function);
 dpaymentssdk_tsyslevel3_get_last_error($res);
 dpaymentssdk_tsyslevel3_get_last_error_code($res);
 dpaymentssdk_tsyslevel3_set($res, $id, $index, $value);
 dpaymentssdk_tsyslevel3_get($res, $id, $index);
 dpaymentssdk_tsyslevel3_do_config($res, $configurationstring);
 dpaymentssdk_tsyslevel3_do_getaddendum($res);
 dpaymentssdk_tsyslevel3_do_reset($res);

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 properties are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• LineItemDescription
• LineItemDiscountAmount
• LineItemProductCode
• LineItemQuantity
• LineItemTaxAmount
• LineItemTaxRate
• LineItemTotal
• LineItemUnits

Additional properties for the tctVisa CardType include:

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• LineItemCommodityCode
• LineItemUnitCost

Additional properties for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• LineItemDiscountRate
• LineItemTaxIncluded
• LineItemTaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType: '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:

'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 (DPaymentsSDK_TSYSLevel3 Class)

Secondary tax amount (only applicable in some countries).

Object Oriented Interface

public function getAlternateTaxAmount();


public function setAlternateTaxAmount($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 1 );


dpaymentssdk_tsyslevel3_set($res, 1, $value );

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

Tax Id number of the merchant that reported the AlternateTaxAmount .

Object Oriented Interface

public function getAlternateTaxId();


public function setAlternateTaxId($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 2 );


dpaymentssdk_tsyslevel3_set($res, 2, $value );

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

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

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 3 );


dpaymentssdk_tsyslevel3_set($res, 3, $value );

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

Code indicating the type of goods or services sold.

Object Oriented Interface

public function getCommodityCode();


public function setCommodityCode($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 4 );


dpaymentssdk_tsyslevel3_set($res, 4, $value );

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

Customer's Value Added Tax registration number.

Object Oriented Interface

public function getCustomerTaxId();


public function setCustomerTaxId($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 5 );


dpaymentssdk_tsyslevel3_set($res, 5, $value );

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

Country the goods are to be shipped to.

Object Oriented Interface

public function getDestinationCountry();


public function setDestinationCountry($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 6 );


dpaymentssdk_tsyslevel3_set($res, 6, $value );

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

Zip code the goods are to be shipped to.

Object Oriented Interface

public function getDestinationZip();


public function setDestinationZip($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 7 );


dpaymentssdk_tsyslevel3_set($res, 7, $value );

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

Amount of any discount subtracted from the line item totals.

Object Oriented Interface

public function getDiscountAmount();


public function setDiscountAmount($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 8 );


dpaymentssdk_tsyslevel3_set($res, 8, $value );

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 LineItemUnitCost 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 (DPaymentsSDK_TSYSLevel3 Class)

Duty fees (if any) for imported goods.

Object Oriented Interface

public function getDutyAmount();


public function setDutyAmount($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 9 );


dpaymentssdk_tsyslevel3_set($res, 9, $value );

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

Shipping charges associated with this transaction.

Object Oriented Interface

public function getFreightAmount();


public function setFreightAmount($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 10 );


dpaymentssdk_tsyslevel3_set($res, 10, $value );

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

Portion of the FreightAmount that is tax.

Object Oriented Interface

public function getFreightTaxAmount();


public function setFreightTaxAmount($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 11 );


dpaymentssdk_tsyslevel3_set($res, 11, $value );

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

Rate used to calculate the FreightTaxAmount .

Object Oriented Interface

public function getFreightTaxRate();


public function setFreightTaxRate($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 12 );


dpaymentssdk_tsyslevel3_set($res, 12, $value );

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

LineItemCount Property (DPaymentsSDK_TSYSLevel3 Class)

The number of records in the LineItem arrays.

Object Oriented Interface

public function getLineItemCount();


public function setLineItemCount($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 13 );


dpaymentssdk_tsyslevel3_set($res, 13, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• LineItemCommodityCode
• LineItemDebitCreditIndicator
• LineItemDescription
• LineItemDiscountAmount
• LineItemDiscountRate
• LineItemProductCode
• LineItemQuantity
• LineItemTaxAmount
• LineItemTaxIncluded
• LineItemTaxRate
• LineItemTaxType
• LineItemTotal
• LineItemUnitCost
• LineItemUnits

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

This property is not available at design time.

Data Type

Integer

LineItemCommodityCode Property (DPaymentsSDK_TSYSLevel3 Class)

Code describing the good or service being supplied.

Object Oriented Interface

public function getLineItemCommodityCode($lineitemindex);


public function setLineItemCommodityCode($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 14 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 14, $value , $lineitemindex);

Default Value

''

Remarks

Code describing the good or service being supplied.

This property will contain an international description code of the individual good or service being supplied. The acquirer's bank will provide the merchant an updated listing of currently defined codes. It is recommended to use a National or International list of standardized codes.

The maximum length for this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is only used for Visa Corporate Purchasing Cards.

The $lineitemindex 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

LineItemDebitCreditIndicator Property (DPaymentsSDK_TSYSLevel3 Class)

Debit/Credit Indicator.

Object Oriented Interface

public function getLineItemDebitCreditIndicator($lineitemindex);


public function setLineItemDebitCreditIndicator($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 15 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 15, $value , $lineitemindex);

Default Value

'D'

Remarks

Debit/Credit Indicator.

This 1-character property represents the sign of the LineItemTotal. Possible values are:

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The $lineitemindex 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

LineItemDescription Property (DPaymentsSDK_TSYSLevel3 Class)

Description of the item.

Object Oriented Interface

public function getLineItemDescription($lineitemindex);


public function setLineItemDescription($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 16 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 16, $value , $lineitemindex);

Default Value

''

Remarks

Description of the item.

This property contains an alphanumeric description of the item(s) being supplied.

The maximum length of this property is 35 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemDiscountAmount Property (DPaymentsSDK_TSYSLevel3 Class)

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

Object Oriented Interface

public function getLineItemDiscountAmount($lineitemindex);


public function setLineItemDiscountAmount($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 17 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 17, $value , $lineitemindex);

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 LineItemUnitCost reflects a discount price or if no line item 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. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemDiscountRate Property (DPaymentsSDK_TSYSLevel3 Class)

Rate used to calculate the DiscountAmount .

Object Oriented Interface

public function getLineItemDiscountRate($lineitemindex);


public function setLineItemDiscountRate($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 18 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 18, $value , $lineitemindex);

Default Value

''

Remarks

Rate used to calculate the LineItemDiscountAmount.

This property contains the rate used to calculate the LineItemDiscountAmount. This property is a two decimal value. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The $lineitemindex 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

LineItemProductCode Property (DPaymentsSDK_TSYSLevel3 Class)

Merchant-defined product code for this Line Item.

Object Oriented Interface

public function getLineItemProductCode($lineitemindex);


public function setLineItemProductCode($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 19 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 19, $value , $lineitemindex);

Default Value

''

Remarks

Merchant-defined product code for this Line Item.

This property can contain a merchant-defined description of the individual item contained in this Line Item.

The maximum length of this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemQuantity Property (DPaymentsSDK_TSYSLevel3 Class)

Quantity of items in this Line Item.

Object Oriented Interface

public function getLineItemQuantity($lineitemindex);


public function setLineItemQuantity($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 20 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 20, $value , $lineitemindex);

Default Value

0

Remarks

Quantity of items in this Line Item.

This property contains the quantity of items being purchased, in whole numbers. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 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 All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemTaxAmount Property (DPaymentsSDK_TSYSLevel3 Class)

Tax on this individual item.

Object Oriented Interface

public function getLineItemTaxAmount($lineitemindex);


public function setLineItemTaxAmount($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 21 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 21, $value , $lineitemindex);

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.

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. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemTaxIncluded Property (DPaymentsSDK_TSYSLevel3 Class)

Net/Gross Indicator.

Object Oriented Interface

public function getLineItemTaxIncluded($lineitemindex);


public function setLineItemTaxIncluded($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 22 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 22, $value , $lineitemindex);

Default Value

false

Remarks

Net/Gross Indicator.

If this property is true, the LineItemTotal already contains the LineItemTaxAmount. If false, the LineItemTaxAmount has not yet been added to the LineItemTotal. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The $lineitemindex 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

LineItemTaxRate Property (DPaymentsSDK_TSYSLevel3 Class)

Tax rate used to calculate the TaxAmount .

Object Oriented Interface

public function getLineItemTaxRate($lineitemindex);


public function setLineItemTaxRate($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 23 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 23, $value , $lineitemindex);

Default Value

''

Remarks

Tax rate used to calculate the LineItemTaxAmount.

This property contains the tax rate used to calculate the LineItemTaxAmount. This property has a two-digit implied decimal position, and the maximum length is 4 digits. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemTaxType Property (DPaymentsSDK_TSYSLevel3 Class)

Type of tax charged in TaxAmount .

Object Oriented Interface

public function getLineItemTaxType($lineitemindex);


public function setLineItemTaxType($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 24 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 24, $value , $lineitemindex);

Default Value

''

Remarks

Type of tax charged in LineItemTaxAmount.

This 4-character property designates the type of value-added taxes that are being used.

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The $lineitemindex 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

LineItemTotal Property (DPaymentsSDK_TSYSLevel3 Class)

Total cost of this line item.

Object Oriented Interface

public function getLineItemTotal($lineitemindex);


public function setLineItemTotal($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 25 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 25, $value , $lineitemindex);

Default Value

''

Remarks

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as LineItemUnitCost multiplied by LineItemQuantity, with any LineItemTaxAmount and LineItemDiscountAmount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 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

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.

Note: This property is 12 digits in length for Visa, but only 9 for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LineItemUnitCost Property (DPaymentsSDK_TSYSLevel3 Class)

Cost of each individual item.

Object Oriented Interface

public function getLineItemUnitCost($lineitemindex);


public function setLineItemUnitCost($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 26 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 26, $value , $lineitemindex);

Default Value

''

Remarks

Cost of each individual item.

This property contains the cost of each item in this Line Item. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 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

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. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is only used for Visa Corporate Purchasing Cards.

The $lineitemindex 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

LineItemUnits Property (DPaymentsSDK_TSYSLevel3 Class)

Unit of measure for this Line Item.

Object Oriented Interface

public function getLineItemUnits($lineitemindex);


public function setLineItemUnits($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 27 , $lineitemindex);


dpaymentssdk_tsyslevel3_set($res, 27, $value , $lineitemindex);

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 LineItemUnitCost is calculated. If you're selling rope by the foot, the LineItemUnits might be "feet". If you're selling chemicals, it might be by the "ounce". For example, if your customer purchased 3 T-Shirts at $13.99 each, then: 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

The maximum length of this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The $lineitemindex 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

LocalTax Property (DPaymentsSDK_TSYSLevel3 Class)

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

Object Oriented Interface

public function getLocalTax();


public function setLocalTax($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 28 );


dpaymentssdk_tsyslevel3_set($res, 28, $value );

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

Merchant's government tax Id number.

Object Oriented Interface

public function getMerchantTaxId();


public function setMerchantTaxId($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 29 );


dpaymentssdk_tsyslevel3_set($res, 29, $value );

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

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

Object Oriented Interface

public function getNationalTax();


public function setNationalTax($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 30 );


dpaymentssdk_tsyslevel3_set($res, 30, $value );

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

Date of the order in YYMMDD format.

Object Oriented Interface

public function getOrderDate();


public function setOrderDate($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 31 );


dpaymentssdk_tsyslevel3_set($res, 31, $value );

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

Optional purchase order number assigned by the merchant.

Object Oriented Interface

public function getPurchaseIdentifier();


public function setPurchaseIdentifier($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 32 );


dpaymentssdk_tsyslevel3_set($res, 32, $value );

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

Purchase Order Number supplied by the cardholder.

Object Oriented Interface

public function getPurchaseOrder();


public function setPurchaseOrder($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 33 );


dpaymentssdk_tsyslevel3_set($res, 33, $value );

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

Zip code the goods are being shipped from.

Object Oriented Interface

public function getShipFromZip();


public function setShipFromZip($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 34 );


dpaymentssdk_tsyslevel3_set($res, 34, $value );

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

Unique Value Added Tax Invoice Reference Number.

Object Oriented Interface

public function getTaxInvoiceNumber();


public function setTaxInvoiceNumber($value);

Procedural Interface

dpaymentssdk_tsyslevel3_get($res, 35 );


dpaymentssdk_tsyslevel3_set($res, 35, $value );

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_tsyslevel3_do_config($res, $configurationstring);

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.

GetAddendum Method (DPaymentsSDK_TSYSLevel3 Class)

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

Object Oriented Interface

public function doGetAddendum();

Procedural Interface

dpaymentssdk_tsyslevel3_do_getaddendum($res);

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 properties are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• LineItemDescription
• LineItemDiscountAmount
• LineItemProductCode
• LineItemQuantity
• LineItemTaxAmount
• LineItemTaxRate
• LineItemTotal
• LineItemUnits

Additional properties for the tctVisa CardType include:

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• LineItemCommodityCode
• LineItemUnitCost

Additional properties for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• LineItemDiscountRate
• LineItemTaxIncluded
• LineItemTaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType: '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()

Reset Method (DPaymentsSDK_TSYSLevel3 Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsyslevel3_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_TSYSLevel3 Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_tsyslevel3_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

TSYSLevel3 Config Settings

Base Config Settings

Trappable Errors (TSYSLevel3 Class)

TSYSLevel3 Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	592   Invalid or unparseable aggregate.
	605   Invalid CardType.