TSYSHCLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSHCLevel3 class is used to add Level 3 data to a previously authorized transaction. This class makes adding Level 3 data very easy.

Class Name

DPaymentsSDK_TSYSHCLevel3

Procedural Interface

 dpaymentssdk_tsyshclevel3_open();
 dpaymentssdk_tsyshclevel3_close($res);
 dpaymentssdk_tsyshclevel3_register_callback($res, $id, $function);
 dpaymentssdk_tsyshclevel3_get_last_error($res);
 dpaymentssdk_tsyshclevel3_get_last_error_code($res);
 dpaymentssdk_tsyshclevel3_set($res, $id, $index, $value);
 dpaymentssdk_tsyshclevel3_get($res, $id, $index);
 dpaymentssdk_tsyshclevel3_do_adjusttransaction($res);
 dpaymentssdk_tsyshclevel3_do_config($res, $configurationstring);
 dpaymentssdk_tsyshclevel3_do_interrupt($res);
 dpaymentssdk_tsyshclevel3_do_reset($res);

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHCLevel3 class makes adding Level 3 data to a transaction very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:

TSYSHCLevel31.GenKey = "gen_key_value" TSYSHCLevel31.MerchantId = "merchant_id" TSYSHCLevel31.RoutingId = "routing_id"

Next, set properties that contain details about the transaction. At the minimum, you must set a RetrievalNumber and OriginalAmount.

TSYSHCLevel31.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber TSYSHCLevel31.OriginalAmount = TSYSHCRetail1.TransactionAmount

Now, set the Level 3 enhanced data that you wish to add to the transaction. For example: TSYSHCLevel31.CommodityCode = "FAKE" TSYSHCLevel31.NationalTax = "0" TSYSHCLevel31.MerchantTaxId = "merchantTaxId" // Merchant VAT Registration Number TSYSHCLevel31.CustomerTaxId = "customerTaxId" // Customer VAT Registration Number TSYSHCLevel31.DiscountAmount = "0" TSYSHCLevel31.FreightAmount = "0" TSYSHCLevel31.DutyAmount = "0" TSYSHCLevel31.ShipFromZip = "27709" TSYSHCLevel31.DestinationZip = "27709" TSYSHCLevel31.DestinationCountry = "840" TSYSHCLevel31.InvoiceNumber = "VATInvoiceRefNo" TSYSHCLevel31.OrderDate = "111023" // "yyMMdd" TSYSHCLevel31.FreightTaxAmount = "0" TSYSHCLevel31.FreightTaxRate = "0"

If you have any line item details, you can specify them now. Note that LineItemQuantity and LineItemTotal are required to be set when adding line item details.

TSYSHCLevel31.LineItemCount = 2 TSYSHCLevel31.LineItemCommodityCode(0) = "fake" TSYSHCLevel31.LineItemDescription(0) = "hardware" TSYSHCLevel31.LineItemDiscountAmount(0) = "0" TSYSHCLevel31.LineItemDiscountRate(0) = "0" TSYSHCLevel31.LineItemProductCode(0) = "1243320" TSYSHCLevel31.LineItemQuantity(0) = 1 TSYSHCLevel31.LineItemTaxAmount(0) = "3" TSYSHCLevel31.LineItemTaxRate(0) = "0" TSYSHCLevel31.LineItemTotal(0) = "53" TSYSHCLevel31.LineItemUnitCost(0) = "50" TSYSHCLevel31.LineItemUnits(0) = "each" TSYSHCLevel31.LineItemCommodityCode(1) = "fake" TSYSHCLevel31.LineItemDescription(1) = "software" TSYSHCLevel31.LineItemDiscountAmount(1) = "0" TSYSHCLevel31.LineItemDiscountRate(1) = "0" TSYSHCLevel31.LineItemProductCode(1) = "1243321" TSYSHCLevel31.LineItemQuantity(1) = 2 TSYSHCLevel31.LineItemTaxAmount(1) = "3" TSYSHCLevel31.LineItemTaxRate(1) = "0" TSYSHCLevel31.LineItemTotal(1) = "106" TSYSHCLevel31.LineItemUnitCost(1) = "53" TSYSHCLevel31.LineItemUnits(1) = "each"

Finally, submit the level 3 details by calling AdjustTransaction. TSYSHCRetail1.AdjustTransaction()

When the class receives a response from the Vital/TSYS servers, the result of the adjustment will be displayed in several Response properties. The ResponseCode indicates whether the level 3 details were successfully added to the transaction. The remaining properties provide additional information about the transaction.

Once the level 3 details are successfully added, the transaction will be added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr class.

Note: If you intend to add Level 3 data to a transaction, the initial authorization (purchase) should have CaptureMode set to Delay (1). This initiates a delay on the capture, thus providing you with time to add the Level 3 details before the transaction is settled.

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_TSYSHCLevel3 Class)

Secondary tax amount (only applicable in some countries).

Object Oriented Interface

public function getAlternateTaxAmount();


public function setAlternateTaxAmount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 1 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Tax Id number of the merchant that reported the AlternateTaxAmount .

Object Oriented Interface

public function getAlternateTaxId();


public function setAlternateTaxId($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 2 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

The card type for which a Level 3 addendum will be created.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 3 );


dpaymentssdk_tsyshclevel3_set($res, 3, $value );

Default Value

0

Remarks

The value of this property MUST correspond to the card used in the original authorization request (that is referenced by RetrievalNumber).

Valid values for this property include:

Data Type

Integer

CommodityCode Property (DPaymentsSDK_TSYSHCLevel3 Class)

Code indicating the type of goods or services sold.

Object Oriented Interface

public function getCommodityCode();


public function setCommodityCode($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 4 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Customer's Value Added Tax registration number.

Object Oriented Interface

public function getCustomerTaxId();


public function setCustomerTaxId($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 5 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Country the goods are to be shipped to.

Object Oriented Interface

public function getDestinationCountry();


public function setDestinationCountry($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 6 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Zip code the goods are to be shipped to.

Object Oriented Interface

public function getDestinationZip();


public function setDestinationZip($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 7 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Amount of any discount subtracted from the line item totals.

Object Oriented Interface

public function getDiscountAmount();


public function setDiscountAmount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 8 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Duty fees (if any) for imported goods.

Object Oriented Interface

public function getDutyAmount();


public function setDutyAmount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 9 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Shipping charges associated with this transaction.

Object Oriented Interface

public function getFreightAmount();


public function setFreightAmount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 10 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Portion of the FreightAmount that is tax.

Object Oriented Interface

public function getFreightTaxAmount();


public function setFreightTaxAmount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 11 );


dpaymentssdk_tsyshclevel3_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_TSYSHCLevel3 Class)

Rate used to calculate the FreightTaxAmount .

Object Oriented Interface

public function getFreightTaxRate();


public function setFreightTaxRate($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 12 );


dpaymentssdk_tsyshclevel3_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

GenKey Property (DPaymentsSDK_TSYSHCLevel3 Class)

The unique GenKey value used to identify a POS device.

Object Oriented Interface

public function getGenKey();


public function setGenKey($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 13 );


dpaymentssdk_tsyshclevel3_set($res, 13, $value );

Default Value

''

Remarks

This property is used to specify the unique GenKey value used to identify the POS device to the host capture system. This property is required to be specified in every transaction performed.

Your GenKey value is obtained from the host capture system when you successfully authenticate your POS device, which can be accomplished by calling AuthenticateDevice. Once retrieved, your GenKey value must be stored in the POS device.

Data Type

String

LineItemCount Property (DPaymentsSDK_TSYSHCLevel3 Class)

The number of records in the LineItem arrays.

Object Oriented Interface

public function getLineItemCount();


public function setLineItemCount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 14 );


dpaymentssdk_tsyshclevel3_set($res, 14, $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_TSYSHCLevel3 Class)

Code describing the good or service being supplied.

Object Oriented Interface

public function getLineItemCommodityCode($lineitemindex);


public function setLineItemCommodityCode($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 15 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 15, $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_TSYSHCLevel3 Class)

Debit/Credit Indicator.

Object Oriented Interface

public function getLineItemDebitCreditIndicator($lineitemindex);


public function setLineItemDebitCreditIndicator($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 16 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 16, $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_TSYSHCLevel3 Class)

Description of the item.

Object Oriented Interface

public function getLineItemDescription($lineitemindex);


public function setLineItemDescription($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 17 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 17, $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_TSYSHCLevel3 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_tsyshclevel3_get($res, 18 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 18, $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_TSYSHCLevel3 Class)

Rate used to calculate the DiscountAmount .

Object Oriented Interface

public function getLineItemDiscountRate($lineitemindex);


public function setLineItemDiscountRate($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 19 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 19, $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_TSYSHCLevel3 Class)

Merchant-defined product code for this Line Item.

Object Oriented Interface

public function getLineItemProductCode($lineitemindex);


public function setLineItemProductCode($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 20 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 20, $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_TSYSHCLevel3 Class)

Quantity of items in this Line Item.

Object Oriented Interface

public function getLineItemQuantity($lineitemindex);


public function setLineItemQuantity($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 21 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 21, $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_TSYSHCLevel3 Class)

Tax on this individual item.

Object Oriented Interface

public function getLineItemTaxAmount($lineitemindex);


public function setLineItemTaxAmount($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 22 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 22, $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_TSYSHCLevel3 Class)

Net/Gross Indicator.

Object Oriented Interface

public function getLineItemTaxIncluded($lineitemindex);


public function setLineItemTaxIncluded($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 23 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 23, $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_TSYSHCLevel3 Class)

Tax rate used to calculate the TaxAmount .

Object Oriented Interface

public function getLineItemTaxRate($lineitemindex);


public function setLineItemTaxRate($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 24 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 24, $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_TSYSHCLevel3 Class)

Type of tax charged in TaxAmount .

Object Oriented Interface

public function getLineItemTaxType($lineitemindex);


public function setLineItemTaxType($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 25 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 25, $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_TSYSHCLevel3 Class)

Total cost of this line item.

Object Oriented Interface

public function getLineItemTotal($lineitemindex);


public function setLineItemTotal($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 26 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 26, $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_TSYSHCLevel3 Class)

Cost of each individual item.

Object Oriented Interface

public function getLineItemUnitCost($lineitemindex);


public function setLineItemUnitCost($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 27 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 27, $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_TSYSHCLevel3 Class)

Unit of measure for this Line Item.

Object Oriented Interface

public function getLineItemUnits($lineitemindex);


public function setLineItemUnits($lineitemindex, $value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 28 , $lineitemindex);


dpaymentssdk_tsyshclevel3_set($res, 28, $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

MerchantId Property (DPaymentsSDK_TSYSHCLevel3 Class)

The unique ID that associates the POS device with the merchant account.

Object Oriented Interface

public function getMerchantId();


public function setMerchantId($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 29 );


dpaymentssdk_tsyshclevel3_set($res, 29, $value );

Default Value

''

Remarks

The unique ID, also known as the POS ID, that associates the POS device with the merchant account.

This property is required to be specified in every transaction performed.

Data Type

String

MerchantTaxId Property (DPaymentsSDK_TSYSHCLevel3 Class)

Merchant's government tax Id number.

Object Oriented Interface

public function getMerchantTaxId();


public function setMerchantTaxId($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 30 );


dpaymentssdk_tsyshclevel3_set($res, 30, $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_TSYSHCLevel3 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_tsyshclevel3_get($res, 31 );


dpaymentssdk_tsyshclevel3_set($res, 31, $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_TSYSHCLevel3 Class)

Date of the order in YYMMDD format.

Object Oriented Interface

public function getOrderDate();


public function setOrderDate($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 32 );


dpaymentssdk_tsyshclevel3_set($res, 32, $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

OriginalAmount Property (DPaymentsSDK_TSYSHCLevel3 Class)

The original authorized amount for the transaction to be adjusted.

Object Oriented Interface

public function getOriginalAmount();


public function setOriginalAmount($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 33 );


dpaymentssdk_tsyshclevel3_set($res, 33, $value );

Default Value

''

Remarks

This property is used to specify the original transaction amount. This property is required, along with either RetrievalNumber or TransactionNumber, when calling AdjustTransaction so that the Host Capture system can identify the transaction.

The transaction 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 MerchantCurrencyCode. In the United States, the number of allowable significant digits is seven. Thus the maximum t transaction amount; is "9999999", yielding a US dollar amount of $99,999.99.

Note: This field may not contain a negative number.

Data Type

String

ResponseBatchNumber Property (DPaymentsSDK_TSYSHCLevel3 Class)

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 34 );

Default Value

0

Remarks

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.

This property is read-only.

Data Type

Integer

ResponseCode Property (DPaymentsSDK_TSYSHCLevel3 Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 35 );

Default Value

''

Remarks

Indicates the status of the authorization request.

This property contains the response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "10" indicates that the transaction was partially approved for a lesser amount (ResponseAuthorizedAmount). All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

A list of valid result ResponseCodes are listed in the table of contents.

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (DPaymentsSDK_TSYSHCLevel3 Class)

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 36 );

Default Value

''

Remarks

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.

This property is read-only and not available at design time.

Data Type

String

ResponseText Property (DPaymentsSDK_TSYSHCLevel3 Class)

Text information that describes each response code.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 37 );

Default Value

''

Remarks

Text information that describes each response code.

This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.

The English-language response text messages are listed in the table of contents.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionDate Property (DPaymentsSDK_TSYSHCLevel3 Class)

Local transaction date returned from the server in MMddyy format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 38 );

Default Value

''

Remarks

Local transaction date returned from the server in MMddyy format.

This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionNumber Property (DPaymentsSDK_TSYSHCLevel3 Class)

Check this property against the original Transaction Number.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 39 );

Default Value

''

Remarks

Check this property against the original Transaction Number.

This property should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionTime Property (DPaymentsSDK_TSYSHCLevel3 Class)

Local transaction time returned from the server in HHmmss format.

Object Oriented Interface

public function getResponseTransactionTime();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 40 );

Default Value

''

Remarks

Local transaction time returned from the server in HHmmss format.

This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

RetrievalNumber Property (DPaymentsSDK_TSYSHCLevel3 Class)

The retrieval reference number (RRN) used to identify a transaction.

Object Oriented Interface

public function getRetrievalNumber();


public function setRetrievalNumber($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 41 );


dpaymentssdk_tsyshclevel3_set($res, 41, $value );

Default Value

''

Remarks

This property is used to specify the retrieval reference number (RRN) for the transaction that you wish to retrieve or adjust. This value is used by the Host Capture system to identify the transaction.

Note either RetrievalNumber or TransactionNumber may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the RetrievalNumber will be used and the TransactionNumber ignored.

In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.

Data Type

String

RoutingId Property (DPaymentsSDK_TSYSHCLevel3 Class)

The Routing ID assigned to the merchant by TSYS.

Object Oriented Interface

public function getRoutingId();


public function setRoutingId($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 42 );


dpaymentssdk_tsyshclevel3_set($res, 42, $value );

Default Value

''

Remarks

This property is used to specify the six alphanumeric character routing ID assigned to you via TSYS.

This property is required to be set for every transaction request.

Data Type

String

ShipFromZip Property (DPaymentsSDK_TSYSHCLevel3 Class)

Zip code the goods are being shipped from.

Object Oriented Interface

public function getShipFromZip();


public function setShipFromZip($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 43 );


dpaymentssdk_tsyshclevel3_set($res, 43, $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

SSLAcceptServerCertEncoded Property (DPaymentsSDK_TSYSHCLevel3 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 45 );


dpaymentssdk_tsyshclevel3_set($res, 45, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_TSYSHCLevel3 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 73 );


dpaymentssdk_tsyshclevel3_set($res, 73, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_TSYSHCLevel3 Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 89 );


dpaymentssdk_tsyshclevel3_set($res, 89, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_TSYSHCLevel3 Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 90 );


dpaymentssdk_tsyshclevel3_set($res, 90, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_TSYSHCLevel3 Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 91 );


dpaymentssdk_tsyshclevel3_set($res, 91, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_TSYSHCLevel3 Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 92 );


dpaymentssdk_tsyshclevel3_set($res, 92, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (DPaymentsSDK_TSYSHCLevel3 Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 100 );


dpaymentssdk_tsyshclevel3_set($res, 100, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_TSYSHCLevel3 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 102 );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

TaxInvoiceNumber Property (DPaymentsSDK_TSYSHCLevel3 Class)

Optional VAT Invoice Number assigned by the merchant.

Object Oriented Interface

public function getTaxInvoiceNumber();


public function setTaxInvoiceNumber($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 129 );


dpaymentssdk_tsyshclevel3_set($res, 129, $value );

Default Value

''

Remarks

In this property the merchant may assign an optional VAT Invoice Number.

An invoice number can contain alphanumeric characters and must not be greater than 15 characters in length.

Data Type

String

Timeout Property (DPaymentsSDK_TSYSHCLevel3 Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_tsyshclevel3_get($res, 130 );


dpaymentssdk_tsyshclevel3_set($res, 130, $value );

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

AdjustTransaction Method (DPaymentsSDK_TSYSHCLevel3 Class)

Sends Level 3 transaction requests.

Object Oriented Interface

public function doAdjustTransaction();

Procedural Interface

dpaymentssdk_tsyshclevel3_do_adjusttransaction($res);

Remarks

This method allows you to add Level 3 data to a previously authorized transaction. If the adjustment request was successful, the ResponseCode property will contain "200". Response will contain additional details about the authorization request.

Minimum required properties:

• GenKey
• MerchantId
• RoutingId
• OriginalAmount
• RetrievalNumber

If you wish to also add LineItems data, the following properties are required to do so:

• LineItemQuantity
• LineItemTotal

When adding LineItems data, the class will send a separate adjustment request for each line item. If a line item request fails to adjust successfully, the class fails with an error. The error message will contain the index of the failed line item. ResponseCode and ResponseText will contain additional details about why the line item failed.

If a timeout occurs during the adjustment request, you will want to use the TSYSHCTransactionDetails class to issue a GetDetails request. If the request was received by the TSYS server, the GetDetails response will contain the adjusted values and no other steps are necessary. If the request was not received by the TSYS server, the GetDetails response will show that the adjusted values were not updated. Therefore the adjustment request should be resent.

Config Method (DPaymentsSDK_TSYSHCLevel3 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Interrupt Method (DPaymentsSDK_TSYSHCLevel3 Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_tsyshclevel3_do_interrupt($res);

Remarks

This method interrupts any processing that the class is currently executing.

Reset Method (DPaymentsSDK_TSYSHCLevel3 Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsyshclevel3_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_TSYSHCLevel3 Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

SSLServerAuthentication Event (DPaymentsSDK_TSYSHCLevel3 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_tsyshclevel3_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (DPaymentsSDK_TSYSHCLevel3 Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_tsyshclevel3_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (TSYSHCLevel3 Class)

TSYSHCLevel3 Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (TSYSHCLevel3 Class)

TSYSHCLevel3 Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors