FDMSHotel Control
Properties Methods Events Configuration 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
FDMSHotel
Remarks
This control connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these controls go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the control. This control can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the control, any application or web page can be deployed without the need for expensive dedicated SSL servers.
The FDMSHotel control 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 control 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 control 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 control 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 control. FDMSHotel.URL = "https://staging1.datawire.net/sd/" 'Retrieved with the FDMSRegister control.
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 control
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 control 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 controls 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 control. 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 control with short descriptions. Click on the links for further details.
| ApplicationId | Identifies the merchant application to the Datawire System. |
| ArrivalDate | The arrival date of the guest. |
| CardCVVData | Three digit security code on back of card (optional). |
| CardCVVPresence | Indicates the presence of the card verification value. |
| CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
| CardExpMonth | Expiration month of the credit card specified in Number . |
| CardExpYear | Expiration year of the credit card specified in Number . |
| CardMagneticStripe | Track data read off of the card's magnetic stripe. |
| CardNumber | Customer's credit card number for the transaction. |
| CardholderName | The name of the Cardholder. |
| CustomerAddress | The customer's billing address. |
| CustomerZip | Customer's zip code (or postal code if outside of the USA). |
| DatawireId | Identifies the merchant to the Datawire System. |
| DepartureDate | The departure date of the guest. |
| ExtraCharges | List of extra charges for Hotel transactions. |
| FDMSPlatform | Specifies the FDMS platform that the transactions will be processed on. |
| InvoiceNumber | The Folio or Room Agreement number assigned by the hotel. |
| MerchantNumber | A unique number used to identify the merchant within the FDMS and Datawire systems. |
| MerchantTerminalNumber | Used to identify a unique terminal within a merchant location. |
| NoShow | Indicates whether the guest did not show. |
| PrestigiousIndicator | Prestigious Lodging Program indicator for the Hotel Industry Type. |
| ProgramIndicator | Special Program Indicator. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| ReferenceNumber | A reference number assigned by the hotel. |
| ResponseApprovalCode | Contains an authorization code when a transaction has been approved, or an error message if declined. |
| ResponseAuthorizedAmount | When supporting partial authorizations, this is the amount actually charged to the credit card. |
| ResponseAVSResult | Contains the Address Verification System result code. |
| ResponseBalance | Contains the remaining available balance left on the card. |
| ResponseCaptureFlag | Indicates whether the authorization was successful, and whether it can be settled. |
| ResponseCardLevelResult | Two character card level results property returned in the response to Visa authorizations. |
| ResponseCommercialCard | Indicates whether the credit card charged is a corporate commercial card. |
| ResponseCVVResult | Contains the returned CVV result code (if CVV data was sent in the request). |
| ResponseDatawireReturnCode | Contains an error code providing more details about the DatawireStatus received. |
| ResponseDatawireStatus | Status of the communication with Datawire. |
| ResponseReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
| ResponseTransactionDate | Local transaction date returned from the server in MMDDYY format. |
| ResponseTransactionId | Contains the Visa Transaction Identifier or MasterCard Reference Number. |
| ResponseValidationCode | Additional information generated by the card issuer. |
| RoomNumber | The Room Number assigned by the hotel. |
| RoomRate | The daily room rate. |
| RoomTax | The daily room tax amount. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| StayDuration | Length of hotel stay in days. |
| Timeout | A timeout for the component. |
| TPPID | Third Party Processor Identifier assigned by FDMS. |
| TransactionAmount | Purchase amount to be authorized. |
| TransactionNumber | Uniquely identifies the transaction. |
| URL | Location of the Datawire server to which transactions are sent. |
| VisaIdentifier | Additional merchant identification field used when authorizing Visa transactions. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Authorize | Authorizes a credit card using track1, track2, or manually entered card data. |
| AVSAndCVVOnly | Performs an AVS/CVV only check using the specified Card data. |
| BalanceInquiry | Performs a Balance Inquiry Request using the specified Card data. |
| Config | Sets or retrieves a configuration setting . |
| GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
| GetHotelDataAggregate | Returns an aggregate containing the Hotel/Lodging data of this transaction, which is then used for reversals. |
| IncrementalAuth | Performs an incremental authorization. |
| Interrupt | Interrupts the current action. |
| Reset | Clears all properties to their default values. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| Status | Shows the progress of the FDMS/Datawire connection. |
Configuration Settings
The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.
| ClientTimeout | Indicates timeout client application will wait for response. |
| CurrencyCode | Currency Code for this transaction. |
| DebugTrace | Whether to enable debug logging. |
| ACI | Requested Authorization Characteristics Indicator (ACI). |
| AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
| CustomerAddress | The customer's billing address. |
| CustomerZip | Customer's zip code (or postal code if outside of the USA). |
| TerminalLaneNumber | The Unique Terminal Lane Number. |
| TransArmorMode | Specifies the TransArmor Security Level to use. |
| UpdateTransArmorKey | Allows you to update your TransArmor Key. |
| TransArmorKey | Specifies the TransArmor key used to perform the encryption. |
| TransArmorKeyId | Specifies the Id of the TransArmor key used to perform the encryption. |
| TransArmorToken | A TransArmor Token used in place of a card number or magnetic stripe data. |
| TransArmorProviderId | The Id of the Provider that issued a TransArmorToken. |
| TransArmorUpdateIndicator | Indicates whether your TransArmorKey needs to be updated. |
| GetTransArmorToken | Allows you to retrieve a TransArmor Token for a specified card. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |