TSYSHCTransactionDetails Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSHCTransactionDetails class is used to retrieve details about authorized transactions. This class makes retrieving transaction details very easy.

Class Name

DPaymentsSDK_TSYSHCTransactionDetails

Procedural Interface

 dpaymentssdk_tsyshctransactiondetails_open();
 dpaymentssdk_tsyshctransactiondetails_close($res);
 dpaymentssdk_tsyshctransactiondetails_register_callback($res, $id, $function);
 dpaymentssdk_tsyshctransactiondetails_get_last_error($res);
 dpaymentssdk_tsyshctransactiondetails_get_last_error_code($res);
 dpaymentssdk_tsyshctransactiondetails_set($res, $id, $index, $value);
 dpaymentssdk_tsyshctransactiondetails_get($res, $id, $index);
 dpaymentssdk_tsyshctransactiondetails_do_config($res, $configurationstring);
 dpaymentssdk_tsyshctransactiondetails_do_getdetails($res);
 dpaymentssdk_tsyshctransactiondetails_do_interrupt($res);
 dpaymentssdk_tsyshctransactiondetails_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 TSYSHCTransactionDetails class makes retrieving transaction details 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 retrieving transaction details are outlined below:

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

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

Next, set RetrievalNumber to the retrieval number of the transaction you wish to retrieve details about.

TSYSHCTransactionDetails1.RetrievalNumber = "125622902129"

Finally, submit the transaction by calling one the GetDetails method. The following code demonstrates retrieving transaction details:

TSYSHCTransactionDetails1.GetDetails()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved. The remaining properties provide additional information about the transaction.

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.

GenKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The unique GenKey value used to identify a POS device.

Object Oriented Interface

public function getGenKey();
public function setGenKey($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 1 );
dpaymentssdk_tsyshctransactiondetails_set($res, 1, $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

MerchantId Property (DPaymentsSDK_TSYSHCTransactionDetails 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_tsyshctransactiondetails_get($res, 2 );
dpaymentssdk_tsyshctransactiondetails_set($res, 2, $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

ResponseApprovalCode Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Contains an authorization code when a transaction has been approved.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 3 );

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

ResponseAVSResult Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 4 );

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

ResponseBatchNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

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

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 5 );

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

ResponseBatchResponseCode Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

This property contains the response code indicating the status of a batch management request.

Object Oriented Interface

public function getResponseBatchResponseCode();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 6 );

Default Value

''

Remarks

This property contains the response code indicating the status of a batch management 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 a successful request. All other response codes represent non-approved requests.

This property is read-only.

Data Type

String

ResponseBatchResponseText Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Text information that describes each response code.

Object Oriented Interface

public function getResponseBatchResponseText();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 7 );

Default Value

''

Remarks

Text information that describes each response code.

This property contains a 32-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.

Data Type

String

ResponseBatchStatus Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The current status of the batch in an inquiry.

Object Oriented Interface

public function getResponseBatchStatus();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 8 );

Default Value

''

Remarks

The current status of the batch in an inquiry.

A value of "O" indicates that the batch is still open. A value of "C" indicates that the batch has been closed and sent on to the settlement system.

This property is read-only.

Data Type

String

ResponseCardLast4 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The last four (4) digits of the customer card number.

Object Oriented Interface

public function getResponseCardLast4();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 9 );

Default Value

''

Remarks

The last four (4) digits of the customer card number.

This property is read-only.

Data Type

String

ResponseCardLevelResult Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

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

Object Oriented Interface

public function getResponseCardLevelResult();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 10 );

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

ResponseCardType Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The type of card sent in the authorization request.

Object Oriented Interface

public function getResponseCardType();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 11 );

Default Value

''

Remarks

The type of card sent in the authorization request.

Possible values are:

• CHECK
• VISA
• MASTERCARD
• AMEX
• DISCOVER
• JCB
• PRIVATE LABEL
• GIFT CARD
• DEBIT
• EBT

This property is read-only.

Data Type

String

ResponseCode Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 12 );

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

ResponseCVVResult Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 13 );

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

ResponseECI Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

A one-character transaction indicator identifying the type of direct marketing transaction being authorized.

Object Oriented Interface

public function getResponseECI();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 14 );

Default Value

''

Remarks

A one-character transaction indicator identifying the type of direct marketing transaction being authorized.

This property is read-only.

Data Type

String

ResponseGoodsIndicator Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The type of goods purchased over the Internet.

Object Oriented Interface

public function getResponseGoodsIndicator();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 15 );

Possible Values

TSYSHCTRANSACTIONDETAILS_RESPONSEGOODSINDICATOR_DO_NOT_SEND(0), 
TSYSHCTRANSACTIONDETAILS_RESPONSEGOODSINDICATOR_DIGITAL_GOODS(1), 
TSYSHCTRANSACTIONDETAILS_RESPONSEGOODSINDICATOR_PHYSICAL_GOODS(2)

Default Value

0

Remarks

The type of goods purchased over the Internet.

This property is read-only.

Data Type

Integer

ResponseGratuityAmount Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The gratuity (tip) amount of the transaction being settled.

Object Oriented Interface

public function getResponseGratuityAmount();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 16 );

Default Value

''

Remarks

The gratuity (tip) amount of the transaction being settled.

This property is read-only.

Data Type

String

ResponseInstallmentAdvice Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Contains the Merchant Advice Code returned by MasterCard MIP.

Object Oriented Interface

public function getResponseInstallmentAdvice();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 17 );

Possible Values

TSYSHCTRANSACTIONDETAILS_RESPONSEINSTALLMENTADVICE_NO_DATA_PRESENT(0), 
TSYSHCTRANSACTIONDETAILS_RESPONSEINSTALLMENTADVICE_NEW_ACCOUNT_INFO(1), 
TSYSHCTRANSACTIONDETAILS_RESPONSEINSTALLMENTADVICE_TRY_AGAIN_LATER(2), 
TSYSHCTRANSACTIONDETAILS_RESPONSEINSTALLMENTADVICE_DO_NOT_TRY_AGAIN(3), 
TSYSHCTRANSACTIONDETAILS_RESPONSEINSTALLMENTADVICE_CANCEL_RECURRING(4)

Default Value

0

Remarks

Contains the Merchant Advice Code returned by MasterCard MIP.

Possible values are:

This property is read-only.

Data Type

Integer

ResponseInvoiceNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The invoice number assigned by the merchant for a card-not-present purchase.

Object Oriented Interface

public function getResponseInvoiceNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 18 );

Default Value

''

Remarks

The invoice number assigned by the merchant for a card-not-present purchase.

This property is read-only.

Data Type

String

ResponseIsTaxExempt Property (DPaymentsSDK_TSYSHCTransactionDetails 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 getResponseIsTaxExempt();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 19 );

Default Value

false

Remarks

Identifies the characteristics of the amount appearing in ResponseTaxAmount 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 ResponseTaxAmount will be indicated as being Local Sales Tax.

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

This property is read-only.

Data Type

Boolean

ResponseNetworkId Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

This property contains the identification code of the network on which the transaction was authorized.

Object Oriented Interface

public function getResponseNetworkId();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 20 );

Default Value

''

Remarks

This field contains the identification code of the network on which the transaction was authorized. The Network ID must be printed on the receipt. The table below contains a listing of Network ID codes.

This property is read-only.

Data Type

String

ResponsePartialShipmentIndicator Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Indicates whether the merchant or acquirer is awaiting shipment of a portion of the goods purchased in a card transaction prior to submitting the related sales data.

Object Oriented Interface

public function getResponsePartialShipmentIndicator();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 21 );

Default Value

false

Remarks

Indicates whether the merchant or acquirer is awaiting shipment of a portion of the goods purchased in a card transaction prior to submitting the related sales data. This field is Discover only.

This property is read-only.

Data Type

Boolean

ResponsePurchaseId Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder.

Object Oriented Interface

public function getResponsePurchaseId();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 22 );

Default Value

''

Remarks

The Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder.

This property is read-only.

Data Type

String

ResponseRequestedACI Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

A one-character property containing the Requested ACI used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs.

Object Oriented Interface

public function getResponseRequestedACI();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 23 );

Default Value

''

Remarks

A one-character field containing the Requested ACI used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs.

Possible values are:

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The Retrieval Reference Number from the transaction.

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 24 );

Default Value

''

Remarks

The Retrieval Reference Number from the transaction.

This property is read-only.

Data Type

String

ResponseReturnedACI Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 25 );

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

ResponseSettlementAmount Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

This property contains the final settlement amount of the transaction.

Object Oriented Interface

public function getResponseSettlementAmount();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 26 );

Default Value

''

Remarks

This field contains the final settlement amount of the transaction. The decimal is implied.

This property is read-only.

Data Type

String

ResponseTaxAmount Property (DPaymentsSDK_TSYSHCTransactionDetails 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 getResponseTaxAmount();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 27 );

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.

This property is read-only.

Data Type

String

ResponseTrackStatusCode Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

This property is used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions.

Object Oriented Interface

public function getResponseTrackStatusCode();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 28 );

Default Value

''

Remarks

This field is used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions. The field is 2 characters in length.

The first character is the Track 1 data Indicator which indicates the condition of track 1 data in the request. Possible values are:

The second character is the Track 2 data Indicator which indicates the condition of track 2 data in the request. Possible values are:

This property is read-only.

Data Type

String

ResponseTransactionAmount Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The Transaction Amount from the transaction.

Object Oriented Interface

public function getResponseTransactionAmount();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 29 );

Default Value

''

Remarks

The Transaction Amount from the transaction.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Local transaction date returned from the server in MMddyy format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 30 );

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

ResponseTransactionFee Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Transaction Fee Amount is used in PIN POS transactions to carry the acquirer-assessed surcharge for informational purposes only.

Object Oriented Interface

public function getResponseTransactionFee();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 31 );

Default Value

''

Remarks

Transaction Fee Amount is used in PIN POS transactions to carry the acquirer-assessed surcharge for informational purposes only. This field can be zero length or nine alphanumeric characters in length. The format of the nine characters is "annnnnnnn" where "a" is either "D" for debit or "C" for credit and where "nnnnnnnn" is the numeric fee amount with the decimal implied. Example: "D00000150" is a $1.50 transaction fee amount for a debit transaction.

This property is read-only.

Data Type

String

ResponseTransactionNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

This is the Transaction Original Number (TON) from the transaction.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 32 );

Default Value

0

Remarks

This is the Transaction Original Number (TON) from the transaction.

This property is read-only.

Data Type

Integer

ResponseTransactionTime Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Local transaction time returned from the server in HHmmss format.

Object Oriented Interface

public function getResponseTransactionTime();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_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

ResponseTransactionType Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The original authorization transaction type.

Object Oriented Interface

public function getResponseTransactionType();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 34 );

Possible Values

TSYSHCTRANSACTIONDETAILS_RESPONSETRANSACTIONTYPE_UNKNOWN(0), 
TSYSHCTRANSACTIONDETAILS_RESPONSETRANSACTIONTYPE_SALE(1), 
TSYSHCTRANSACTIONDETAILS_RESPONSETRANSACTIONTYPE_CREDIT(2), 
TSYSHCTRANSACTIONDETAILS_RESPONSETRANSACTIONTYPE_FORCE(3)

Default Value

0

Remarks

The original authorization transaction type.

This field provides you with the transaction type of the original authorization request (regardless of any adjustments, voids, or reversals performed).

Possible values are:

This property is read-only.

Data Type

Integer

RetrievalNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

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

Object Oriented Interface

public function getRetrievalNumber();
public function setRetrievalNumber($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 35 );
dpaymentssdk_tsyshctransactiondetails_set($res, 35, $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_TSYSHCTransactionDetails Class)

The Routing ID assigned to the merchant by TSYS.

Object Oriented Interface

