TSYSECommerce Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSECommerce class is an advanced tool 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_TSYSECommerce

Procedural Interface

 dpaymentssdk_tsysecommerce_open();
 dpaymentssdk_tsysecommerce_close($res);
 dpaymentssdk_tsysecommerce_register_callback($res, $id, $function);
 dpaymentssdk_tsysecommerce_get_last_error($res);
 dpaymentssdk_tsysecommerce_get_last_error_code($res);
 dpaymentssdk_tsysecommerce_set($res, $id, $index, $value);
 dpaymentssdk_tsysecommerce_get($res, $id, $index);
 dpaymentssdk_tsysecommerce_do_authenticatecard($res);
 dpaymentssdk_tsysecommerce_do_authorize($res);
 dpaymentssdk_tsysecommerce_do_config($res, $configurationstring);
 dpaymentssdk_tsysecommerce_do_getdetailaggregate($res);
 dpaymentssdk_tsysecommerce_do_interrupt($res);
 dpaymentssdk_tsysecommerce_do_reset($res);

Remarks

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

The TSYSECommerce 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 properties with setup information acquired from your member bank or processor. For instance:

class.MerchantBankId = "999995" '(BIN number) class.MerchantCategoryCode = "5999" class.MerchantName = "test merchant" class.MerchantNumber = "123456789012" class.MerchantServiceNumber = "800-1234567" class.MerchantState = "CA" class.MerchantStoreNumber = "5999" class.MerchantTerminalNumber = "1515" class.MerchantZip = "90210"

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

class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2009 class.CardCVVData = "999" class.CustomerAddress = "8320 South Hardy Dr." class.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.

class.TransactionAmount = "100" class.TransactionNumber = 1 class.TransactionType = ttECommerce

Finally, submit the transaction by calling the Authorize method. 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 ResponseAVSResult indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

Note: The TSYSECommerce 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), UCAFIndicator, UCAFSecurityIndicator and UCAFData (MasterCard SecureCode) configuration variables must be set before calling Authorize. 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.

Further Note: When sending e-commerce transactions, you must send a PurchaseIdentifier (sometimes referred to as Invoice Number) in the settlement. This can be done via the PurchaseIdentifier property of the TSYSDetailRecord class. Failure to set a PurchaseIdentifier for the e-commerce Industry Type may result in a CPS downgrade when the transaction is settled, and can cause higher interchange rates.

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.

CardType Property (DPaymentsSDK_TSYSECommerce Class)

Type of credit card being used in this transaction.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 1 );
dpaymentssdk_tsysecommerce_set($res, 1, $value );

Possible Values

TSYSECOMMERCE_CARDTYPE_UNKNOWN(0), 
TSYSECOMMERCE_CARDTYPE_VISA(1), 
TSYSECOMMERCE_CARDTYPE_MASTER_CARD(2), 
TSYSECOMMERCE_CARDTYPE_AMEX(3), 
TSYSECOMMERCE_CARDTYPE_DISCOVER(4), 
TSYSECOMMERCE_CARDTYPE_DINERS(5), 
TSYSECOMMERCE_CARDTYPE_JCB(6), 
TSYSECOMMERCE_CARDTYPE_VISA_ELECTRON(7), 
TSYSECOMMERCE_CARDTYPE_MAESTRO(8), 
TSYSECOMMERCE_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_TSYSECommerce Class)

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

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 2 );
dpaymentssdk_tsysecommerce_set($res, 2, $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_TSYSECommerce Class)

Indicates the presence of the card verification value.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 3 );
dpaymentssdk_tsysecommerce_set($res, 3, $value );

Possible Values

TSYSECOMMERCE_CARDCVVPRESENCE_NOT_PROVIDED(0), 
TSYSECOMMERCE_CARDCVVPRESENCE_PROVIDED(1), 
TSYSECOMMERCE_CARDCVVPRESENCE_ILLEGIBLE(2), 
TSYSECOMMERCE_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_TSYSECommerce 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_tsysecommerce_get($res, 4 );
dpaymentssdk_tsysecommerce_set($res, 4, $value );

Possible Values

TSYSECOMMERCE_CARDENTRYDATASOURCE_TRACK_1(0), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_TRACK_2(1), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_NO_CARD_READER(4), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_TRACK_1CONTACTLESS(5), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_TRACK_2CONTACTLESS(6), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
TSYSECOMMERCE_CARDENTRYDATASOURCE_IVR(8), 
TSYSECOMMERCE_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_TSYSECommerce Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 5 );
dpaymentssdk_tsysecommerce_set($res, 5, $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_TSYSECommerce Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 6 );
dpaymentssdk_tsysecommerce_set($res, 6, $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_TSYSECommerce 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_tsysecommerce_get($res, 7 );
dpaymentssdk_tsysecommerce_set($res, 7, $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_TSYSECommerce Class)

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

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 8 );
dpaymentssdk_tsysecommerce_set($res, 8, $value );

Default Value

''

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_TSYSECommerce Class)

Customer's credit card number for the transaction.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 9 );
dpaymentssdk_tsysecommerce_set($res, 9, $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

CustomerAddress Property (DPaymentsSDK_TSYSECommerce Class)

The customer's billing address.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 10 );
dpaymentssdk_tsysecommerce_set($res, 10, $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.

In order to maximize the address information included in the request, it is suggested that you strip out the spaces (when possible) and punctuations before setting the property.

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_TSYSECommerce 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_tsysecommerce_get($res, 11 );
dpaymentssdk_tsysecommerce_set($res, 11, $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

GoodsIndicator Property (DPaymentsSDK_TSYSECommerce 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_tsysecommerce_get($res, 12 );
dpaymentssdk_tsysecommerce_set($res, 12, $value );

Possible Values

TSYSECOMMERCE_GOODSINDICATOR_NOT_USED(0), 
TSYSECOMMERCE_GOODSINDICATOR_DIGITAL_GOODS(1), 
TSYSECOMMERCE_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.

Note: This property is not actually used in the authorization, but will be contained in the aggregate returned from the GetDetailAggregate method. This property is only valid if the TransactionType is set to ttECommerce.

Data Type

Integer

MerchantBankId Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getMerchantBankId();
public function setMerchantBankId($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 13 );
dpaymentssdk_tsysecommerce_set($res, 13, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

MerchantCategoryCode Property (DPaymentsSDK_TSYSECommerce Class)

Classifies a merchant by the type of store.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 14 );
dpaymentssdk_tsysecommerce_set($res, 14, $value );

Default Value

''

Remarks

Classifies a merchant by the type of store.

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

Data Type

String

MerchantCity Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getMerchantCity();
public function setMerchantCity($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 15 );
dpaymentssdk_tsysecommerce_set($res, 15, $value );

Default Value

''

Remarks

Merchant's City

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

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

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

Data Type

String

MerchantCountryCode Property (DPaymentsSDK_TSYSECommerce Class)

Identifies the country where the merchant is located.

Object Oriented Interface

public function getMerchantCountryCode();
public function setMerchantCountryCode($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 16 );
dpaymentssdk_tsysecommerce_set($res, 16, $value );

Default Value

'840'

Remarks

Identifies the country where the merchant is located.

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

Data Type

String

MerchantCurrencyCode Property (DPaymentsSDK_TSYSECommerce Class)

Identifies the type of currency used by the merchant.

Object Oriented Interface

public function getMerchantCurrencyCode();
public function setMerchantCurrencyCode($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 17 );
dpaymentssdk_tsysecommerce_set($res, 17, $value );

Default Value

'840'

Remarks

Identifies the type of currency used by the merchant.

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

Data Type

String

MerchantLanguage Property (DPaymentsSDK_TSYSECommerce Class)

Designates the language that response messages will be returned in.

Object Oriented Interface

public function getMerchantLanguage();
public function setMerchantLanguage($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 18 );
dpaymentssdk_tsysecommerce_set($res, 18, $value );

Default Value

'00'

Remarks

Designates the language that response messages will be returned in.

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

Data Type

String

MerchantName Property (DPaymentsSDK_TSYSECommerce Class)

Name of the merchant.

Object Oriented Interface

public function getMerchantName();
public function setMerchantName($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 19 );
dpaymentssdk_tsysecommerce_set($res, 19, $value );

Default Value

''

Remarks

Name of the merchant.

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

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

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

Data Type

String

MerchantNumber Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getMerchantNumber();
public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 20 );
dpaymentssdk_tsysecommerce_set($res, 20, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

MerchantPhone Property (DPaymentsSDK_TSYSECommerce Class)

Merchant's phone number.

Object Oriented Interface

public function getMerchantPhone();
public function setMerchantPhone($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 21 );
dpaymentssdk_tsysecommerce_set($res, 21, $value );

Default Value

''

Remarks

Merchant's phone number.

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

Data Type

String

MerchantServicePhone Property (DPaymentsSDK_TSYSECommerce Class)

Merchant's customer service number.

Object Oriented Interface

public function getMerchantServicePhone();
public function setMerchantServicePhone($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 22 );
dpaymentssdk_tsysecommerce_set($res, 22, $value );

Default Value

''

Remarks

Merchant's customer service number.

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

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

Data Type

String

MerchantState Property (DPaymentsSDK_TSYSECommerce Class)

State or province that the merchant is located in.

Object Oriented Interface

public function getMerchantState();
public function setMerchantState($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 23 );
dpaymentssdk_tsysecommerce_set($res, 23, $value );

Default Value

''

Remarks

State or province that the merchant is located in.

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

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

Data Type

String

MerchantStoreNumber Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getMerchantStoreNumber();
public function setMerchantStoreNumber($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 24 );
dpaymentssdk_tsysecommerce_set($res, 24, $value );

Default Value

''

Remarks

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

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

Data Type

String

MerchantStreetAddress Property (DPaymentsSDK_TSYSECommerce Class)

Merchant's street address.

Object Oriented Interface

public function getMerchantStreetAddress();
public function setMerchantStreetAddress($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 25 );
dpaymentssdk_tsysecommerce_set($res, 25, $value );

Default Value

''

Remarks

Merchant's street address.

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

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_TSYSECommerce Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();
public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 26 );
dpaymentssdk_tsysecommerce_set($res, 26, $value );

Default Value

''

Remarks

Used to identify a unique terminal within a merchant location.

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

Data Type

String

MerchantTimeZone Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getMerchantTimeZone();
public function setMerchantTimeZone($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 27 );
dpaymentssdk_tsysecommerce_set($res, 27, $value );

Default Value

'705'

Remarks

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

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

Byte #1:

Bytes #2-3:

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

Data Type

String

MerchantZip Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getMerchantZip();
public function setMerchantZip($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 28 );
dpaymentssdk_tsysecommerce_set($res, 28, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_TSYSECommerce Class)

Contains an authorization code when a transaction has been approved.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 29 );

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

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

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 30 );

Default Value

''

Remarks

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

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

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

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

This property is read-only.

Data Type

String

ResponseAuthSource Property (DPaymentsSDK_TSYSECommerce Class)

Indicates the source of the authorization code stored in ApprovalCode .

Object Oriented Interface

public function getResponseAuthSource();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 31 );

Default Value

''

Remarks

Indicates the source of the authorization code stored in ResponseApprovalCode.

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

* Currently in use by Japan Acquirer Services (JAS).

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

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_TSYSECommerce Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 32 );

Default Value

''

Remarks

Contains the Address Verification System result code.

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

*AVS Result Code for International addresses only

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

Data Type

String

ResponseCardLevel Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getResponseCardLevel();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 33 );

Default Value

''

Remarks

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

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

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

Data Type

String

ResponseCode Property (DPaymentsSDK_TSYSECommerce Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 34 );

Default Value

''

Remarks

Indicates the status of the authorization request.

This property contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

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

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

Data Type

String

ResponseCommercialCardType Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getResponseCommercialCardType();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 35 );

Possible Values

TSYSECOMMERCE_RESPONSECOMMERCIALCARDTYPE_NOT_COMMERCIAL(0), 
TSYSECOMMERCE_RESPONSECOMMERCIALCARDTYPE_BUSINESS_CARD(1), 
TSYSECOMMERCE_RESPONSECOMMERCIALCARDTYPE_VISA_COMMERCE(2), 
TSYSECOMMERCE_RESPONSECOMMERCIALCARDTYPE_CORPORATE_CARD(3), 
TSYSECOMMERCE_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:

Note: Of the possible ResponseCommercialCardTypes for Visa cards, you should only send Level III data for tctPurchaseCards. Level III may be sent for any MasterCard ResponseCommercialCardType except cctNotCommercial.

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

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 36 );

Default Value

''

Remarks

Contains the returned CVV result code if it was requested.

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

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

Data Type

String

ResponseRetrievalNumber Property (DPaymentsSDK_TSYSECommerce 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_tsysecommerce_get($res, 37 );

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

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 38 );

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

Text information that describes each response code.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 39 );

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

Local transaction date returned from the server in MMddyy format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 40 );

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

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 41 );

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

Check this property against the original Transaction Number.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 42 );

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

Local transaction time returned from the server in HHmmss format.

Object Oriented Interface

public function getResponseTransactionTime();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 43 );

Default Value

''

Remarks

Local transaction time returned from the server in HHmmss format.

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

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

Data Type

String

ResponseValidationCode Property (DPaymentsSDK_TSYSECommerce Class)

This optional property contains information generated by the card issuer.

Object Oriented Interface

public function getResponseValidationCode();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 44 );

Default Value

''

Remarks

This optional property contains information generated by the card issuer.

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

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_TSYSECommerce Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 45 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 46 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 47 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 48 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 49 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 50 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 51 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 52 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 53 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 54 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 55 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 56 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 57 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 58 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 59 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 60 );
dpaymentssdk_tsysecommerce_set($res, 60, $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_TSYSECommerce 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_tsysecommerce_get($res, 61 );
dpaymentssdk_tsysecommerce_set($res, 61, $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_TSYSECommerce Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 62 );
dpaymentssdk_tsysecommerce_set($res, 62, $value );

Possible Values

TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
TSYSECOMMERCE_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 63 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_TSYSECommerce Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 64 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 65 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 66 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 67 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 68 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 69 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 70 );
dpaymentssdk_tsysecommerce_set($res, 70, $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_TSYSECommerce Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 71 );
dpaymentssdk_tsysecommerce_set($res, 71, $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_TSYSECommerce Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 72 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 73 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 74 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 75 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 76 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 77 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 78 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 79 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 80 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 81 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 82 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 83 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 84 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 85 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 86 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 87 );
dpaymentssdk_tsysecommerce_set($res, 87, $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_TSYSECommerce 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_tsysecommerce_get($res, 88 );
dpaymentssdk_tsysecommerce_set($res, 88, $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_TSYSECommerce Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 89 );
dpaymentssdk_tsysecommerce_set($res, 89, $value );

Possible Values

TSYSECOMMERCE_SSLCERTSTORETYPE_USER(0), 
TSYSECOMMERCE_SSLCERTSTORETYPE_MACHINE(1), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PFXFILE(2), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PFXBLOB(3), 
TSYSECOMMERCE_SSLCERTSTORETYPE_JKSFILE(4), 
TSYSECOMMERCE_SSLCERTSTORETYPE_JKSBLOB(5), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSECOMMERCE_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSECOMMERCE_SSLCERTSTORETYPE_P7BFILE(11), 
TSYSECOMMERCE_SSLCERTSTORETYPE_P7BBLOB(12), 
TSYSECOMMERCE_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PPKFILE(14), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PPKBLOB(15), 
TSYSECOMMERCE_SSLCERTSTORETYPE_XMLFILE(16), 
TSYSECOMMERCE_SSLCERTSTORETYPE_XMLBLOB(17), 
TSYSECOMMERCE_SSLCERTSTORETYPE_JWKFILE(18), 
TSYSECOMMERCE_SSLCERTSTORETYPE_JWKBLOB(19), 
TSYSECOMMERCE_SSLCERTSTORETYPE_SECURITY_KEY(20), 
TSYSECOMMERCE_SSLCERTSTORETYPE_BCFKSFILE(21), 
TSYSECOMMERCE_SSLCERTSTORETYPE_BCFKSBLOB(22), 
TSYSECOMMERCE_SSLCERTSTORETYPE_PKCS11(23), 
TSYSECOMMERCE_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 90 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_TSYSECommerce Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 91 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 92 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 93 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 94 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 95 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 96 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 97 );
dpaymentssdk_tsysecommerce_set($res, 97, $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_TSYSECommerce Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 98 );
dpaymentssdk_tsysecommerce_set($res, 98, $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_TSYSECommerce 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_tsysecommerce_get($res, 99 );
dpaymentssdk_tsysecommerce_set($res, 99, $value );

Possible Values

TSYSECOMMERCE_SSLPROVIDER_AUTOMATIC(0), 
TSYSECOMMERCE_SSLPROVIDER_PLATFORM(1), 
TSYSECOMMERCE_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:

Additional Notes

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 100 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 101 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 102 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 103 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 104 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 105 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 106 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 107 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 108 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 109 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 110 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 111 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 112 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 113 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 114 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 115 );

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_TSYSECommerce 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_tsysecommerce_get($res, 116 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 117 );

Possible Values

TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_USER(0), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_MACHINE(1), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_PKCS11(23), 
TSYSECOMMERCE_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (DPaymentsSDK_TSYSECommerce Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 118 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (DPaymentsSDK_TSYSECommerce Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 119 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (DPaymentsSDK_TSYSECommerce Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 120 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (DPaymentsSDK_TSYSECommerce Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 121 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (DPaymentsSDK_TSYSECommerce Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 122 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (DPaymentsSDK_TSYSECommerce Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 123 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (DPaymentsSDK_TSYSECommerce Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 124 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (DPaymentsSDK_TSYSECommerce Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 125 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (DPaymentsSDK_TSYSECommerce Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 126 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DPaymentsSDK_TSYSECommerce Class)

A timeout for the class.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 127 );
dpaymentssdk_tsysecommerce_set($res, 127, $value );

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (DPaymentsSDK_TSYSECommerce Class)

Purchase amount to be authorized.

Object Oriented Interface

public function getTransactionAmount();
public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 128 );
dpaymentssdk_tsysecommerce_set($res, 128, $value );

Default Value

''

Remarks

This field contains the transaction amount to be authorized.

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

TransactionNumber Property (DPaymentsSDK_TSYSECommerce Class)

Sequence number of this transaction.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 129 );
dpaymentssdk_tsysecommerce_set($res, 129, $value );

Default Value

0

Remarks

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

Data Type

Integer

TransactionType Property (DPaymentsSDK_TSYSECommerce Class)

Specifies the type of transaction to process.

Object Oriented Interface

public function getTransactionType();
public function setTransactionType($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 130 );
dpaymentssdk_tsysecommerce_set($res, 130, $value );

Possible Values

TSYSECOMMERCE_TRANSACTIONTYPE_ECOMMERCE(0), 
TSYSECOMMERCE_TRANSACTIONTYPE_MOTO(1), 
TSYSECOMMERCE_TRANSACTIONTYPE_RECURRING(2), 
TSYSECOMMERCE_TRANSACTIONTYPE_INSTALLMENT(3)

Default Value

0

Remarks

The following types of transactions are supported by this class:

All of these transactions are card-not-present transactions. If you wish to authorize card-present transactions, you must use the TSYSRetail class.

To settle a transaction authorized with the ttInstallment TransactionType, you must specify the number of this installment and the total count of all installments to be made using TSYSECommerce class. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

TSYSECommerce.TransactionType = ttInstallment TSYSECommerce.TransactionAmount = "1995" TSYSECommerce.Config("InstallmentCount=3") TSYSECommerce.Config("InstallmentNumber=1") TSYSECommerce.Authorize() TSYSSettle.DetailAggregate[5] = TSYSECommerce.GetDetailAggregate()

Data Type

Integer

VisaMVV Property (DPaymentsSDK_TSYSECommerce Class)

The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program.

Object Oriented Interface

public function getVisaMVV();
public function setVisaMVV($value);

Procedural Interface

dpaymentssdk_tsysecommerce_get($res, 131 );
dpaymentssdk_tsysecommerce_set($res, 131, $value );

Default Value

''

Remarks

The maximum length of this property is 10 characters, and it may only contain 0-9 and A-F.

Data Type

String

AuthenticateCard Method (DPaymentsSDK_TSYSECommerce Class)

Determines only if a card has been lost or stolen.

Object Oriented Interface

public function doAuthenticateCard();

Procedural Interface

dpaymentssdk_tsysecommerce_do_authenticatecard($res);

Remarks

This method does not send an authorization, but instead it sends an authentication request. If successful the ResponseCode will be "85". If the card is stolen or otherwise not normal, the ResponseCode and ResponseText will indicate such. You may send AVS (CustomerAddress and CustomerZip) as well as CardCVVData, and the ResponseAVSResult and ResponseCVVResult will be returned as normal.

Authorize Method (DPaymentsSDK_TSYSECommerce Class)

Sends an authorization request.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

dpaymentssdk_tsysecommerce_do_authorize($res);

Remarks

This method sends an authorization request to the Vital/TSYS transaction server. If the authorization request was successful, the ResponseCode property will contain "00" or "85".

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement class. For example:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailRecordAggregate(0) = TSYSECommerce.GetDetailAggregate()

Config Method (DPaymentsSDK_TSYSECommerce Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_tsysecommerce_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetDetailAggregate Method (DPaymentsSDK_TSYSECommerce Class)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_tsysecommerce_do_getdetailaggregate($res);

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

TSYSRetail.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

Interrupt Method (DPaymentsSDK_TSYSECommerce Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_tsysecommerce_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_TSYSECommerce Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsysecommerce_do_reset($res);

Remarks

This method clears all properties to their default values.

Connected Event (DPaymentsSDK_TSYSECommerce Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

DataPacketIn Event (DPaymentsSDK_TSYSECommerce Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

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

Parameter List

 'datapacket'

Remarks

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

DataPacketOut Event (DPaymentsSDK_TSYSECommerce Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

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

Parameter List

 'datapacket'

Remarks

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

Disconnected Event (DPaymentsSDK_TSYSECommerce Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

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

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

Error Event (DPaymentsSDK_TSYSECommerce Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_tsysecommerce_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Response Event (DPaymentsSDK_TSYSECommerce Class)

Used with Interleaved Transaction Mode.

Object Oriented Interface

public function fireResponse($param);

Procedural Interface

dpaymentssdk_tsysecommerce_register_callback($res, 6, array($this, 'fireResponse'));

Parameter List

 'transactionid'
 'responsecode'
 'responsetext'
 'responseapprovalcode'

Remarks

When InterleavedMode configuration setting is set to True the component will send interleaved transactions without blocking and waiting for a response. For every response that the class receives from TSYS the Response event will fire. TransactionId parameter can be used to identify the transaction. ResponseCode and ResponseText can be used to determine if a transaction was approved or declined.

SSLServerAuthentication Event (DPaymentsSDK_TSYSECommerce Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_tsysecommerce_register_callback($res, 7, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (DPaymentsSDK_TSYSECommerce Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_tsysecommerce_register_callback($res, 8, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (TSYSECommerce Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

TSYSECommerce Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (TSYSECommerce Class)

TSYSECommerce Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors