TSYSHCECommerce Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSHCECommerce class is used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This class makes authorizing these types of transactions very easy.

Class Name

DPaymentsSDK_TSYSHCECommerce

Procedural Interface

 dpaymentssdk_tsyshcecommerce_open();
 dpaymentssdk_tsyshcecommerce_close($res);
 dpaymentssdk_tsyshcecommerce_register_callback($res, $id, $function);
 dpaymentssdk_tsyshcecommerce_get_last_error($res);
 dpaymentssdk_tsyshcecommerce_get_last_error_code($res);
 dpaymentssdk_tsyshcecommerce_set($res, $id, $index, $value);
 dpaymentssdk_tsyshcecommerce_get($res, $id, $index);
 dpaymentssdk_tsyshcecommerce_do_adjusttip($res, $retrievalnumber, $originalamount, $tipamount);
 dpaymentssdk_tsyshcecommerce_do_authenticatecard($res);
 dpaymentssdk_tsyshcecommerce_do_billpayment($res);
 dpaymentssdk_tsyshcecommerce_do_config($res, $configurationstring);
 dpaymentssdk_tsyshcecommerce_do_credit($res);
 dpaymentssdk_tsyshcecommerce_do_force($res, $approvalcode, $transactiondate, $transactiontime);
 dpaymentssdk_tsyshcecommerce_do_interrupt($res);
 dpaymentssdk_tsyshcecommerce_do_reset($res);
 dpaymentssdk_tsyshcecommerce_do_sale($res);
 dpaymentssdk_tsyshcecommerce_do_voidtransaction($res, $retrievalnumber, $originalamount);

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 TSYSHCECommerce class makes authorizing Card-Not-Present Mail Order and E-Commerce transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

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

 
 Copy
  TSYSHCECommerce1.GenKey = "gen_key_value"
  TSYSHCECommerce1.MerchantId = "merchant_id"
  TSYSHCECommerce1.RoutingId = "routing_id"

Then, set the customer's credit card information, as well as his address and zip code (the address and zip code will be checked by the Vital/TSYS servers to make sure it matches the customer's billing address).

 
 Copy
  TSYSHCECommerce1.CardNumber = "4444333322221111"
  TSYSHCECommerce1.CardExpMonth = 1
  TSYSHCECommerce1.CardExpYear = 2013
  TSYSHCECommerce1.CardCVVData = "999"
  TSYSHCECommerce1.CustomerAddress = "8320 South Hardy Dr."
  TSYSHCECommerce1.CustomerZip = "85284"  

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount and TransactionNumber. However, you may also set the TransactionType if you are doing a Mail Order or Recurring transaction.

 
 Copy
  TSYSHCECommerce1.TransactionNumber = 1
  TSYSHCECommerce1.TransactionAmount = "100"
  TSYSHCECommerce1.TransactionType = ttECommerce

Finally, submit the transaction by calling one of four authorization methods. Sale, Credit, AuthenticateCard or BalanceInquiry. The following code demonstrates a purchase:

 
 Copy
  TSYSHCECommerce1.Sale()

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, and the remaining properties provide additional information about the transaction.

Once a credit card Sale or Credit is approved and is added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr class.

Note: The TSYSHCECommerce class can be used to pass 3D-Secure and MasterCard SecureCode authentication data in an authorization to achieve a better interchange rate. To send this data, the ECI, XID and CAVV (3D-Secure), UCAFCollectionIndicator, UCAFSecurityIndicator and UCAFData (MasterCard SecureCode) configuration variables must be set before calling Sale. The CAVV and UCAF authentication result code will be returned in the ResponseCAVV and ResponseUCAF configuration settings, respectively. For Mastercard Identity Check transactions you must set the ProgramProtocol and DirectoryServerTxnID configs.

Property List

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

Method List

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

Event List

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

Config Settings

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

CaptureMode Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getCaptureMode();
public function setCaptureMode($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 1 );
dpaymentssdk_tsyshcecommerce_set($res, 1, $value );

Possible Values

TSYSHCECOMMERCE_CAPTUREMODE_NORMAL(0), 
TSYSHCECOMMERCE_CAPTUREMODE_DELAY(1), 
TSYSHCECOMMERCE_CAPTUREMODE_HOLD(2), 
TSYSHCECOMMERCE_CAPTUREMODE_CAPTURE(3)

Default Value

0

Remarks

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

Possible values are:

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

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

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

Data Type

Integer

