FDMSHotel Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSHotel class is an advanced tool used to authorize credit cards in a retail environment, where the customer is purchasing products or services in person. This class makes authorizing these types of transactions very easy.

Class Name

DPaymentsSDK_FDMSHotel

Procedural Interface

 dpaymentssdk_fdmshotel_open();
 dpaymentssdk_fdmshotel_close($res);
 dpaymentssdk_fdmshotel_register_callback($res, $id, $function);
 dpaymentssdk_fdmshotel_get_last_error($res);
 dpaymentssdk_fdmshotel_get_last_error_code($res);
 dpaymentssdk_fdmshotel_set($res, $id, $index, $value);
 dpaymentssdk_fdmshotel_get($res, $id, $index);
 dpaymentssdk_fdmshotel_do_authorize($res);
 dpaymentssdk_fdmshotel_do_avsandcvvonly($res);
 dpaymentssdk_fdmshotel_do_balanceinquiry($res);
 dpaymentssdk_fdmshotel_do_config($res, $configurationstring);
 dpaymentssdk_fdmshotel_do_getdetailaggregate($res);
 dpaymentssdk_fdmshotel_do_gethoteldataaggregate($res);
 dpaymentssdk_fdmshotel_do_incrementalauth($res, $transactionid, $validationcode);
 dpaymentssdk_fdmshotel_do_interrupt($res);
 dpaymentssdk_fdmshotel_do_reset($res);

Remarks

This class connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these classs go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the class. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated SSL servers.

The FDMSHotel class makes authorizing transactions in a hotel/lodging environment 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, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSRegister class to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId with the value retrieved by the FDMSRegister class after activating your merchant account. Set the URL property with one of the URLs you retrieved during Service Discovery.

 
 Copy
  FDMSHotel.MerchantNumber = "000000999990"                  'Supplied by FDMS/Datawire
  FDMSHotel.MerchantTerminalNumber = "555555"                'Supplied by FDMS/Datawire
  FDMSHotel.TPPID = "VNT001";                                 'Supplied by FDMS/Datawire
  FDMSHotel.VisaIdentifier = "0B34567890123456789";           'Supplied by FDMS/Datawire
  FDMSHotel.DatawireId = "0000B47FFFFFFFFFFFFF"              'Retrieved with the FDMSRegister class.  
  FDMSHotel.URL = "https://staging1.datawire.net/sd/";        'Retrieved with the FDMSRegister class.

Then set the Card properties with the customer's cardholder data. Most card readers are capable of reading both Track1 and Track2 data off of a credit card. If both are present and correctly read, you should default to sending Track1 data. If your card reader cannot read the card at all, you may manually enter the credit card number and expiration date. Do not forget to set the CardEntryDataSource property, as it is used by the class during authorization to create the proper type of payload.

 
 Copy
   FDMSHotel.CardMagneticStripe = "B4662060000000005^FDCS TEST CARD^120410123456789"
   FDMSHotel.CardEntryDataSource = edsTrack1

Next, set properties that contain details about the transaction. The TransactionNumber should be incremented for every transaction you authorize. The TransactionAmount must now be set, along with any optional values such as InvoiceNumber, ReferenceNumber, RoomNumber, RoomRate, ArrivalDate, DepartureDate, or StayDuration. All amounts are set with an implied decimal point (ie: $1.00 is "100").

 
 Copy
  FDMSHotel.TransactionNumber = 1
  FDMSHotel.InvoiceNumber = "FOLIONUM1234"
  FDMSHotel.ReferenceNumber = "REFNUM1"
  FDMSHotel.RoomNumber = "101"
  FDMSHotel.RoomRate = "10000"
  FDMSHotel.ArrivalDate = "0127" 		' MMdd
  FDMSHotel.DepartureDate = "0128" 	' MMdd
  FDMSHotel.StayDuration = 1

Finally, submit the transaction via the Authorize method.

 
 Copy
  FDMSHotel.Authorize()

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 FDMSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

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.

ApplicationId Property (DPaymentsSDK_FDMSHotel Class)

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();
public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 1 );
dpaymentssdk_fdmshotel_set($res, 1, $value );

Default Value

'NSOFTDIRECTPXML'

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this class.

Data Type

String

ArrivalDate Property (DPaymentsSDK_FDMSHotel Class)

The arrival date of the guest.

Object Oriented Interface

