TSYSHCAdjustment Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSHCAdjustment class is used to adjust a previously authorized transaction. This class makes adjusting transactions very easy.

Class Name

DPaymentsSDK_TSYSHCAdjustment

Procedural Interface

 dpaymentssdk_tsyshcadjustment_open();
 dpaymentssdk_tsyshcadjustment_close($res);
 dpaymentssdk_tsyshcadjustment_register_callback($res, $id, $function);
 dpaymentssdk_tsyshcadjustment_get_last_error($res);
 dpaymentssdk_tsyshcadjustment_get_last_error_code($res);
 dpaymentssdk_tsyshcadjustment_set($res, $id, $index, $value);
 dpaymentssdk_tsyshcadjustment_get($res, $id, $index);
 dpaymentssdk_tsyshcadjustment_do_adjusttransaction($res);
 dpaymentssdk_tsyshcadjustment_do_config($res, $configurationstring);
 dpaymentssdk_tsyshcadjustment_do_interrupt($res);
 dpaymentssdk_tsyshcadjustment_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 TSYSHCAdjustment class makes adjusting transactions 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:

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

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

TSYSHCAdjustment1.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber TSYSHCAdjustment1.OriginalAmount = "1250"

When processing a Level 2 Corporate Purchasing card transaction you need to set the Card properties which will enable the component to send the proper card-specific Level2 fields. For instance:

TSYSHCAdjustment1.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?" TSYSHCAdjustment1.Card.EntryDataSource = edsTrack1

If you wish to settle an amount that is different than the original authorized amount, you can set SettleAmount to the value you wish to settle. Note that this value can only be less than or equal to the OriginalAmount.

TSYSHCAdjustment1.SettleAmount = "1000"

Finally, submit the adjustment by calling AdjustTransaction. TSYSHCAdjustment1.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 transaction adjustment was successful. The remaining properties provide additional information about the transaction.

Once the adjustment 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.

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.

CaptureMode Property (DPaymentsSDK_TSYSHCAdjustment Class)

The capture mode to be used when performing an authorization or adjustment.

Object Oriented Interface

public function getCaptureMode();


public function setCaptureMode($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 1 );


dpaymentssdk_tsyshcadjustment_set($res, 1, $value );

Default Value

0

Remarks

This property is used to specify the capture mode to be used when performing an authorization or an adjustment transaction.

Possible values are:

If you wish to add Level 3 data, you will want to set CaptureMode to Delay (1) when issuing the initial authorization. Then once the Level 3 request is successfully issued, the transaction will be captured in the next batch close event.

Note: To use the Hold and Capture modes, the merchant must be established as a Hold Capture participant.

Note: To use the Delay mode, the merchant must be established as a Delay Capture participant.

Data Type

Integer

CardType Property (DPaymentsSDK_TSYSHCAdjustment Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 2 );


dpaymentssdk_tsyshcadjustment_set($res, 2, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_TSYSHCAdjustment Class)

Three digit security code on back of card (optional).

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 3 );


dpaymentssdk_tsyshcadjustment_set($res, 3, $value );

Default Value

''

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_TSYSHCAdjustment Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 4 );


dpaymentssdk_tsyshcadjustment_set($res, 4, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_TSYSHCAdjustment Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 5 );


dpaymentssdk_tsyshcadjustment_set($res, 5, $value );

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_TSYSHCAdjustment Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 6 );


dpaymentssdk_tsyshcadjustment_set($res, 6, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_TSYSHCAdjustment Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 7 );


dpaymentssdk_tsyshcadjustment_set($res, 7, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_TSYSHCAdjustment Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface

public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 8 );


dpaymentssdk_tsyshcadjustment_set($res, 8, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_TSYSHCAdjustment Class)

Track data read off of the card's magnetic stripe.

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 9 );


dpaymentssdk_tsyshcadjustment_set($res, 9, $value );

Default Value

''

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_TSYSHCAdjustment Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 10 );


dpaymentssdk_tsyshcadjustment_set($res, 10, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

ClearingSequenceCount Property (DPaymentsSDK_TSYSHCAdjustment Class)

The total number of installment payments.

Object Oriented Interface

public function getClearingSequenceCount();


public function setClearingSequenceCount($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 11 );


dpaymentssdk_tsyshcadjustment_set($res, 11, $value );

Default Value

0

Remarks

This property is used when processing installment payments to specify the total number of transactions in the sequence.

Below is an example of using installment payments (for a total of 3 payments) and what ClearingSequenceNumber and ClearingSequenceCount should be set to for each payment.

Data Type

Integer

ClearingSequenceNumber Property (DPaymentsSDK_TSYSHCAdjustment Class)

The payment number of the total number of installment payments.

Object Oriented Interface

public function getClearingSequenceNumber();


public function setClearingSequenceNumber($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 12 );


dpaymentssdk_tsyshcadjustment_set($res, 12, $value );

Default Value

0

Remarks

This property is used to specify the payment number that the current payment represents in the total count of installment payments to be made (represented by ClearingSequenceCount).

Below is an example of using installment payments (for a total of 3 payments) and what ClearingSequenceNumber and ClearingSequenceCount should be set to for each payment.

Data Type

Integer

GenKey Property (DPaymentsSDK_TSYSHCAdjustment Class)

The unique GenKey value used to identify a POS device.

Object Oriented Interface

public function getGenKey();


public function setGenKey($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 13 );


dpaymentssdk_tsyshcadjustment_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

GoodsIndicator Property (DPaymentsSDK_TSYSHCAdjustment Class)

Used to identify the type of goods purchased over the Internet.

Object Oriented Interface

public function getGoodsIndicator();


public function setGoodsIndicator($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 14 );


dpaymentssdk_tsyshcadjustment_set($res, 14, $value );

Default Value

0

Remarks

This property is used to identify the type of goods purchased over the Internet. Supported types are shown below.

Data Type

Integer

InvoiceNumber Property (DPaymentsSDK_TSYSHCAdjustment Class)

Invoice number for the purchase.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 15 );


dpaymentssdk_tsyshcadjustment_set($res, 15, $value );

Default Value

''

Remarks

This property is used to specify the merchant assigned invoice number for the e-Commerce (card not present) purchase.

Data Type

String

Level2AmexChargeDescriptor Property (DPaymentsSDK_TSYSHCAdjustment Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor();


public function setLevel2AmexChargeDescriptor($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 16 );


dpaymentssdk_tsyshcadjustment_set($res, 16, $value );

Default Value

''

Remarks

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

Data Type

String

Level2AmexChargeDescriptor2 Property (DPaymentsSDK_TSYSHCAdjustment Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor2();


public function setLevel2AmexChargeDescriptor2($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 17 );


dpaymentssdk_tsyshcadjustment_set($res, 17, $value );

Default Value

''

Remarks

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

Data Type

String

Level2AmexChargeDescriptor3 Property (DPaymentsSDK_TSYSHCAdjustment Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor3();


public function setLevel2AmexChargeDescriptor3($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 18 );


dpaymentssdk_tsyshcadjustment_set($res, 18, $value );

Default Value

''

Remarks

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

Data Type

String

Level2AmexChargeDescriptor4 Property (DPaymentsSDK_TSYSHCAdjustment Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor4();


public function setLevel2AmexChargeDescriptor4($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 19 );


dpaymentssdk_tsyshcadjustment_set($res, 19, $value );

Default Value

''

Remarks

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

Data Type

String

Level2AmexRequesterName Property (DPaymentsSDK_TSYSHCAdjustment Class)

The name of the requestor, if different than the cardholder.

Object Oriented Interface

public function getLevel2AmexRequesterName();


public function setLevel2AmexRequesterName($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 20 );


dpaymentssdk_tsyshcadjustment_set($res, 20, $value );

Default Value

''

Remarks

The name of the requestor, if different than the cardholder.

This property contains the name of the requester, if the Card member is not the person that ordered or purchased the product or service.

The maximum length for this field is 38 characters.

Data Type

String

Level2AmexShippedToZip Property (DPaymentsSDK_TSYSHCAdjustment Class)

The zip code to which the commodity was shipped.

Object Oriented Interface

public function getLevel2AmexShippedToZip();


public function setLevel2AmexShippedToZip($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 21 );


dpaymentssdk_tsyshcadjustment_set($res, 21, $value );

Default Value

''

Remarks

The zip code to which the commodity was shipped.

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. This is only used when sending Level II data for an American Express purchasing card.

The maximum length for this property is 6 characters.

Data Type

String

Level2IsTaxExempt Property (DPaymentsSDK_TSYSHCAdjustment Class)

Identifies the characteristics of the amount appearing in TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status.

Object Oriented Interface

public function getLevel2IsTaxExempt();


public function setLevel2IsTaxExempt($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 22 );


dpaymentssdk_tsyshcadjustment_set($res, 22, $value );

Default Value

false

Remarks

Identifies the characteristics of the amount appearing in Level2TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status.

When set to "True", the purchasing card will be indicated as being tax-exempt. When set to "False", the amount of Level2TaxAmount will be indicated as being Local Sales Tax.

Note: This property cannot be set to "True" if there is a Level2TaxAmount set.

Data Type

Boolean

Level2PurchaseOrderNumber Property (DPaymentsSDK_TSYSHCAdjustment Class)

Optional customer-specified purchase order number.

Object Oriented Interface

public function getLevel2PurchaseOrderNumber();


public function setLevel2PurchaseOrderNumber($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 23 );


dpaymentssdk_tsyshcadjustment_set($res, 23, $value );

Default Value

''

Remarks

Optional customer-specified purchase order number.

This property contains a Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder. The maximum length is 25 characters.

Data Type

String

Level2TaxAmount Property (DPaymentsSDK_TSYSHCAdjustment Class)

Sales tax charged in addition to the original TransactionAmount Any non-zero sales tax must have a minimum value of 0.

Object Oriented Interface

public function getLevel2TaxAmount();


public function setLevel2TaxAmount($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 24 );


dpaymentssdk_tsyshcadjustment_set($res, 24, $value );

Default Value

''

Remarks

Sales tax charged in addition to the original TransactionAmount

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

Data Type

String

MerchantId Property (DPaymentsSDK_TSYSHCAdjustment 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_tsyshcadjustment_get($res, 25 );


dpaymentssdk_tsyshcadjustment_set($res, 25, $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

OriginalAmount Property (DPaymentsSDK_TSYSHCAdjustment Class)

The original authorized amount for the transaction to be adjusted.

Object Oriented Interface

public function getOriginalAmount();


public function setOriginalAmount($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 26 );


dpaymentssdk_tsyshcadjustment_set($res, 26, $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_TSYSHCAdjustment Class)

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

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 27 );

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

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 28 );

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_TSYSHCAdjustment 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_tsyshcadjustment_get($res, 29 );

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

Text information that describes each response code.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 30 );

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

Local transaction date returned from the server in MMddyy format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 31 );

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

Check this property against the original Transaction Number.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 32 );

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

Local transaction time returned from the server in HHmmss format.

Object Oriented Interface

public function getResponseTransactionTime();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 33 );

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

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

Object Oriented Interface

public function getRetrievalNumber();


public function setRetrievalNumber($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 34 );


dpaymentssdk_tsyshcadjustment_set($res, 34, $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_TSYSHCAdjustment Class)

The Routing ID assigned to the merchant by TSYS.

Object Oriented Interface

public function getRoutingId();


public function setRoutingId($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 35 );


dpaymentssdk_tsyshcadjustment_set($res, 35, $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

SettleAmount Property (DPaymentsSDK_TSYSHCAdjustment Class)

The final settlement amount.

Object Oriented Interface

public function getSettleAmount();


public function setSettleAmount($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 36 );


dpaymentssdk_tsyshcadjustment_set($res, 36, $value );

Default Value

''

Remarks

This property is used to specify the final settlement (transaction) amount.

Note: The final settlement amount can only be decreased. Thus SettlementAmount must be less than OriginalAmount. If you do not wish to adjust the settlement amount, you can should not set SettlementAmount.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_TSYSHCAdjustment Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 38 );


dpaymentssdk_tsyshcadjustment_set($res, 38, $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_TSYSHCAdjustment Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 66 );


dpaymentssdk_tsyshcadjustment_set($res, 66, $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_TSYSHCAdjustment 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_tsyshcadjustment_get($res, 82 );


dpaymentssdk_tsyshcadjustment_set($res, 82, $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 designations are 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., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_TSYSHCAdjustment 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_tsyshcadjustment_get($res, 83 );


dpaymentssdk_tsyshcadjustment_set($res, 83, $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_TSYSHCAdjustment Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 84 );


dpaymentssdk_tsyshcadjustment_set($res, 84, $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_TSYSHCAdjustment 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_tsyshcadjustment_get($res, 85 );


dpaymentssdk_tsyshcadjustment_set($res, 85, $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 as follows:

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

Data Type

String

SSLProvider Property (DPaymentsSDK_TSYSHCAdjustment Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 93 );


dpaymentssdk_tsyshcadjustment_set($res, 93, $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_TSYSHCAdjustment Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 95 );

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

Timeout Property (DPaymentsSDK_TSYSHCAdjustment Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 122 );


dpaymentssdk_tsyshcadjustment_set($res, 122, $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

TransactionDesc Property (DPaymentsSDK_TSYSHCAdjustment Class)

Soft (Dynamic) Descriptor.

Object Oriented Interface

public function getTransactionDesc();


public function setTransactionDesc($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 123 );


dpaymentssdk_tsyshcadjustment_set($res, 123, $value );

Default Value

''

Remarks

This property allows a merchant to specify a description about the transaction.

The maximum length of this property is 25 characters (alphanumeric and special characters).

Data Type

String

TransactionNumber Property (DPaymentsSDK_TSYSHCAdjustment Class)

Sequence number of this transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_tsyshcadjustment_get($res, 124 );


dpaymentssdk_tsyshcadjustment_set($res, 124, $value );

Default Value

0

Remarks

This number must be unique, it's used to identify the transaction in order to operate on it in the future.

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages.

The maximum length of this property is 8 characters.

TSYS suggests the following application rules for the format of TransactionNumber:

• Format the TransactionNumber as "DDSSS", where DD is the current day of the month and SSS is a sequence of numbers from 001-999.
• Configure the sequence number for 2-5 positions so the sequence number can increment through a single day without rolling over.
• Allow the sequence to increment and roll-over. Do not program the TransactionNumber to reset when a batch close occurs.

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

Integer

AdjustTransaction Method (DPaymentsSDK_TSYSHCAdjustment Class)

Sends an adjustment request.

Object Oriented Interface

public function doAdjustTransaction();

Procedural Interface

dpaymentssdk_tsyshcadjustment_do_adjusttransaction($res);

Remarks

This method allows you to adjust a previously authorized transaction. It can be used to decrease the final SettlementAmount and adjust non-financial fields. 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 or TransactionNumber

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.

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.

Note that AdjustTransaction cannot be used to add a tip amount. If you wish to add a tip, you must use AdjustTip.

Config Method (DPaymentsSDK_TSYSHCAdjustment Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_tsyshcadjustment_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_TSYSHCAdjustment Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_tsyshcadjustment_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_TSYSHCAdjustment Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsyshcadjustment_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_TSYSHCAdjustment Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_tsyshcadjustment_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_TSYSHCAdjustment Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (TSYSHCAdjustment Class)

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

TSYSHCAdjustment Errors