CardType Property (DPaymentsSDK_TSYSHCECommerce Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();
public function setCardType($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 2 );
dpaymentssdk_tsyshcecommerce_set($res, 2, $value );

Possible Values

TSYSHCECOMMERCE_CARDTYPE_UNKNOWN(0), 
TSYSHCECOMMERCE_CARDTYPE_VISA(1), 
TSYSHCECOMMERCE_CARDTYPE_MASTER_CARD(2), 
TSYSHCECOMMERCE_CARDTYPE_AMEX(3), 
TSYSHCECOMMERCE_CARDTYPE_DISCOVER(4), 
TSYSHCECOMMERCE_CARDTYPE_DINERS(5), 
TSYSHCECOMMERCE_CARDTYPE_JCB(6), 
TSYSHCECOMMERCE_CARDTYPE_VISA_ELECTRON(7), 
TSYSHCECOMMERCE_CARDTYPE_MAESTRO(8), 
TSYSHCECOMMERCE_CARDTYPE_LASER(10)

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getCardCVVData();
public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 3 );
dpaymentssdk_tsyshcecommerce_set($res, 3, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_TSYSHCECommerce Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();
public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 4 );
dpaymentssdk_tsyshcecommerce_set($res, 4, $value );

Possible Values

TSYSHCECOMMERCE_CARDCVVPRESENCE_NOT_PROVIDED(0), 
TSYSHCECOMMERCE_CARDCVVPRESENCE_PROVIDED(1), 
TSYSHCECOMMERCE_CARDCVVPRESENCE_ILLEGIBLE(2), 
TSYSHCECOMMERCE_CARDCVVPRESENCE_NOT_ON_CARD(3)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getCardEntryDataSource();
public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 5 );
dpaymentssdk_tsyshcecommerce_set($res, 5, $value );

Possible Values

TSYSHCECOMMERCE_CARDENTRYDATASOURCE_TRACK_1(0), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_TRACK_2(1), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_NO_CARD_READER(4), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_TRACK_1CONTACTLESS(5), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_TRACK_2CONTACTLESS(6), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_IVR(8), 
TSYSHCECOMMERCE_CARDENTRYDATASOURCE_KIOSK(9)

Default Value

0

Remarks

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

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_TSYSHCECommerce Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();
public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 6 );
dpaymentssdk_tsyshcecommerce_set($res, 6, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_TSYSHCECommerce Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();
public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 7 );
dpaymentssdk_tsyshcecommerce_set($res, 7, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getCardIsEncrypted();
public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 8 );
dpaymentssdk_tsyshcecommerce_set($res, 8, $value );

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getCardMagneticStripe();
public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 9 );
dpaymentssdk_tsyshcecommerce_set($res, 9, $value );

Default Value

''

Remarks

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

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

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

 
 Copy
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1

or

class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2

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

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_TSYSHCECommerce Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();
public function setCardNumber($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 10 );
dpaymentssdk_tsyshcecommerce_set($res, 10, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

ClearingSequenceCount Property (DPaymentsSDK_TSYSHCECommerce Class)

The total number of installment payments.

Object Oriented Interface

public function getClearingSequenceCount();
public function setClearingSequenceCount($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 11 );
dpaymentssdk_tsyshcecommerce_set($res, 11, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

ClearingSequenceNumber Property (DPaymentsSDK_TSYSHCECommerce Class)

The payment number of the total number of installment payments.

Object Oriented Interface

public function getClearingSequenceNumber();
public function setClearingSequenceNumber($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 12 );
dpaymentssdk_tsyshcecommerce_set($res, 12, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

CustomerAddress Property (DPaymentsSDK_TSYSHCECommerce Class)

The customer's billing address.

Object Oriented Interface

public function getCustomerAddress();
public function setCustomerAddress($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 13 );
dpaymentssdk_tsyshcecommerce_set($res, 13, $value );

Default Value

''

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.

Per TSYS specs, the following rules apply:

• In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
• There must be a (space) between two consecutive data elements that are only numeric.

Note the following examples:

• "1234 56th Street" is equivalent to: "1234 56Street"
• "1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
• "1391 ELM STREET" is equivalent to: "1391ELMSTREET"
• "P.O. BOX 24356" is equivalent to: "POBOX24356"

The length of this property is 19 characters, and any string longer than this fails with an error. If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

Data Type

String

CustomerZip Property (DPaymentsSDK_TSYSHCECommerce Class)

Customer's zip code (or postal code if outside of the USA).

Object Oriented Interface

public function getCustomerZip();
public function setCustomerZip($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 14 );
dpaymentssdk_tsyshcecommerce_set($res, 14, $value );

Default Value

''

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

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

Data Type

String

GenKey Property (DPaymentsSDK_TSYSHCECommerce Class)

The unique GenKey value used to identify a POS device.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 15 );
dpaymentssdk_tsyshcecommerce_set($res, 15, $value );

Default Value

''

Remarks

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

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

Data Type

String

GoodsIndicator Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getGoodsIndicator();
public function setGoodsIndicator($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 16 );
dpaymentssdk_tsyshcecommerce_set($res, 16, $value );

Possible Values

TSYSHCECOMMERCE_GOODSINDICATOR_NOT_USED(0), 
TSYSHCECOMMERCE_GOODSINDICATOR_DIGITAL_GOODS(1), 
TSYSHCECOMMERCE_GOODSINDICATOR_PHYSICAL_GOODS(2)

Default Value

0

Remarks

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

Data Type

Integer

GratuityAmount Property (DPaymentsSDK_TSYSHCECommerce Class)

The gratuity (tip) amount of the transaction.

Object Oriented Interface

public function getGratuityAmount();
public function setGratuityAmount($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 17 );
dpaymentssdk_tsyshcecommerce_set($res, 17, $value );

Default Value

''

Remarks

This property is used to specify the gratuity (tip) amount when performing an authorization via Authorize.

Data Type

String

InvoiceNumber Property (DPaymentsSDK_TSYSHCECommerce Class)

Invoice number for the purchase.

Object Oriented Interface

public function getInvoiceNumber();
public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 18 );
dpaymentssdk_tsyshcecommerce_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

Level2AmexChargeDescriptor Property (DPaymentsSDK_TSYSHCECommerce Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor();
public function setLevel2AmexChargeDescriptor($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 19 );
dpaymentssdk_tsyshcecommerce_set($res, 19, $value );

Default Value

''

Remarks

Description of this transaction.

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

Data Type

String

Level2AmexChargeDescriptor2 Property (DPaymentsSDK_TSYSHCECommerce Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor2();
public function setLevel2AmexChargeDescriptor2($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 20 );
dpaymentssdk_tsyshcecommerce_set($res, 20, $value );

Default Value

''

Remarks

Description of this transaction.

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

Data Type

String

Level2AmexChargeDescriptor3 Property (DPaymentsSDK_TSYSHCECommerce Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor3();
public function setLevel2AmexChargeDescriptor3($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 21 );
dpaymentssdk_tsyshcecommerce_set($res, 21, $value );

Default Value

''

Remarks

Description of this transaction.

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

Data Type

String

Level2AmexChargeDescriptor4 Property (DPaymentsSDK_TSYSHCECommerce Class)

Description of this transaction.

Object Oriented Interface

public function getLevel2AmexChargeDescriptor4();
public function setLevel2AmexChargeDescriptor4($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 22 );
dpaymentssdk_tsyshcecommerce_set($res, 22, $value );

Default Value

''

Remarks

Description of this transaction.

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

Data Type

String

Level2AmexRequesterName Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getLevel2AmexRequesterName();
public function setLevel2AmexRequesterName($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 23 );
dpaymentssdk_tsyshcecommerce_set($res, 23, $value );

Default Value

''

Remarks

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

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

The maximum length for this field is 38 characters.

Data Type

String

Level2AmexShippedToZip Property (DPaymentsSDK_TSYSHCECommerce Class)

The zip code to which the commodity was shipped.

Object Oriented Interface

public function getLevel2AmexShippedToZip();
public function setLevel2AmexShippedToZip($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 24 );
dpaymentssdk_tsyshcecommerce_set($res, 24, $value );

Default Value

''

Remarks

The zip code to which the commodity was shipped.

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place. This is only used when sending Level II data for an American Express purchasing card.

The maximum length for this property is 6 characters.

Data Type

String

Level2IsTaxExempt Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getLevel2IsTaxExempt();
public function setLevel2IsTaxExempt($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 25 );
dpaymentssdk_tsyshcecommerce_set($res, 25, $value );

Default Value

false

Remarks

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

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

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

Data Type

Boolean

Level2PurchaseOrderNumber Property (DPaymentsSDK_TSYSHCECommerce Class)

Optional customer-specified purchase order number.

Object Oriented Interface

public function getLevel2PurchaseOrderNumber();
public function setLevel2PurchaseOrderNumber($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 26 );
dpaymentssdk_tsyshcecommerce_set($res, 26, $value );

Default Value

''

Remarks

Optional customer-specified purchase order number.

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

Data Type

String

Level2TaxAmount Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getLevel2TaxAmount();
public function setLevel2TaxAmount($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 27 );
dpaymentssdk_tsyshcecommerce_set($res, 27, $value );

Default Value

''

Remarks

Sales tax charged in addition to the original TransactionAmount

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

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

MerchantCategoryCode Property (DPaymentsSDK_TSYSHCECommerce Class)

Classifies a merchant by the type of store.

Object Oriented Interface

public function getMerchantCategoryCode();
public function setMerchantCategoryCode($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 28 );
dpaymentssdk_tsyshcecommerce_set($res, 28, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantId Property (DPaymentsSDK_TSYSHCECommerce 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_tsyshcecommerce_get($res, 29 );
dpaymentssdk_tsyshcecommerce_set($res, 29, $value );

Default Value

''

Remarks

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

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

Data Type

String

RepeatIndicator Property (DPaymentsSDK_TSYSHCECommerce Class)

Indicates whether a transaction is a repeat of a previous transaction attempt.

Object Oriented Interface

public function getRepeatIndicator();
public function setRepeatIndicator($value);

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 30 );
dpaymentssdk_tsyshcecommerce_set($res, 30, $value );

Default Value

false

Remarks

This property allows you to specify whether a transaction is a repeat of a previous transaction attempt.

If a timeout exception occurs, such as the host capture system not receiving the request or the response not being received from the host capture system, you can set RepeatIndicator to true and resend the request using the original transaction details. In the case that the host capture system received the original transaction, it has already been logged and will respond with existing Response details. In the case that the host capture system did not receive the original transaction, it will process the request normally.

Note: Repeat transactions are not allowed for gift card and debit transactions.

Data Type

Boolean

ResponseApprovalCode Property (DPaymentsSDK_TSYSHCECommerce Class)

Contains an authorization code when a transaction has been approved.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 31 );

Default Value

''

Remarks

Contains an authorization code when a transaction has been approved.

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

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

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_TSYSHCECommerce Class)

The partial authorized amount.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 32 );

Default Value

''

Remarks

The partial authorized amount.

This property will be populated with the partial authorized amount. If the transaction is not a partial authorization, this property will be "" (empty string).

This property is read-only.

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_TSYSHCECommerce Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 33 );

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

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

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 34 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

ResponseCardType Property (DPaymentsSDK_TSYSHCECommerce Class)

The type of card sent in the authorization request.

Object Oriented Interface

public function getResponseCardType();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 35 );

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

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 36 );

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

ResponseCommercialCardType Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getResponseCommercialCardType();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 37 );

Possible Values

TSYSHCECOMMERCE_RESPONSECOMMERCIALCARDTYPE_NOT_COMMERCIAL(0), 
TSYSHCECOMMERCE_RESPONSECOMMERCIALCARDTYPE_BUSINESS_CARD(1), 
TSYSHCECOMMERCE_RESPONSECOMMERCIALCARDTYPE_VISA_COMMERCE(2), 
TSYSHCECOMMERCE_RESPONSECOMMERCIALCARDTYPE_CORPORATE_CARD(3), 
TSYSHCECOMMERCE_RESPONSECOMMERCIALCARDTYPE_PURCHASE_CARD(4)

Default Value

0

Remarks

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

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

Possible values for this property include:

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

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

Data Type

Integer

ResponseCVVResult Property (DPaymentsSDK_TSYSHCECommerce Class)

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 38 );

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

ResponseInstallmentAdvice Property (DPaymentsSDK_TSYSHCECommerce Class)

Contains the Merchant Advice Code returned by MasterCard MIP.

Object Oriented Interface

public function getResponseInstallmentAdvice();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 39 );

Possible Values

TSYSHCECOMMERCE_RESPONSEINSTALLMENTADVICE_NO_DATA_PRESENT(0), 
TSYSHCECOMMERCE_RESPONSEINSTALLMENTADVICE_NEW_ACCOUNT_INFO(1), 
TSYSHCECOMMERCE_RESPONSEINSTALLMENTADVICE_TRY_AGAIN_LATER(2), 
TSYSHCECOMMERCE_RESPONSEINSTALLMENTADVICE_DO_NOT_TRY_AGAIN(3), 
TSYSHCECOMMERCE_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

ResponseRetrievalNumber Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 40 );

Default Value

''

Remarks

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

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

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

Data Type

String

ResponseReturnedACI Property (DPaymentsSDK_TSYSHCECommerce Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 41 );

Default Value

''

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

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

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

Data Type

String

ResponseText Property (DPaymentsSDK_TSYSHCECommerce Class)

Text information that describes each response code.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 42 );

Default Value

''

Remarks

Text information that describes each response code.

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

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

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

Data Type

String

ResponseTransactionDate Property (DPaymentsSDK_TSYSHCECommerce Class)

Local transaction date returned from the server in MMddyy format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 43 );

Default Value

''

Remarks

Local transaction date returned from the server in MMddyy format.

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

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

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_TSYSHCECommerce Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 44 );

Default Value

''

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and submitted in the Batch Settlement.

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

Data Type

String

ResponseTransactionNumber Property (DPaymentsSDK_TSYSHCECommerce Class)

Check this property against the original Transaction Number.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 45 );

Default Value

''

Remarks

Check this property against the original Transaction Number.

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

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

Data Type

String

ResponseTransactionTime Property (DPaymentsSDK_TSYSHCECommerce Class)

Local transaction time returned from the server in HHmmss format.

Object Oriented Interface

public function getResponseTransactionTime();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 46 );

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

RoutingId Property (DPaymentsSDK_TSYSHCECommerce Class)

The Routing ID assigned to the merchant by TSYS.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 47 );
dpaymentssdk_tsyshcecommerce_set($res, 47, $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_TSYSHCECommerce Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 48 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 49 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 50 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 51 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 52 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 53 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 54 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 55 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 56 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 57 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 58 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 59 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 60 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 61 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 62 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 63 );
dpaymentssdk_tsyshcecommerce_set($res, 63, $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_TSYSHCECommerce 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_tsyshcecommerce_get($res, 64 );
dpaymentssdk_tsyshcecommerce_set($res, 64, $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_TSYSHCECommerce Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 65 );
dpaymentssdk_tsyshcecommerce_set($res, 65, $value );

Possible Values

TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
TSYSHCECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
TSYSHCECOMMERCE_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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 66 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_TSYSHCECommerce Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 67 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 68 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 69 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 70 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 71 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 72 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 73 );
dpaymentssdk_tsyshcecommerce_set($res, 73, $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_TSYSHCECommerce Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 74 );
dpaymentssdk_tsyshcecommerce_set($res, 74, $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_TSYSHCECommerce Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 75 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 76 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 77 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 78 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 79 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 80 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 81 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 82 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 83 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 84 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 85 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 86 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 87 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 88 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 89 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 90 );
dpaymentssdk_tsyshcecommerce_set($res, 90, $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_TSYSHCECommerce 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_tsyshcecommerce_get($res, 91 );
dpaymentssdk_tsyshcecommerce_set($res, 91, $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_TSYSHCECommerce Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 92 );
dpaymentssdk_tsyshcecommerce_set($res, 92, $value );

Possible Values

TSYSHCECOMMERCE_SSLCERTSTORETYPE_USER(0), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_MACHINE(1), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PFXFILE(2), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PFXBLOB(3), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_JKSFILE(4), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_JKSBLOB(5), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_P7BFILE(11), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_P7BBLOB(12), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PPKFILE(14), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PPKBLOB(15), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_XMLFILE(16), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_XMLBLOB(17), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_JWKFILE(18), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_JWKBLOB(19), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_SECURITY_KEY(20), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_BCFKSFILE(21), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_BCFKSBLOB(22), 
TSYSHCECOMMERCE_SSLCERTSTORETYPE_PKCS11(23), 
TSYSHCECOMMERCE_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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLCertSubjectAltNames Property (DPaymentsSDK_TSYSHCECommerce Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 93 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_TSYSHCECommerce Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 94 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 95 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 96 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 97 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 98 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 99 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 100 );
dpaymentssdk_tsyshcecommerce_set($res, 100, $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_TSYSHCECommerce Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 101 );
dpaymentssdk_tsyshcecommerce_set($res, 101, $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_TSYSHCECommerce 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_tsyshcecommerce_get($res, 102 );
dpaymentssdk_tsyshcecommerce_set($res, 102, $value );

Possible Values

TSYSHCECOMMERCE_SSLPROVIDER_AUTOMATIC(0), 
TSYSHCECOMMERCE_SSLPROVIDER_PLATFORM(1), 
TSYSHCECOMMERCE_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_TSYSHCECommerce Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 103 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 104 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 105 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 106 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 107 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 108 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 109 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 110 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 111 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 112 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 113 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 114 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 115 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 116 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 117 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 118 );

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_TSYSHCECommerce 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_tsyshcecommerce_get($res, 119 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_tsyshcecommerce_get($res, 120 );

Possible Values

TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_USER(0), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_MACHINE(1), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_PKCS11(23), 
TSYSHCECOMMERCE_SSLSERVERCERTSTORETYPE_AUTO(99)