TSYSTerminalMgr Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSTerminalMgr class is used to authenticate and deactivate POS devices on the TSYS Terminal Capture platform.

Class Name

DPaymentsSDK_TSYSTerminalMgr

Procedural Interface

 dpaymentssdk_tsysterminalmgr_open();
 dpaymentssdk_tsysterminalmgr_close($res);
 dpaymentssdk_tsysterminalmgr_register_callback($res, $id, $function);
 dpaymentssdk_tsysterminalmgr_get_last_error($res);
 dpaymentssdk_tsysterminalmgr_get_last_error_code($res);
 dpaymentssdk_tsysterminalmgr_set($res, $id, $index, $value);
 dpaymentssdk_tsysterminalmgr_get($res, $id, $index);
 dpaymentssdk_tsysterminalmgr_do_authenticatedevice($res);
 dpaymentssdk_tsysterminalmgr_do_config($res, $configurationstring);
 dpaymentssdk_tsysterminalmgr_do_deactivatedevice($res);
 dpaymentssdk_tsysterminalmgr_do_interrupt($res);
 dpaymentssdk_tsysterminalmgr_do_reset($res);

Remarks

The TSYSTerminalMgr class makes authenticating and deactivating terminals simple. Terminal authentication can help reduce fraud risk and is recommended. Before authenticationg a device an AuthenticationCode must be obtained from TSYS. Provide the AuthenticationCode and other merchant information when calling AuthenticateDevice to obtain a GenKey.

Once the GenKey is obtained include this in all transactions from the terminal. When processing transactions using other components the GenKey may be specified via the Config method. For example: TSYSRetail1.Config("GenKey=MY_GEN_KEY");

To deactivate a terminal set GenKey and call DeactivateDevice.

Authenticating a Terminal

AuthenticateDevice authenticates a POS device with TSYS. After a device is authenticated GenKey will hold a unique value that should be included in all future transaction requests from the terminal. Before calling this method an AuthenticationCode must be obtained from TSYS.

The following Merchant properties are applicable when calling this method:

• MerchantBankId
• MerchantCategoryCode
• MerchantCountryCode
• MerchantCurrencyCode
• MerchantLanguage
• MerchantNumber
• MerchantServicePhone
• MerchantStoreNumber
• MerchantTerminalNumber
• MerchantTimeZone
• MerchantZip

• AuthenticationCode
• TransactionNumber
• DeviceCode
• IndustryType

After calling this method check ResponseCode to determine if the authentication succeeded. If the authentication succeeded ResponseCode will be "A1" and GenKey will be populated. If authentication failed ResponseCode will be "A2".

In addition to GenKey the following Response properties are populated:

• ResponseCode
• ResponseTransactionDate
• ResponseTransactionNumber
• ResponseTransactionTime
• ResponseAuthSource
• ResponseText

Processing Transactions

When processing transactions with other components in the toolkit smply set the "GenKey" configuration setting. For instance: TSYSRetail1.TransactionAmount = "1200"; TSYSRetail1.TransactionNumber = 2345; TSYSRetail1.IndustryType = TsysretailIndustryTypes.sitRetail; TSYSRetail1.Card.EntryDataSource = EntryDataSources.edsTrack1; TSYSRetail1.Card.MagneticStripe = "B4444333322221111^DOE/JOHN E ^091210100000033301000000008000000"; TSYSRetail1.Config("GenKey=" + genkey); TSYSRetail1.Authorize();

Deactivating a Terminal

DeactivateDevice is used to deactivate a previously activated terminal identified by GenKey.

The following Merchant properties are applicable when calling this method:

• MerchantBankId
• MerchantCategoryCode
• MerchantCountryCode
• MerchantCurrencyCode
• MerchantLanguage
• MerchantNumber
• MerchantServicePhone
• MerchantStoreNumber
• MerchantTerminalNumber
• MerchantTimeZone
• MerchantZip

• GenKey
• TransactionNumber
• DeviceCode
• IndustryType

After calling this method check ResponseCode and confirm it is "A3" to indicate the deactivation succeeded. The following Response properties are populated:

• ResponseCode
• ResponseTransactionDate
• ResponseTransactionNumber
• ResponseTransactionTime
• ResponseAuthSource
• ResponseText

DeactivateDevice Example: TSYSTerminalMgr1.Merchant.BankId = "999999"; TSYSTerminalMgr1.Merchant.CategoryCode = "9999"; TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT"; TSYSTerminalMgr1.Merchant.Number = "888000002447"; TSYSTerminalMgr1.Merchant.StoreNumber = "5999"; TSYSTerminalMgr1.Merchant.TerminalNumber = "1234"; TSYSTerminalMgr1.Merchant.Zip = "27516"; TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807"; TSYSTerminalMgr1.TransactionNumber = 1234; TSYSTerminalMgr1.GenKey = "MY_GEN_KEY"; TSYSTerminalMgr1.DeactivateDevice(); if (TSYSTerminalMgr1.Response.Code == "A3") //deactivated //...

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.

AuthenticationCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

An alphanumeric code used during the POS device authentication process.

Object Oriented Interface

public function getAuthenticationCode();


public function setAuthenticationCode($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 1 );


dpaymentssdk_tsysterminalmgr_set($res, 1, $value );

Default Value

''

Remarks

An alphanumeric code, provided to the POS user by TSYS, which is used during the POS device authentication process. Note that this property is required when calling AuthenticateDevice.

Data Type

String

GenKey Property (DPaymentsSDK_TSYSTerminalMgr Class)

A random alphanumeric value returned by TSYS.

Object Oriented Interface

public function getGenKey();


public function setGenKey($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 2 );


dpaymentssdk_tsysterminalmgr_set($res, 2, $value );

Default Value

''

Remarks

This value holds the GenKey value for the terminal. It is populated after calling AuthenticateDevice. It is required before calling DeactivateDevice.

This value should be stored on the POS device and used in all transaction requests.

Data Type

String

IndustryType Property (DPaymentsSDK_TSYSTerminalMgr Class)

Code which indicates the industry the merchant is engaged in.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 3 );


dpaymentssdk_tsysterminalmgr_set($res, 3, $value );

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Data Type

Integer

MerchantBankId Property (DPaymentsSDK_TSYSTerminalMgr Class)

The number which identifies the merchant's bank or processor.

Object Oriented Interface

public function getMerchantBankId();


public function setMerchantBankId($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 4 );


dpaymentssdk_tsysterminalmgr_set($res, 4, $value );

Default Value

''

Remarks

The number which identifies the merchant's bank or processor.

This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantCategoryCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

Classifies a merchant by the type of store.

Object Oriented Interface

public function getMerchantCategoryCode();


public function setMerchantCategoryCode($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 5 );


dpaymentssdk_tsysterminalmgr_set($res, 5, $value );

Default Value

''

Remarks

Classifies a merchant by the type of store.

This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).

Data Type

String

MerchantCity Property (DPaymentsSDK_TSYSTerminalMgr Class)

Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.

Object Oriented Interface

public function getMerchantCity();


public function setMerchantCity($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 6 );


dpaymentssdk_tsysterminalmgr_set($res, 6, $value );

Default Value

''

Remarks

Merchant's City

For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the MerchantName and MerchantState must also be specified.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this property is ignored. MerchantServicePhone is used for those industries instead of MerchantCity (this does not apply to MasterCard).

Note: This property must contain the same data used in the batch settlement. The first character of this property may not be a space. This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.

Data Type

String

MerchantCountryCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

Identifies the country where the merchant is located.

Object Oriented Interface

public function getMerchantCountryCode();


public function setMerchantCountryCode($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 7 );


dpaymentssdk_tsysterminalmgr_set($res, 7, $value );

Default Value

'840'

Remarks

Identifies the country where the merchant is located.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".

Data Type

String

MerchantCurrencyCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

Identifies the type of currency used by the merchant.

Object Oriented Interface

public function getMerchantCurrencyCode();


public function setMerchantCurrencyCode($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 8 );


dpaymentssdk_tsysterminalmgr_set($res, 8, $value );

Default Value

'840'

Remarks

Identifies the type of currency used by the merchant.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

Data Type

String

MerchantLanguage Property (DPaymentsSDK_TSYSTerminalMgr Class)

Designates the language that response messages will be returned in.

Object Oriented Interface

public function getMerchantLanguage();


public function setMerchantLanguage($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 9 );


dpaymentssdk_tsysterminalmgr_set($res, 9, $value );

Default Value

'00'

Remarks

Designates the language that response messages will be returned in.

This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.

Data Type

String

MerchantName Property (DPaymentsSDK_TSYSTerminalMgr Class)

Name of the merchant.

Object Oriented Interface

public function getMerchantName();


public function setMerchantName($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 10 );


dpaymentssdk_tsysterminalmgr_set($res, 10, $value );

Default Value

''

Remarks

Name of the merchant.

This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.

This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.

This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.

Data Type

String

MerchantNumber Property (DPaymentsSDK_TSYSTerminalMgr Class)

A unique number used to identify the merchant within the VisaNet system.

Object Oriented Interface

public function getMerchantNumber();


public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 11 );


dpaymentssdk_tsysterminalmgr_set($res, 11, $value );

Default Value

''

Remarks

A unique number used to identify the merchant within the VisaNet system.

This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantPhone Property (DPaymentsSDK_TSYSTerminalMgr Class)

Merchant's phone number.

Object Oriented Interface

public function getMerchantPhone();


public function setMerchantPhone($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 12 );


dpaymentssdk_tsysterminalmgr_set($res, 12, $value );

Default Value

''

Remarks

Merchant's phone number.

This property contains the Merchant's business phone number. This can be the same as the customer service phone number.

Data Type

String

MerchantServicePhone Property (DPaymentsSDK_TSYSTerminalMgr Class)

Merchant's customer service number.

Object Oriented Interface

public function getMerchantServicePhone();


public function setMerchantServicePhone($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 13 );


dpaymentssdk_tsysterminalmgr_set($res, 13, $value );

Default Value

''

Remarks

Merchant's customer service number.

This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

Data Type

String

MerchantState Property (DPaymentsSDK_TSYSTerminalMgr Class)

State or province that the merchant is located in.

Object Oriented Interface

public function getMerchantState();


public function setMerchantState($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 14 );


dpaymentssdk_tsysterminalmgr_set($res, 14, $value );

Default Value

''

Remarks

State or province that the merchant is located in.

This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.

This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.

Data Type

String

MerchantStoreNumber Property (DPaymentsSDK_TSYSTerminalMgr Class)

Used to identify a specific merchant's store within the VisaNet system.

Object Oriented Interface

public function getMerchantStoreNumber();


public function setMerchantStoreNumber($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 15 );


dpaymentssdk_tsysterminalmgr_set($res, 15, $value );

Default Value

''

Remarks

Used to identify a specific merchant's store within the VisaNet system.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.

Data Type

String

MerchantStreetAddress Property (DPaymentsSDK_TSYSTerminalMgr Class)

Merchant's street address.

Object Oriented Interface

public function getMerchantStreetAddress();


public function setMerchantStreetAddress($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 16 );


dpaymentssdk_tsysterminalmgr_set($res, 16, $value );

Default Value

''

Remarks

Merchant's street address.

This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_TSYSTerminalMgr Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();


public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 17 );


dpaymentssdk_tsysterminalmgr_set($res, 17, $value );

Default Value

''

Remarks

Used to identify a unique terminal within a merchant location.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.

Data Type

String

MerchantTimeZone Property (DPaymentsSDK_TSYSTerminalMgr Class)

Specifies the GMT offset used to calculate the local time within the VisaNet system.

Object Oriented Interface

public function getMerchantTimeZone();


public function setMerchantTimeZone($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 18 );


dpaymentssdk_tsysterminalmgr_set($res, 18, $value );

Default Value

'705'

Remarks

Specifies the GMT offset used to calculate the local time within the VisaNet system.

This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.

Byte #1:

If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.

Data Type

String

MerchantZip Property (DPaymentsSDK_TSYSTerminalMgr Class)

Zip code where the merchant that initiated this transaction is located.

Object Oriented Interface

public function getMerchantZip();


public function setMerchantZip($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 19 );


dpaymentssdk_tsysterminalmgr_set($res, 19, $value );

Default Value

''

Remarks

Zip code where the merchant that initiated this transaction is located.

This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.

This property is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

Contains an authorization code when a transaction has been approved.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 20 );

Default Value

''

Remarks

Contains an authorization code when a transaction has been approved.

This six character property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The ResponseApprovalCode must be stored and submitted in the settlement data capture record.

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

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_TSYSTerminalMgr Class)

Amount actually used from the card (used when supporting partial redemptions).

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 21 );

Default Value

''

Remarks

Amount actually used from the card (used when supporting partial redemptions).

The ResponseAuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then ResponseAuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.

For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the ResponseAuthorizedAmount will represent the approved amount of $7.50.In this case, the ResponseCode will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the ResponseAuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this property will be "0" or "".

If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.

This property is read-only.

Data Type

String

ResponseAuthSource Property (DPaymentsSDK_TSYSTerminalMgr Class)

Indicates the source of the authorization code stored in ApprovalCode .

Object Oriented Interface

public function getResponseAuthSource();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 22 );

Default Value

''

Remarks

Indicates the source of the authorization code stored in ResponseApprovalCode.

This property contains a one character code indicating the source of the ResponseApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:

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

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_TSYSTerminalMgr Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 23 );

Default Value

''

Remarks

Contains the Address Verification System result code.

This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:

*AVS Result Code for International addresses only

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

Data Type

String

ResponseCardLevel Property (DPaymentsSDK_TSYSTerminalMgr Class)

This property contains a two-character code created by Visa during the authorization process.

Object Oriented Interface

public function getResponseCardLevel();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 24 );

Default Value

''

Remarks

This property contains a two-character code created by Visa during the authorization process.

The current list of possible return values can be found in the table of contents.

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

Data Type

String

ResponseCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 25 );

Default Value

''

Remarks

Indicates the status of the authorization request.

This property contains a two character 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 "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. 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 and not available at design time.

Data Type

String

ResponseCommercialCardType Property (DPaymentsSDK_TSYSTerminalMgr Class)

Response property that indicates whether the card is a commercial card.

Object Oriented Interface

public function getResponseCommercialCardType();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 26 );

Default Value

0

Remarks

Response property that indicates whether the card is a commercial card.

If you wish to support Corporate Purchasing Cards with Level II or Level III data, you should inspect the value of this property after a successful authorization. If the Vital/TSYS host indicates that the authorized card is a commercial card, you may use the TSYSLevel2 or TSYSLevel3 classs to add the extra data required during settlement.

Possible values for this property include:

This property is only valid after a successful authorization request and response.

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

Data Type

Integer

ResponseCVVResult Property (DPaymentsSDK_TSYSTerminalMgr Class)

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 27 );

Default Value

''

Remarks

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an ResponseText indicating such. The following is a list of current result codes:

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

Data Type

String

ResponseRetrievalNumber Property (DPaymentsSDK_TSYSTerminalMgr 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_tsysterminalmgr_get($res, 28 );

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

ResponseReturnedACI Property (DPaymentsSDK_TSYSTerminalMgr Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 29 );

Default Value

''

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character property contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the ResponseTransactionId or ResponseValidationCode properties.

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

Data Type

String

ResponseText Property (DPaymentsSDK_TSYSTerminalMgr Class)

Text information that describes each response code.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_tsysterminalmgr_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_TSYSTerminalMgr Class)

Local transaction date returned from the server in MMddyy format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_tsysterminalmgr_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

ResponseTransactionId Property (DPaymentsSDK_TSYSTerminalMgr Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 32 );

Default Value

''

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) 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_TSYSTerminalMgr Class)

Check this property against the original Transaction Number.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 33 );

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

Local transaction time returned from the server in HHmmss format.

Object Oriented Interface

public function getResponseTransactionTime();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 34 );

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

ResponseValidationCode Property (DPaymentsSDK_TSYSTerminalMgr Class)

This optional property contains information generated by the card issuer.

Object Oriented Interface

public function getResponseValidationCode();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 35 );

Default Value

''

Remarks

This optional property contains information generated by the card issuer.

This optional four character property contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_TSYSTerminalMgr Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 37 );


dpaymentssdk_tsysterminalmgr_set($res, 37, $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_TSYSTerminalMgr Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 65 );


dpaymentssdk_tsysterminalmgr_set($res, 65, $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_TSYSTerminalMgr 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_tsysterminalmgr_get($res, 81 );


dpaymentssdk_tsysterminalmgr_set($res, 81, $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_TSYSTerminalMgr 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_tsysterminalmgr_get($res, 82 );


dpaymentssdk_tsysterminalmgr_set($res, 82, $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_TSYSTerminalMgr Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 83 );


dpaymentssdk_tsysterminalmgr_set($res, 83, $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_TSYSTerminalMgr 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_tsysterminalmgr_get($res, 84 );


dpaymentssdk_tsysterminalmgr_set($res, 84, $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_TSYSTerminalMgr Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 92 );


dpaymentssdk_tsysterminalmgr_set($res, 92, $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_TSYSTerminalMgr Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 94 );

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 121 );


dpaymentssdk_tsysterminalmgr_set($res, 121, $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

TransactionNumber Property (DPaymentsSDK_TSYSTerminalMgr Class)

Sequence number of this transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_tsysterminalmgr_get($res, 122 );


dpaymentssdk_tsysterminalmgr_set($res, 122, $value );

Default Value

0

Remarks

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. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

Data Type

Integer

AuthenticateDevice Method (DPaymentsSDK_TSYSTerminalMgr Class)

Authenticates a POS terminal.

Object Oriented Interface

public function doAuthenticateDevice();

Procedural Interface

dpaymentssdk_tsysterminalmgr_do_authenticatedevice($res);

Remarks

AuthenticateDevice authenticates a POS device with TSYS. After a device is authenticated GenKey will hold a unique value that should be included in all future transaction requests from the terminal. Before calling this method an AuthenticationCode must be obtained from TSYS.

The following Merchant properties are applicable when calling this method:

• MerchantBankId
• MerchantCategoryCode
• MerchantCountryCode
• MerchantCurrencyCode
• MerchantLanguage
• MerchantNumber
• MerchantServicePhone
• MerchantStoreNumber
• MerchantTerminalNumber
• MerchantTimeZone
• MerchantZip

• AuthenticationCode
• TransactionNumber
• DeviceCode
• IndustryType

After calling this method check ResponseCode to determine if the authentication succeeded. If the authentication succeeded ResponseCode will be "A1" and GenKey will be populated. If authentication failed ResponseCode will be "A2".

In addition to GenKey the following Response properties are populated:

• ResponseCode
• ResponseTransactionDate
• ResponseTransactionNumber
• ResponseTransactionTime
• ResponseAuthSource
• ResponseText

Config Method (DPaymentsSDK_TSYSTerminalMgr Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DeactivateDevice Method (DPaymentsSDK_TSYSTerminalMgr Class)

Deactivates a POS terminal.

Object Oriented Interface

public function doDeactivateDevice();

Procedural Interface

dpaymentssdk_tsysterminalmgr_do_deactivatedevice($res);

Remarks

DeactivateDevice is used to deactivate a previously activated terminal identified by GenKey.

The following Merchant properties are applicable when calling this method:

• MerchantBankId
• MerchantCategoryCode
• MerchantCountryCode
• MerchantCurrencyCode
• MerchantLanguage
• MerchantNumber
• MerchantServicePhone
• MerchantStoreNumber
• MerchantTerminalNumber
• MerchantTimeZone
• MerchantZip

• GenKey
• TransactionNumber
• DeviceCode
• IndustryType

After calling this method check ResponseCode and confirm it is "A3" to indicate the deactivation succeeded. The following Response properties are populated:

• ResponseCode
• ResponseTransactionDate
• ResponseTransactionNumber
• ResponseTransactionTime
• ResponseAuthSource
• ResponseText

DeactivateDevice Example: TSYSTerminalMgr1.Merchant.BankId = "999999"; TSYSTerminalMgr1.Merchant.CategoryCode = "9999"; TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT"; TSYSTerminalMgr1.Merchant.Number = "888000002447"; TSYSTerminalMgr1.Merchant.StoreNumber = "5999"; TSYSTerminalMgr1.Merchant.TerminalNumber = "1234"; TSYSTerminalMgr1.Merchant.Zip = "27516"; TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807"; TSYSTerminalMgr1.TransactionNumber = 1234; TSYSTerminalMgr1.GenKey = "MY_GEN_KEY"; TSYSTerminalMgr1.DeactivateDevice(); if (TSYSTerminalMgr1.Response.Code == "A3") //deactivated //...

Interrupt Method (DPaymentsSDK_TSYSTerminalMgr Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_tsysterminalmgr_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_TSYSTerminalMgr Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsysterminalmgr_do_reset($res);

Remarks

This method clears all properties to their default values.

Connected Event (DPaymentsSDK_TSYSTerminalMgr Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DataPacketIn Event (DPaymentsSDK_TSYSTerminalMgr Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 2, array($this, 'fireDataPacketIn'));

Parameter List

 'datapacket'

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (DPaymentsSDK_TSYSTerminalMgr Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 3, array($this, 'fireDataPacketOut'));

Parameter List

 'datapacket'

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (DPaymentsSDK_TSYSTerminalMgr Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.

Please refer to the Error Codes section for more information.

Error Event (DPaymentsSDK_TSYSTerminalMgr Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 5, 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_TSYSTerminalMgr Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 6, 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_TSYSTerminalMgr Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_tsysterminalmgr_register_callback($res, 7, 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 (TSYSTerminalMgr Class)

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

TSYSTerminalMgr Errors