public function getArrivalDate();
public function setArrivalDate($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 2 );
dpaymentssdk_fdmshotel_set($res, 2, $value );

Default Value

''

Remarks

Date the guest checked in, or the expected arrival date when authorizing a reservation. The date specified should be in the format "MMDD" for all card types with the exception of Mastercard. Mastercard requires the year to be specified as well in the format "MMDDYY".

Data Type

String

CardType Property (DPaymentsSDK_FDMSHotel Class)

Type of credit card being used in this transaction.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 3 );
dpaymentssdk_fdmshotel_set($res, 3, $value );

Possible Values

FDMSHOTEL_CARDTYPE_UNKNOWN(0), 
FDMSHOTEL_CARDTYPE_VISA(1), 
FDMSHOTEL_CARDTYPE_MASTER_CARD(2), 
FDMSHOTEL_CARDTYPE_AMEX(3), 
FDMSHOTEL_CARDTYPE_DISCOVER(4), 
FDMSHOTEL_CARDTYPE_DINERS(5), 
FDMSHOTEL_CARDTYPE_JCB(6), 
FDMSHOTEL_CARDTYPE_VISA_ELECTRON(7), 
FDMSHOTEL_CARDTYPE_MAESTRO(8), 
FDMSHOTEL_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_FDMSHotel Class)

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

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 4 );
dpaymentssdk_fdmshotel_set($res, 4, $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_FDMSHotel Class)

Indicates the presence of the card verification value.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 5 );
dpaymentssdk_fdmshotel_set($res, 5, $value );

Possible Values

FDMSHOTEL_CARDCVVPRESENCE_NOT_PROVIDED(0), 
FDMSHOTEL_CARDCVVPRESENCE_PROVIDED(1), 
FDMSHOTEL_CARDCVVPRESENCE_ILLEGIBLE(2), 
FDMSHOTEL_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_FDMSHotel 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_fdmshotel_get($res, 6 );
dpaymentssdk_fdmshotel_set($res, 6, $value );

Possible Values

FDMSHOTEL_CARDENTRYDATASOURCE_TRACK_1(0), 
FDMSHOTEL_CARDENTRYDATASOURCE_TRACK_2(1), 
FDMSHOTEL_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
FDMSHOTEL_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
FDMSHOTEL_CARDENTRYDATASOURCE_MANUAL_ENTRY_NO_CARD_READER(4), 
FDMSHOTEL_CARDENTRYDATASOURCE_TRACK_1CONTACTLESS(5), 
FDMSHOTEL_CARDENTRYDATASOURCE_TRACK_2CONTACTLESS(6), 
FDMSHOTEL_CARDENTRYDATASOURCE_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
FDMSHOTEL_CARDENTRYDATASOURCE_IVR(8), 
FDMSHOTEL_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_FDMSHotel Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 7 );
dpaymentssdk_fdmshotel_set($res, 7, $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_FDMSHotel Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 8 );
dpaymentssdk_fdmshotel_set($res, 8, $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_FDMSHotel 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_fdmshotel_get($res, 9 );
dpaymentssdk_fdmshotel_set($res, 9, $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_FDMSHotel Class)

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

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 10 );
dpaymentssdk_fdmshotel_set($res, 10, $value );

Default Value

''

Remarks

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

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

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

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

or

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

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

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_FDMSHotel Class)

Customer's credit card number for the transaction.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 11 );
dpaymentssdk_fdmshotel_set($res, 11, $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

CardholderName Property (DPaymentsSDK_FDMSHotel Class)

The name of the Cardholder.

Object Oriented Interface

public function getCardholderName();
public function setCardholderName($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 12 );
dpaymentssdk_fdmshotel_set($res, 12, $value );

Default Value

''

Remarks

This property is used to specify the name of the cardholder, as taken from the Track 1 data.

If a value is not specified, the component will parse out the name from the specified Track 1 data.

Data Type

String

CustomerAddress Property (DPaymentsSDK_FDMSHotel Class)

The customer's billing address.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 13 );
dpaymentssdk_fdmshotel_set($res, 13, $value );

Default Value

''

Remarks

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

The maximum length of this property is 20 characters.

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_FDMSHotel 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_fdmshotel_get($res, 14 );
dpaymentssdk_fdmshotel_set($res, 14, $value );

Default Value

''

Remarks

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

The maximum length of this property is 10 characters.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSHotel Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();
public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 15 );
dpaymentssdk_fdmshotel_set($res, 15, $value );

Default Value

''

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister class). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Data Type

String

DepartureDate Property (DPaymentsSDK_FDMSHotel Class)

The departure date of the guest.

Object Oriented Interface

public function getDepartureDate();
public function setDepartureDate($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 16 );
dpaymentssdk_fdmshotel_set($res, 16, $value );

Default Value

''

Remarks

Date the guest checked out, or the expected departure date when authorizing a reservation. The date specified should be in the format "MMDD" for all card types with the exception of Mastercard. Mastercard requires the year to be specified as well in the format "MMDDYY".

Data Type

String

ExtraCharges Property (DPaymentsSDK_FDMSHotel Class)

List of extra charges for Hotel transactions.

Object Oriented Interface

public function getExtraCharges();
public function setExtraCharges($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 17 );
dpaymentssdk_fdmshotel_set($res, 17, $value );

Default Value

'0'

Remarks

This property contains a six-character numeric value used to identify any additional ancillary charges that are booked to the cardholder's card after the transaction was completed. The merchant may enter one or more codes on each transaction being settled. If extra charges are being submitted, this field must contain value(s) as defined below.

For example, to indicate charges in both the gift shop and mini bar, ExtraCharges should equal "34".

This field is only applicable to Visa card transactions.

Data Type

String

FDMSPlatform Property (DPaymentsSDK_FDMSHotel Class)

Specifies the FDMS platform that the transactions will be processed on.

Object Oriented Interface

public function getFDMSPlatform();
public function setFDMSPlatform($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 18 );
dpaymentssdk_fdmshotel_set($res, 18, $value );

Possible Values

FDMSHOTEL_FDMSPLATFORM_NORTH(0), 
FDMSHOTEL_FDMSPLATFORM_NASHVILLE(1)

Default Value

0

Remarks

This property is used to identify the FDMS platform that the transactions will be sent to and processed on. The following table lists the platforms supported by this class.

Data Type

Integer

InvoiceNumber Property (DPaymentsSDK_FDMSHotel Class)

The Folio or Room Agreement number assigned by the hotel.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 19 );
dpaymentssdk_fdmshotel_set($res, 19, $value );

Default Value

''

Remarks

This is a 12 digit code assigned by the hotel during the transaction.

Note: Mastercard only uses a 10 digit code.

Data Type

String

MerchantNumber Property (DPaymentsSDK_FDMSHotel Class)

A unique number used to identify the merchant within the FDMS and Datawire systems.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 20 );
dpaymentssdk_fdmshotel_set($res, 20, $value );

Default Value

''

Remarks

This property contains a unique number (typically 12 digits) which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS and Datawire systems, and is used along with the MerchantTerminalNumber and DatawireId as connection credentials.

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_FDMSHotel Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 21 );
dpaymentssdk_fdmshotel_set($res, 21, $value );

Default Value

''

Remarks

This property contains a number (typically 6 digits) assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber and DatawireId as connection credentials.

Data Type

String

NoShow Property (DPaymentsSDK_FDMSHotel Class)

Indicates whether the guest did not show.

Object Oriented Interface

public function getNoShow();
public function setNoShow($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 22 );
dpaymentssdk_fdmshotel_set($res, 22, $value );

Default Value

false

Remarks

This property can be set to 'True' to indicate that the guest did not show.

Data Type

Boolean

PrestigiousIndicator Property (DPaymentsSDK_FDMSHotel Class)

Prestigious Lodging Program indicator for the Hotel Industry Type.

Object Oriented Interface

public function getPrestigiousIndicator();
public function setPrestigiousIndicator($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 23 );
dpaymentssdk_fdmshotel_set($res, 23, $value );

Possible Values

FDMSHOTEL_PRESTIGIOUSINDICATOR_NOT_PARTICIPATING(0), 
FDMSHOTEL_PRESTIGIOUSINDICATOR_500LIMIT(1), 
FDMSHOTEL_PRESTIGIOUSINDICATOR_1000LIMIT(2), 
FDMSHOTEL_PRESTIGIOUSINDICATOR_1500LIMIT(3)

Default Value

0

Remarks

This indicator is used by participants in Visa's Prestigious Lodging Program. A transaction amount of "100" should be entered in the request if the merchant wishes the transaction to participate in the Visa Prestigious Property Program.

Valid indicators include:

Data Type

Integer

ProgramIndicator Property (DPaymentsSDK_FDMSHotel Class)

Special Program Indicator.

Object Oriented Interface

public function getProgramIndicator();
public function setProgramIndicator($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 24 );
dpaymentssdk_fdmshotel_set($res, 24, $value );

Default Value

1

Remarks

This is used to specify the program indicator for a hotel/lodging transaction. This property is only applicable for American Express cards.

Valid Values:

Data Type

Integer

ProxyAuthScheme Property (DPaymentsSDK_FDMSHotel Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 25 );
dpaymentssdk_fdmshotel_set($res, 25, $value );

Possible Values

FDMSHOTEL_PROXYAUTHSCHEME_BASIC(0), 
FDMSHOTEL_PROXYAUTHSCHEME_DIGEST(1), 
FDMSHOTEL_PROXYAUTHSCHEME_PROPRIETARY(2), 
FDMSHOTEL_PROXYAUTHSCHEME_NONE(3), 
FDMSHOTEL_PROXYAUTHSCHEME_NTLM(4), 
FDMSHOTEL_PROXYAUTHSCHEME_NEGOTIATE(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_FDMSHotel Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 26 );
dpaymentssdk_fdmshotel_set($res, 26, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_FDMSHotel Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 27 );
dpaymentssdk_fdmshotel_set($res, 27, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSHotel Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 28 );
dpaymentssdk_fdmshotel_set($res, 28, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSHotel Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 29 );
dpaymentssdk_fdmshotel_set($res, 29, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (DPaymentsSDK_FDMSHotel Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 30 );
dpaymentssdk_fdmshotel_set($res, 30, $value );

Possible Values

FDMSHOTEL_PROXYSSL_AUTOMATIC(0), 
FDMSHOTEL_PROXYSSL_ALWAYS(1), 
FDMSHOTEL_PROXYSSL_NEVER(2), 
FDMSHOTEL_PROXYSSL_TUNNEL(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (DPaymentsSDK_FDMSHotel Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 31 );
dpaymentssdk_fdmshotel_set($res, 31, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ReferenceNumber Property (DPaymentsSDK_FDMSHotel Class)

A reference number assigned by the hotel.

Object Oriented Interface

public function getReferenceNumber();
public function setReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 32 );
dpaymentssdk_fdmshotel_set($res, 32, $value );

Default Value

''

Remarks

This is a 9 character identifier assigned by the hotel for the transaction.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_FDMSHotel Class)

Contains an authorization code when a transaction has been approved, or an error message if declined.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 33 );

Default Value

''

Remarks

Contains an authorization code when a transaction has been approved, or an error message if declined.

This property contains an authorization code when a transaction has been approved. The code will begin with "AP" and will be 8 characters in length. If the transaction was partially approved, it will begin with "AL" (approved for lesser amount), and the actual amount approved will be contained in the ResponseAuthorizedAmount property. If the transaction was declined ResponseApprovalCode will contain one of the response messages listed in the table below:

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_FDMSHotel Class)

When supporting partial authorizations, this is the amount actually charged to the credit card.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 34 );

Default Value

''

Remarks

When supporting partial authorizations, this is the amount actually charged to the credit card.

This is only used when supporting partial authorizations (currently only supported for healthcare transactions). If the ResponseApprovalCode begins with "AL" this property will contain the amount actually charged to the credit card. This will be less than the original TransactionAmount. You must collect the remainder via another form of payment, or Reverse the authorization if the customer does not have an additional form of payment.

This property is read-only.

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_FDMSHotel Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 35 );

Default Value

''

Remarks

Contains the Address Verification System result code.

This one character field 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. The valid AVS codes are listed in the table below.

Valid AVS Codes:

If supporting international transactions, four additional International Address Verification Service (IAVS) codes are introduced:

This property is read-only.

Data Type

String

ResponseBalance Property (DPaymentsSDK_FDMSHotel Class)

Contains the remaining available balance left on the card.

Object Oriented Interface

public function getResponseBalance();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 36 );

Default Value

''

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

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

Data Type

String

ResponseCaptureFlag Property (DPaymentsSDK_FDMSHotel Class)

Indicates whether the authorization was successful, and whether it can be settled.

Object Oriented Interface

public function getResponseCaptureFlag();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 37 );

Default Value

false

Remarks

Indicates whether the authorization was successful, and whether it can be settled.

After an authorization request, the ResponseCaptureFlag will be set to True if the request was successfully processed. This indicates that you may send the transaction on for batch settlement using the FDMSSettle class. If this property is False you should consider the transaction as Declined, and it may not be settled.

This property is read-only.

Data Type

Boolean

ResponseCardLevelResult Property (DPaymentsSDK_FDMSHotel Class)

Two character card level results property returned in the response to Visa authorizations.

Object Oriented Interface

public function getResponseCardLevelResult();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 38 );

Default Value

''

Remarks

Two character card level results field returned in the response to Visa authorizations.

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

Data Type

String

ResponseCommercialCard Property (DPaymentsSDK_FDMSHotel Class)

Indicates whether the credit card charged is a corporate commercial card.

Object Oriented Interface

public function getResponseCommercialCard();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 39 );

Possible Values

FDMSHOTEL_RESPONSECOMMERCIALCARD_NOT_COMMERCIAL(0), 
FDMSHOTEL_RESPONSECOMMERCIALCARD_PURCHASE_CARD(1), 
FDMSHOTEL_RESPONSECOMMERCIALCARD_CORPORATE_CARD(2), 
FDMSHOTEL_RESPONSECOMMERCIALCARD_BUSINESS_CARD(3), 
FDMSHOTEL_RESPONSECOMMERCIALCARD_UNKNOWN(4)

Default Value

0

Remarks

Indicates whether the credit card charged is a corporate commercial card.

Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data in the settlement when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Commercial card transactions settled with Level 2 or Level 3 data must include tax amounts to receive the best interchange rate.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (DPaymentsSDK_FDMSHotel Class)

Contains the returned CVV result code (if CVV data was sent in the request).

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 40 );

Default Value

''

Remarks

Contains the returned CVV result code (if CVV data was sent in the request).

If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (DPaymentsSDK_FDMSHotel Class)

Contains an error code providing more details about the DatawireStatus received.

Object Oriented Interface

public function getResponseDatawireReturnCode();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 41 );

Default Value

''

Remarks

Contains an error code providing more details about the ResponseDatawireStatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contain the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (DPaymentsSDK_FDMSHotel Class)

Status of the communication with Datawire.

Object Oriented Interface

public function getResponseDatawireStatus();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 42 );

Default Value

''

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

ResponseReturnedACI Property (DPaymentsSDK_FDMSHotel Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 43 );

Default Value

''

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field 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 field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the ResponseTransactionId or ResponseValidationCode fields.

The following is a list of all returned ACI values. Please note that many of these return values result from features not available in any of the currently supported Industry Types.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (DPaymentsSDK_FDMSHotel Class)

Local transaction date returned from the server in MMDDYY format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 44 );

Default Value

''

Remarks

Local transaction date returned from the server in MMDDYY format.

This six digit field contains a local transaction date calculated by the authorization center. This field should be recorded and submitted in the Batch Settlement.

This property is read-only.

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_FDMSHotel Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 45 );

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 field. Data returned in this field (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

ResponseValidationCode Property (DPaymentsSDK_FDMSHotel Class)

Additional information generated by the card issuer.

Object Oriented Interface

public function getResponseValidationCode();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 46 );

Default Value

''

Remarks

Additional information generated by the card issuer.

This four character field may contain 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 field. Data returned in this field 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

RoomNumber Property (DPaymentsSDK_FDMSHotel Class)

The Room Number assigned by the hotel.

Object Oriented Interface

public function getRoomNumber();
public function setRoomNumber($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 47 );
dpaymentssdk_fdmshotel_set($res, 47, $value );

Default Value

''

Remarks

This is a 6 character room number code assigned by the hotel during the transaction.

Data Type

String

RoomRate Property (DPaymentsSDK_FDMSHotel Class)

The daily room rate.

Object Oriented Interface

public function getRoomRate();
public function setRoomRate($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 48 );
dpaymentssdk_fdmshotel_set($res, 48, $value );

Default Value

''

Remarks

The room rate specified as an unsigned whole dollar amount (no cents).

Examples:

The maximum RoomRate is "999". Any daily room rates $1000 or greater should set RoomRate to "0".

Data Type

String

RoomTax Property (DPaymentsSDK_FDMSHotel Class)

The daily room tax amount.

Object Oriented Interface

public function getRoomTax();
public function setRoomTax($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 49 );
dpaymentssdk_fdmshotel_set($res, 49, $value );

Default Value

''

Remarks

The room tax amount specified as an unsigned whole dollar amount (no cents).

Note: This field is only applicable to MasterCard transactions.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_FDMSHotel Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 50 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 51 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 52 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 53 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 54 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 55 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 56 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 57 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 58 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 59 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 60 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 61 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 62 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 63 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 64 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 65 );
dpaymentssdk_fdmshotel_set($res, 65, $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_FDMSHotel 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_fdmshotel_get($res, 66 );
dpaymentssdk_fdmshotel_set($res, 66, $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_FDMSHotel Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 67 );
dpaymentssdk_fdmshotel_set($res, 67, $value );

Possible Values

FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
FDMSHOTEL_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_FDMSHotel Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 68 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_FDMSHotel Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 69 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 70 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 71 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 72 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 73 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 74 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 75 );
dpaymentssdk_fdmshotel_set($res, 75, $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_FDMSHotel Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 76 );
dpaymentssdk_fdmshotel_set($res, 76, $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_FDMSHotel Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 77 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 78 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 79 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 80 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 81 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 82 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 83 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 84 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 85 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 86 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 87 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 88 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 89 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 90 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 91 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 92 );
dpaymentssdk_fdmshotel_set($res, 92, $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_FDMSHotel 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_fdmshotel_get($res, 93 );
dpaymentssdk_fdmshotel_set($res, 93, $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_FDMSHotel Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 94 );
dpaymentssdk_fdmshotel_set($res, 94, $value );

Possible Values

FDMSHOTEL_SSLCERTSTORETYPE_USER(0), 
FDMSHOTEL_SSLCERTSTORETYPE_MACHINE(1), 
FDMSHOTEL_SSLCERTSTORETYPE_PFXFILE(2), 
FDMSHOTEL_SSLCERTSTORETYPE_PFXBLOB(3), 
FDMSHOTEL_SSLCERTSTORETYPE_JKSFILE(4), 
FDMSHOTEL_SSLCERTSTORETYPE_JKSBLOB(5), 
FDMSHOTEL_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
FDMSHOTEL_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
FDMSHOTEL_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
FDMSHOTEL_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
FDMSHOTEL_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
FDMSHOTEL_SSLCERTSTORETYPE_P7BFILE(11), 
FDMSHOTEL_SSLCERTSTORETYPE_P7BBLOB(12), 
FDMSHOTEL_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
FDMSHOTEL_SSLCERTSTORETYPE_PPKFILE(14), 
FDMSHOTEL_SSLCERTSTORETYPE_PPKBLOB(15), 
FDMSHOTEL_SSLCERTSTORETYPE_XMLFILE(16), 
FDMSHOTEL_SSLCERTSTORETYPE_XMLBLOB(17), 
FDMSHOTEL_SSLCERTSTORETYPE_JWKFILE(18), 
FDMSHOTEL_SSLCERTSTORETYPE_JWKBLOB(19), 
FDMSHOTEL_SSLCERTSTORETYPE_SECURITY_KEY(20), 
FDMSHOTEL_SSLCERTSTORETYPE_BCFKSFILE(21), 
FDMSHOTEL_SSLCERTSTORETYPE_BCFKSBLOB(22), 
FDMSHOTEL_SSLCERTSTORETYPE_PKCS11(23), 
FDMSHOTEL_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

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

Data Type

Integer

SSLCertSubjectAltNames Property (DPaymentsSDK_FDMSHotel Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 95 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_FDMSHotel Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 96 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 97 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 98 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 99 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 100 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 101 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 102 );
dpaymentssdk_fdmshotel_set($res, 102, $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_FDMSHotel Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 103 );
dpaymentssdk_fdmshotel_set($res, 103, $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_FDMSHotel 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_fdmshotel_get($res, 104 );
dpaymentssdk_fdmshotel_set($res, 104, $value );

Possible Values

FDMSHOTEL_SSLPROVIDER_AUTOMATIC(0), 
FDMSHOTEL_SSLPROVIDER_PLATFORM(1), 
FDMSHOTEL_SSLPROVIDER_INTERNAL(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (DPaymentsSDK_FDMSHotel Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 105 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 106 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 107 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 108 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 109 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 110 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 111 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 112 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 113 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 114 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 115 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 116 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 117 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 118 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 119 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 120 );

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.