FDMSHotel Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibcFDMSHotel

Remarks

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

The FDMSHotel component 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 component 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 component 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 component 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 component. FDMSHotel.URL = "https://staging1.datawire.net/sd/"; 'Retrieved with the FDMSRegister component.

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 EntryDataSource property, as it is used by the component 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 component receives a response, the result of the authorization will be available in several Response properties. The DatawireStatus and DatawireReturnCode 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 CaptureFlag will be True, and the ApprovalCode will contain an approval code that beings with "AP". (or "AL" for components 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 component. 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ApplicationId Property (FDMSHotel Component)

Identifies the merchant application to the Datawire System.

Syntax

property ApplicationId: String read get_ApplicationId write set_ApplicationId;

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

ArrivalDate Property (FDMSHotel Component)

The arrival date of the guest.

Syntax

property ArrivalDate: String read get_ArrivalDate write set_ArrivalDate;

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

Card Property (FDMSHotel Component)

Contains the customer's credit card information.

Syntax

property Card: TibcCCCard read get_Card write set_Card;

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

CardholderName Property (FDMSHotel Component)

The name of the Cardholder.

Syntax

property CardholderName: String read get_CardholderName write set_CardholderName;

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.

CustomerAddress Property (FDMSHotel Component)

The customer's billing address.

Syntax

property CustomerAddress: String read get_CustomerAddress write set_CustomerAddress;

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.

CustomerZip Property (FDMSHotel Component)

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

Syntax

property CustomerZip: String read get_CustomerZip write set_CustomerZip;

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.

DatawireId Property (FDMSHotel Component)

Identifies the merchant to the Datawire System.

Syntax

property DatawireId: String read get_DatawireId write set_DatawireId;

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

DepartureDate Property (FDMSHotel Component)

The departure date of the guest.

Syntax

property DepartureDate: String read get_DepartureDate write set_DepartureDate;

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

ExtraCharges Property (FDMSHotel Component)

List of extra charges for Hotel transactions.

Syntax

property ExtraCharges: String read get_ExtraCharges write set_ExtraCharges;

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.

FDMSPlatform Property (FDMSHotel Component)

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

Syntax

property FDMSPlatform: TibcFDMSPlatforms read get_FDMSPlatform write set_FDMSPlatform;

TibcFDMSPlatforms = (
  fpNorth,
  fpNashville
);

Default Value

fpNorth

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

InvoiceNumber Property (FDMSHotel Component)

The Folio or Room Agreement number assigned by the hotel.

Syntax

property InvoiceNumber: String read get_InvoiceNumber write set_InvoiceNumber;

Default Value

''

Remarks

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

Note: Mastercard only uses a 10 digit code.

MerchantNumber Property (FDMSHotel Component)

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

Syntax

property MerchantNumber: String read get_MerchantNumber write set_MerchantNumber;

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.

MerchantTerminalNumber Property (FDMSHotel Component)

Used to identify a unique terminal within a merchant location.

Syntax

property MerchantTerminalNumber: String read get_MerchantTerminalNumber write set_MerchantTerminalNumber;

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.

NoShow Property (FDMSHotel Component)

Indicates whether the guest did not show.

Syntax

property NoShow: Boolean read get_NoShow write set_NoShow;

Default Value

false

Remarks

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

PrestigiousIndicator Property (FDMSHotel Component)

Prestigious Lodging Program indicator for the Hotel Industry Type.

Syntax

property PrestigiousIndicator: TibcFDMSPrestigiousIndicators read get_PrestigiousIndicator write set_PrestigiousIndicator;

TibcFDMSPrestigiousIndicators = (
  piNotParticipating,
  pi500Limit,
  pi1000Limit,
  pi1500Limit
);

Default Value

piNotParticipating

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:

ProgramIndicator Property (FDMSHotel Component)

Special Program Indicator.

Syntax

property ProgramIndicator: Integer read get_ProgramIndicator write set_ProgramIndicator;

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:

Proxy Property (FDMSHotel Component)

A set of properties related to proxy access.

Syntax

property Proxy: TibcProxy read get_Proxy write set_Proxy;

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

ReferenceNumber Property (FDMSHotel Component)

A reference number assigned by the hotel.

Syntax

property ReferenceNumber: String read get_ReferenceNumber write set_ReferenceNumber;

Default Value

''

Remarks

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

Response Property (FDMSHotel Component)

Contains the response to an authorization request.

Syntax

property Response: TibcFDMSResponse read get_Response;

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSResponse type contains the following fields:

This property is read-only.

RoomNumber Property (FDMSHotel Component)

The Room Number assigned by the hotel.

Syntax

property RoomNumber: String read get_RoomNumber write set_RoomNumber;

Default Value

''

Remarks

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

RoomRate Property (FDMSHotel Component)

The daily room rate.

Syntax

property RoomRate: String read get_RoomRate write set_RoomRate;

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

RoomTax Property (FDMSHotel Component)

The daily room tax amount.

Syntax

property RoomTax: String read get_RoomTax write set_RoomTax;

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.

SSLAcceptServerCertEncoded Property (FDMSHotel Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded;
property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertEncoded Property (FDMSHotel Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded;
property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertStore Property (FDMSHotel Component)

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

Syntax

property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore;
property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject 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).

SSLCertStorePassword Property (FDMSHotel Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

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.

SSLCertStoreType Property (FDMSHotel Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibcCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

TibcCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (FDMSHotel Component)

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

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

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.

SSLProvider Property (FDMSHotel Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibcTSSLProviders read get_SSLProvider write set_SSLProvider;

TibcTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

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

SSLServerCertEncoded Property (FDMSHotel Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLServerCertEncoded: String read get_SSLServerCertEncoded;
property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;

Default Value

''

Remarks

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

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

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

StayDuration Property (FDMSHotel Component)

Length of hotel stay in days.

Syntax

property StayDuration: Integer read get_StayDuration write set_StayDuration;

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.

Timeout Property (FDMSHotel Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

TPPID Property (FDMSHotel Component)

Third Party Processor Identifier assigned by FDMS.

Syntax

property TPPID: String read get_TPPID write set_TPPID;

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.

TransactionAmount Property (FDMSHotel Component)

Purchase amount to be authorized.

Syntax

property TransactionAmount: String read get_TransactionAmount write set_TransactionAmount;

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.

TransactionNumber Property (FDMSHotel Component)

Uniquely identifies the transaction.

Syntax

property TransactionNumber: String read get_TransactionNumber write set_TransactionNumber;

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

URL Property (FDMSHotel Component)

Location of the Datawire server to which transactions are sent.

Syntax

property URL: String read get_URL write set_URL;

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 component. Once you Register and Activate the merchant using the FDMSRegister component, 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 component.

VisaIdentifier Property (FDMSHotel Component)

Additional merchant identification field used when authorizing Visa transactions.

Syntax

property VisaIdentifier: String read get_VisaIdentifier write set_VisaIdentifier;

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

Authorize Method (FDMSHotel Component)

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

Syntax

procedure Authorize();

Remarks

This method sends an authorization request through Datawire to the FDMS transaction processor. The EntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, the CaptureFlag property will be True, and the ApprovalCode 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 component. 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

AVSAndCVVOnly Method (FDMSHotel Component)

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

Syntax

procedure AVSAndCVVOnly();

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 EntryDataSource 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 (FDMSHotel Component)

Performs a Balance Inquiry Request using the specified Card data.

Syntax

procedure BalanceInquiry();

Remarks

This methods allows you to perform a Balance Inquiry Request using the specified Card data. The balance amount will be returned via Balance. 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 (FDMSHotel Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (FDMSHotel Component)

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

Syntax

function GetDetailAggregate(): String;

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 component'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 component to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the CaptureFlag is false) the method raises an exception.

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 (FDMSHotel Component)

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

Syntax

function GetHotelDataAggregate(): String;

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 component'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 (FDMSHotel Component)

Performs an incremental authorization.

Syntax

procedure IncrementalAuth(TransactionId: String; ValidationCode: String);

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 EntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, the CaptureFlag property will be True, and the ApprovalCode 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 component. 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Interrupt Method (FDMSHotel Component)

Interrupts the current action.

Syntax

procedure Interrupt();

Remarks

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

Reset Method (FDMSHotel Component)

Clears all properties to their default values.

Syntax

procedure Reset();

Remarks

This method clears all properties to their default values.

Connected Event (FDMSHotel Component)

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

Syntax

type TConnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

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 (FDMSHotel Component)

Fired when receiving a data packet from the transaction server.

Syntax

type TDataPacketInEvent = procedure (
  Sender: TObject;
  DataPacket: String;
  DataPacketB: TBytes
) of Object;

property OnDataPacketIn: TDataPacketInEvent read FOnDataPacketIn write FOnDataPacketIn;

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

DataPacketOut Event (FDMSHotel Component)

Fired when sending a data packet to the transaction server.

Syntax

type TDataPacketOutEvent = procedure (
  Sender: TObject;
  DataPacket: String;
  DataPacketB: TBytes
) of Object;

property OnDataPacketOut: TDataPacketOutEvent read FOnDataPacketOut write FOnDataPacketOut;

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

Disconnected Event (FDMSHotel Component)

This event is fired when a connection is closed.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

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 (FDMSHotel Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 (FDMSHotel Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  CertEncoded: String;
  CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

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 (FDMSHotel Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

Status Event (FDMSHotel Component)

Shows the progress of the FDMS/Datawire connection.

Syntax

type TStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnStatus: TStatusEvent read FOnStatus write FOnStatus;

Remarks

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

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the component are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the component will look for MagneticStripe data when authorizing the transaction, and will raises an exception because none is present.

Fields

Constructors

constructor Create();

constructor Create(valNumber: String; valExpMonth: Integer; valExpYear: Integer);

constructor Create(valMagneticStripe: String; valEntryDataSource: TibcEntryDataSources);

FDMSResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the FDMSECommerce or FDMSRetail component. The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

Config Settings (FDMSHotel Component)

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

FDMSHotel Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors