TSYSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DPaymentsSDK_TSYSLevel2

Procedural Interface

 dpaymentssdk_tsyslevel2_open();
 dpaymentssdk_tsyslevel2_close($res);
 dpaymentssdk_tsyslevel2_register_callback($res, $id, $function);
 dpaymentssdk_tsyslevel2_get_last_error($res);
 dpaymentssdk_tsyslevel2_get_last_error_code($res);
 dpaymentssdk_tsyslevel2_set($res, $id, $index, $value);
 dpaymentssdk_tsyslevel2_get($res, $id, $index);
 dpaymentssdk_tsyslevel2_do_config($res, $configurationstring);
 dpaymentssdk_tsyslevel2_do_getaddendum($res);
 dpaymentssdk_tsyslevel2_do_reset($res);

Remarks

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

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

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

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

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

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AmexCardholderReference Property (DPaymentsSDK_TSYSLevel2 Class)

Reference number supplied by the card holder.

Object Oriented Interface

public function getAmexCardholderReference();


public function setAmexCardholderReference($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 1 );


dpaymentssdk_tsyslevel2_set($res, 1, $value );

Default Value

''

Remarks

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

The maximum length for this property is 17 characters.

Data Type

String

AmexChargeDescriptor Property (DPaymentsSDK_TSYSLevel2 Class)

Description of this transaction.

Object Oriented Interface

public function getAmexChargeDescriptor();


public function setAmexChargeDescriptor($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 2 );


dpaymentssdk_tsyslevel2_set($res, 2, $value );

Default Value

''

Remarks

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

Data Type

String

AmexSalesTax Property (DPaymentsSDK_TSYSLevel2 Class)

Portion of the transaction amount which is sales tax.

Object Oriented Interface

public function getAmexSalesTax();


public function setAmexSalesTax($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 3 );


dpaymentssdk_tsyslevel2_set($res, 3, $value );

Default Value

''

Remarks

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

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

Data Type

String

AmexShippedToZip Property (DPaymentsSDK_TSYSLevel2 Class)

The zip code to which the commodity was shipped.

Object Oriented Interface

public function getAmexShippedToZip();


public function setAmexShippedToZip($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 4 );


dpaymentssdk_tsyslevel2_set($res, 4, $value );

Default Value

''

Remarks

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

The maximum length for this property is 6 characters.

Data Type

String

AmexSupplierNumber Property (DPaymentsSDK_TSYSLevel2 Class)

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

Object Oriented Interface

public function getAmexSupplierNumber();


public function setAmexSupplierNumber($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 5 );


dpaymentssdk_tsyslevel2_set($res, 5, $value );

Default Value

''

Remarks

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

The maximum length for this property is 9 characters.

Data Type

String

CardType Property (DPaymentsSDK_TSYSLevel2 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_tsyslevel2_get($res, 6 );


dpaymentssdk_tsyslevel2_set($res, 6, $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

IsTaxExempt Property (DPaymentsSDK_TSYSLevel2 Class)

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

Object Oriented Interface

public function getIsTaxExempt();


public function setIsTaxExempt($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 7 );


dpaymentssdk_tsyslevel2_set($res, 7, $value );

Default Value

false

Remarks

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

Data Type

Boolean

LocalSalesTax Property (DPaymentsSDK_TSYSLevel2 Class)

Sales tax charged in addition to the original TransactionAmount .

Object Oriented Interface

public function getLocalSalesTax();


public function setLocalSalesTax($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 8 );


dpaymentssdk_tsyslevel2_set($res, 8, $value );

Default Value

''

Remarks

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

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

Data Type

String

PurchaseOrderNumber Property (DPaymentsSDK_TSYSLevel2 Class)

Optional customer-specified purchase order number.

Object Oriented Interface

public function getPurchaseOrderNumber();


public function setPurchaseOrderNumber($value);

Procedural Interface

dpaymentssdk_tsyslevel2_get($res, 9 );


dpaymentssdk_tsyslevel2_set($res, 9, $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

Config Method (DPaymentsSDK_TSYSLevel2 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

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

Object Oriented Interface

public function doGetAddendum();

Procedural Interface

dpaymentssdk_tsyslevel2_do_getaddendum($res);

Remarks

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

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

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

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

Reset Method (DPaymentsSDK_TSYSLevel2 Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsyslevel2_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_TSYSLevel2 Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Base Config Settings

Trappable Errors (TSYSLevel2 Class)

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