public function getRoutingId();
public function setRoutingId($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 36 );
dpaymentssdk_tsyshctransactiondetails_set($res, 36, $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

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 37 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 38 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 39 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 40 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 41 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 42 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 43 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 44 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 45 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 46 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 47 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 48 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 49 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 50 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 51 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 52 );
dpaymentssdk_tsyshctransactiondetails_set($res, 52, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (DPaymentsSDK_TSYSHCTransactionDetails 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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 53 );
dpaymentssdk_tsyshctransactiondetails_set($res, 53, $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

SSLAcceptServerCertStoreType Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 54 );
dpaymentssdk_tsyshctransactiondetails_set($res, 54, $value );

Possible Values

TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
TSYSHCTRANSACTIONDETAILS_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 55 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 56 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 57 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 58 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 59 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 60 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 61 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 62 );
dpaymentssdk_tsyshctransactiondetails_set($res, 62, $value );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 63 );
dpaymentssdk_tsyshctransactiondetails_set($res, 63, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 64 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 65 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 66 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 67 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 68 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 69 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 70 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 71 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 72 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 73 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 74 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 75 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 76 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 77 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 78 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 79 );
dpaymentssdk_tsyshctransactiondetails_set($res, 79, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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_TSYSHCTransactionDetails 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_tsyshctransactiondetails_get($res, 80 );
dpaymentssdk_tsyshctransactiondetails_set($res, 80, $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_TSYSHCTransactionDetails Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 81 );
dpaymentssdk_tsyshctransactiondetails_set($res, 81, $value );

Possible Values

TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_USER(0), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_MACHINE(1), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PFXFILE(2), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PFXBLOB(3), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_JKSFILE(4), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_JKSBLOB(5), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_P7BFILE(11), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_P7BBLOB(12), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PPKFILE(14), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PPKBLOB(15), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_XMLFILE(16), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_XMLBLOB(17), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_JWKFILE(18), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_JWKBLOB(19), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_SECURITY_KEY(20), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_BCFKSFILE(21), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_BCFKSBLOB(22), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_PKCS11(23), 
TSYSHCTRANSACTIONDETAILS_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 82 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 83 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 84 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 85 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 86 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 87 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 88 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 89 );
dpaymentssdk_tsyshctransactiondetails_set($res, 89, $value );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 90 );
dpaymentssdk_tsyshctransactiondetails_set($res, 90, $value );

Default Value

''

Remarks

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

SSLProvider Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 91 );
dpaymentssdk_tsyshctransactiondetails_set($res, 91, $value );

Possible Values

TSYSHCTRANSACTIONDETAILS_SSLPROVIDER_AUTOMATIC(0), 
TSYSHCTRANSACTIONDETAILS_SSLPROVIDER_PLATFORM(1), 
TSYSHCTRANSACTIONDETAILS_SSLPROVIDER_INTERNAL(2)

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 as follows:

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

SSLServerCertEffectiveDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 92 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 93 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 94 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 95 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 96 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 97 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 98 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 99 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 100 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 101 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 102 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 103 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 104 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 105 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 106 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 107 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (DPaymentsSDK_TSYSHCTransactionDetails 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 getSSLServerCertStorePassword();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 108 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 109 );

Possible Values

TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_USER(0), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_MACHINE(1), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_PKCS11(23), 
TSYSHCTRANSACTIONDETAILS_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 110 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 111 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 112 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 113 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 114 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 115 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 116 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 117 );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (DPaymentsSDK_TSYSHCTransactionDetails Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 118 );

Default Value

''

Remarks

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 119 );
dpaymentssdk_tsyshctransactiondetails_set($res, 119, $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_TSYSHCTransactionDetails Class)

Sequence number of this transaction.

Object Oriented Interface

public function getTransactionNumber();
public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_get($res, 120 );
dpaymentssdk_tsyshctransactiondetails_set($res, 120, $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

Config Method (DPaymentsSDK_TSYSHCTransactionDetails Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetDetails Method (DPaymentsSDK_TSYSHCTransactionDetails Class)

Sends a transaction detail inquiry request.

Object Oriented Interface

public function doGetDetails();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_do_getdetails($res);

Remarks

This method allows you to retrieve details for the transaction specified by RetrievalNumber or TransactionNumber. The transaction details can be retrieved via Response.

Minimum required properties:

• GenKey
• MerchantId
• RoutingId
• RetrievalNumber or TransactionNumber

Note: RetrievalNumber is used by default. However if you set RetrievalNumber to "" (empty string), the specified TransactionNumber will be used instead.

Interrupt Method (DPaymentsSDK_TSYSHCTransactionDetails Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_TSYSHCTransactionDetails Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_TSYSHCTransactionDetails Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_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_TSYSHCTransactionDetails Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_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_TSYSHCTransactionDetails Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_tsyshctransactiondetails_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 (TSYSHCTransactionDetails Class)

TSYSHCTransactionDetails Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (TSYSHCTransactionDetails Class)

TSYSHCTransactionDetails Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors