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.

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

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.

FDMSHotel.Authorize() When the class receives a response, the result of the authorization will be available in several Response properties. The ResponseDatawireStatus and ResponseDatawireReturnCode indicate whether any errors occurred while passing the transaction through the Datawire VXN system. These two properties alone do not indicate a successful transaction, they only tell whether or not there were any problems transporting the authorization request and response through the Datawire system. If the transaction was successfully authorized by FDMS, then the ResponseCaptureFlag will be True, and the ResponseApprovalCode will contain an approval code that beings with "AP". (or "AL" for classs that support partially-approved/split-tender transactions).

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

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

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

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?"

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

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

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)

This property is used to tell the class which 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 );

Default Value

0

Remarks

This property is used to tell the class which 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 component 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)

This property tells the class whether or not 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

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_FDMSHotel Class)

This property contains 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

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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)

This property contains 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

This property contains 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)

This property determines 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 );

Default Value

0

Remarks

This property determines 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)

This property contains 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

This property contains 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 );

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

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSHotel Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 51 );


dpaymentssdk_fdmshotel_set($res, 51, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_FDMSHotel Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 79 );


dpaymentssdk_fdmshotel_set($res, 79, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_FDMSHotel Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 95 );


dpaymentssdk_fdmshotel_set($res, 95, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_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, 96 );


dpaymentssdk_fdmshotel_set($res, 96, $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)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 97 );


dpaymentssdk_fdmshotel_set($res, 97, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_FDMSHotel Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 98 );


dpaymentssdk_fdmshotel_set($res, 98, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DPaymentsSDK_FDMSHotel Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 106 );


dpaymentssdk_fdmshotel_set($res, 106, $value );

Default Value

0

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_FDMSHotel Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 108 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

StayDuration Property (DPaymentsSDK_FDMSHotel Class)

Length of hotel stay in days.

Object Oriented Interface

public function getStayDuration();


public function setStayDuration($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 135 );


dpaymentssdk_fdmshotel_set($res, 135, $value );

Default Value

1

Remarks

The number of days the guest stayed in the hotel, or the expected duration of stay when authorizing a reservation. This field must be between 1 and 99 days.

Data Type

Integer

Timeout Property (DPaymentsSDK_FDMSHotel Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 136 );


dpaymentssdk_fdmshotel_set($res, 136, $value );

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TPPID Property (DPaymentsSDK_FDMSHotel Class)

Third Party Processor Identifier assigned by FDMS.

Object Oriented Interface

public function getTPPID();


public function setTPPID($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 137 );


dpaymentssdk_fdmshotel_set($res, 137, $value );

Default Value

'V4D001'

Remarks

The Third Party Processor Identifier (TPPID. Also sometimes referred to as a "Vendor Id") is assigned by FDMS to each third party who is processing transactions. Each merchant will receive his own TPPID from FDMS. If there are multiple third parties involved in the transaction flow, additional TPPID's are required. These may be added by setting the TPPID property with a comma-delimited list. The first entry should always be the servicer that sends the transaction to FDMS. Each subsequent servicer should be identified where they are in the chain. There can be a maximum of three entries in this list.

The default value for 4D Payments, Inc. on the North and Nashville platforms is "V4D001".

Note: This value will be reset to the default value when FDMSPlatform is set.

A VisaIdentifier is also required for Visa transactions.

Data Type

String

TransactionAmount Property (DPaymentsSDK_FDMSHotel Class)

Purchase amount to be authorized.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 138 );


dpaymentssdk_fdmshotel_set($res, 138, $value );

Default Value

''

Remarks

This property contains the transaction amount to be authorized.

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

Data Type

String

TransactionNumber Property (DPaymentsSDK_FDMSHotel Class)

Uniquely identifies the transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 139 );


dpaymentssdk_fdmshotel_set($res, 139, $value );

Default Value

''

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

For all classs except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, and nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

Data Type

String

URL Property (DPaymentsSDK_FDMSHotel Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 140 );


dpaymentssdk_fdmshotel_set($res, 140, $value );

Default Value

'https://staging1.datawire.net/sd/'

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister class. Once you Register and Activate the merchant using the FDMSRegister class, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister class.

Data Type

String

VisaIdentifier Property (DPaymentsSDK_FDMSHotel Class)

Additional merchant identification field used when authorizing Visa transactions.

Object Oriented Interface

public function getVisaIdentifier();


public function setVisaIdentifier($value);

Procedural Interface

dpaymentssdk_fdmshotel_get($res, 141 );


dpaymentssdk_fdmshotel_set($res, 141, $value );

Default Value

''

Remarks

In conjunction with Visa regulatory change(s), First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). Each 19-byte Visa Agent Identifier in the chain is composed of the following pieces:

A VisaIdentifier (Agent Identification Service - AUAR) is required for Visa transactions. A VisaIdentifier value is assigned by Visa as part of their Trusted Agent Program (TAP). Therefore it is suggested that you contact your FDMS certification analyst as they should be able to provide you with further information and put you in contact with the required party at Visa. Unfortunately more specific information on this matter cannot be provided as we do not handle live customer data and thus are not required to register in this particular program. However below is some additional information in regards to the requirements of a Visa Identifier.

Any merchant that transmits, processes, or stores cardholder data on server(s) that you own, manage, or operate on behalf of your clients (who are other merchant account holders) must meet the PCI Data Security Standard and follow additional steps to register as a service provider. Applicable services commonly include webhosting, software as a service, or collecting payment on behalf of a client. Any company providing these services must register with Visa's Third Party Agent (TAP) program.

You can register for the Visa Third Party Agent Program at http://usa.visa.com/merchants/risk_management/third-party-registration.html

If you find that you are not required to register with this program you can send the following value for VisaIdentifier: 0B 000000000000

Data Type

String

Authorize Method (DPaymentsSDK_FDMSHotel Class)

Authorizes a credit card using track1, track2, or manually entered card data.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

dpaymentssdk_fdmshotel_do_authorize($res);

Remarks

This method sends an authorization request through Datawire to the FDMS transaction processor. The CardEntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, the ResponseCaptureFlag property will be True, and the ResponseApprovalCode will contain an approval code.

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

FDMSHotel.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000" FDMSHotel.CardEntryDataSource = edsTrack1 FDMSHotel.Authorize() If (FDMSHotel.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailAggregate[0] = FDMSHotel.GetDetailAggregate() End If 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.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

AVSAndCVVOnly Method (DPaymentsSDK_FDMSHotel Class)

Performs an AVS/CVV only check using the specified Card data.

Object Oriented Interface

public function doAVSAndCVVOnly();

Procedural Interface

dpaymentssdk_fdmshotel_do_avsandcvvonly($res);

Remarks

This methods allows you to perform an AVS/CVV only request for verification purposes using the specified Card data. This does not authorize any funds on the card and only performs an AVS and CVV check. The TransactionAmount must be 0 for this transaction.

Note: For Retail transactions the CardEntryDataSource must be set to a manual entry value for this transaction.

FDMSHotel.CardEntryDataSource = edsManualEntryTrack1Capable FDMSHotel.CardNumber = "4444333322221111" FDMSHotel.CardExpMonth = 9 FDMSHotel.CardExpYear = 2015 FDMSHotel.CardCVVData = "999" FDMSHotel.CustomerAddress = "123 Nowhere Ln" FDMSHotel.CustomerZip = "90210" FDMSHotel.TransactionAmount = "0" FDMSHotel.AVSAndCVVOnly()

BalanceInquiry Method (DPaymentsSDK_FDMSHotel Class)

Performs a Balance Inquiry Request using the specified Card data.

Object Oriented Interface

public function doBalanceInquiry();

Procedural Interface

dpaymentssdk_fdmshotel_do_balanceinquiry($res);

Remarks

This methods allows you to perform a Balance Inquiry Request using the specified Card data. The balance amount will be returned via ResponseBalance. Note that Balance Inquiries do not place a hold on a cardholder's funds and are not captured.

FDMSHotel.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000" FDMSHotel.CardEntryDataSource = edsTrack1 FDMSHotel.BalanceInquiry() 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.

Config Method (DPaymentsSDK_FDMSHotel Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmshotel_do_config($res, $configurationstring);

Remarks

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

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

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

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

GetDetailAggregate Method (DPaymentsSDK_FDMSHotel Class)

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

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_fdmshotel_do_getdetailaggregate($res);

Remarks

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

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseCaptureFlag is false) the method fails with an error.

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

FDMSRetail.AuthorizeTrack1() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1 FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate() End If

GetHotelDataAggregate Method (DPaymentsSDK_FDMSHotel Class)

Returns an aggregate containing the Hotel/Lodging data of this transaction, which is then used for reversals.

Object Oriented Interface

public function doGetHotelDataAggregate();

Procedural Interface

dpaymentssdk_fdmshotel_do_gethoteldataaggregate($res);

Remarks

This method returns an aggregate containing all of the hotel/lodging industry data to reverse a transaction. This aggregate must be passed to the FDMSReversal class's HotelDataAggregate config in order to reverse the transaction.

The industry data included in the aggregate is:

• ArrivalDate
• CardholderName
• DepartureDate
• ExtraCharges
• InvoiceNumber
• NoShow
• PrestigiousIndicator
• ProgramIndicator
• ReferenceNumber
• RoomNumber
• RoomRate
• StayDuration

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

FDMSRetail.Authorize() If (FDMSRetail.ResponseCaptureFlag = True) Then ' Set Additional FDMSReverse properties as shown within the FDMSReverse help FDMSReverse.Config("HotelDataAggregate=" & FDMSRetail.GetHotelDataAggregate()) FDMSReverse.Reverse() End If

IncrementalAuth Method (DPaymentsSDK_FDMSHotel Class)

Performs an incremental authorization.

Object Oriented Interface

public function doIncrementalAuth($transactionid, $validationcode);

Procedural Interface

dpaymentssdk_fdmshotel_do_incrementalauth($res, $transactionid, $validationcode);

Remarks

This method sends an incremental authorization request through Datawire to the FDMS transaction processor and is used to add additional amounts to a previously authorized amount. The CardEntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, the ResponseCaptureFlag property will be True, and the ResponseApprovalCode will contain an approval code.

TransactionId is used to specify the ID of the originally authorized transaction. ValidationCode is used to specify the validation code returned in the response from the originally authorized transaction.

The amount of the IncrementalAuth is specified via TransactionAmount.

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

FDMSDetailRecord.ParseAggregate(FDMSHotel.GetDetailAggregate()) FDMSHotel.CardEntryDataSource = edsManuallyEntered FDMSHotel.CardNumber = "4444333322221111" FDMSHotel.CardExpMonth = 03 FDMSHotel.CardExpYear = 12 FDMSHotel.TransactionAmount = "5.00" // Incremental Auth Amount FDMSHotel.IncrementalAuth(FDMSHotel.ResponseTransactionId, FDMSHotel.ResponseValidationCode) If (FDMSHotel.ResponseCaptureFlag = True) Then //The AuthorizedAmount and SettlementAmount must include the sum of the incremental amount and //the original AuthorizedAmount. //If the transaction was originally for $10.00 and a $5.00 incremental amount is added the new //SettlementAmount should be "15.00" FDMSDetailRecord.AuthorizedAmount = "15.00" // FDMSDetailRecord.AuthorizedAmount + FDMSHotel.TransactionAmount FDMSDetailRecord.SettlementAmount = FDMSDetailRecord.AuthorizedAmount // Provided you wish to settle the entire authorized amount FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailAggregate[0] = FDMSDetailRecord.GetDetailAggregate() End If 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.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

Interrupt Method (DPaymentsSDK_FDMSHotel Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmshotel_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_FDMSHotel Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmshotel_do_reset($res);

Remarks

This method clears all properties to their default values.

Connected Event (DPaymentsSDK_FDMSHotel Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

DataPacketIn Event (DPaymentsSDK_FDMSHotel Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

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

Parameter List

 'datapacket'

Remarks

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

DataPacketOut Event (DPaymentsSDK_FDMSHotel Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

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

Parameter List

 'datapacket'

Remarks

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

Disconnected Event (DPaymentsSDK_FDMSHotel Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

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

Parameter List

 'statuscode'
 'description'

Remarks

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

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (DPaymentsSDK_FDMSHotel Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

SSLServerAuthentication Event (DPaymentsSDK_FDMSHotel Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_fdmshotel_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (DPaymentsSDK_FDMSHotel Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_fdmshotel_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_FDMSHotel Class)

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_fdmshotel_register_callback($res, 8, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (FDMSHotel Class)

FDMSHotel Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSHotel Class)

FDMSHotel Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors