FDMSHotel Control

Properties   Methods   Events   Config Settings   Errors  

The FDMSHotel control is an advanced tool used to authorize credit cards in a retail environment, where the customer is purchasing products or services in person. This control 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.

ApplicationIdIdentifies the merchant application to the Datawire System.
ArrivalDateThe arrival date of the guest.
CardTypeType of credit card being used in this transaction.
CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardIsEncryptedDetermines whether data set to the Number or MagneticStripe properties is validated.
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
CardholderNameThe name of the Cardholder.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
DatawireIdIdentifies the merchant to the Datawire System.
DepartureDateThe departure date of the guest.
ExtraChargesList of extra charges for Hotel transactions.
FDMSPlatformSpecifies the FDMS platform that the transactions will be processed on.
InvoiceNumberThe Folio or Room Agreement number assigned by the hotel.
MerchantNumberA unique number used to identify the merchant within the FDMS and Datawire systems.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
NoShowIndicates whether the guest did not show.
PrestigiousIndicatorPrestigious Lodging Program indicator for the Hotel Industry Type.
ProgramIndicatorSpecial Program Indicator.
ProxyAuthSchemeThis property is used to tell the control which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the control whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
ReferenceNumberA reference number assigned by the hotel.
ResponseApprovalCodeContains an authorization code when a transaction has been approved, or an error message if declined.
ResponseAuthorizedAmountWhen supporting partial authorizations, this is the amount actually charged to the credit card.
ResponseAVSResultContains the Address Verification System result code.
ResponseBalanceContains the remaining available balance left on the card.
ResponseCaptureFlagIndicates whether the authorization was successful, and whether it can be settled.
ResponseCardLevelResultTwo character card level results property returned in the response to Visa authorizations.
ResponseCommercialCardIndicates whether the credit card charged is a corporate commercial card.
ResponseCVVResultContains the returned CVV result code (if CVV data was sent in the request).
ResponseDatawireReturnCodeContains an error code providing more details about the DatawireStatus received.
ResponseDatawireStatusStatus of the communication with Datawire.
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseTransactionDateLocal transaction date returned from the server in MMDDYY format.
ResponseTransactionIdContains the Transaction Identifier or MasterCard Reference Number.
ResponseValidationCodeAdditional information generated by the card issuer.
RoomNumberThe Room Number assigned by the hotel.
RoomRateThe daily room rate.
RoomTaxThe daily room tax amount.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
StayDurationLength of hotel stay in days.
TimeoutA timeout for the control.
TPPIDThird Party Processor Identifier assigned by FDMS.
TransactionAmountPurchase amount to be authorized.
TransactionNumberUniquely identifies the transaction.
URLLocation of the Datawire server to which transactions are sent.
VisaIdentifierAdditional 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.

AuthorizeAuthorizes a credit card using track1, track2, or manually entered card data.
AVSAndCVVOnlyPerforms an AVS/CVV only check using the specified Card data.
BalanceInquiryPerforms a Balance Inquiry Request using the specified Card data.
ConfigSets or retrieves a configuration setting.
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for settlement.
GetHotelDataAggregateReturns an aggregate containing the Hotel/Lodging data of this transaction, which is then used for reversals.
IncrementalAuthPerforms an incremental authorization.
InterruptInterrupts the current action.
ResetClears 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.

ConnectedThis event is fired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedThis event is fired when a connection is closed.
ErrorFired when information is available about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StatusShows the progress of the FDMS/Datawire connection.

Config Settings


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

ACIRequested Authorization Characteristics Indicator (ACI).
AllowPartialAuthsIndicates whether partial authorizations are to be supported.
ClientTimeoutIndicates timeout client application will wait for response.
CurrencyCodeCurrency Code for this transaction.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
DebugTraceWhether to enable debug logging.
GetTransArmorTokenAllows you to retrieve a TransArmor Token for a specified card.
IsOnlineRefundIndicates whether a transaction is Online Refund Authorization.
TerminalLaneNumberThe Unique Terminal Lane Number.
TransArmorKeySpecifies the TransArmor key used to perform the encryption.
TransArmorKeyIdSpecifies the Id of the TransArmor key used to perform the encryption.
TransArmorModeSpecifies the TransArmor Security Level to use.
TransArmorProviderIdThe Id of the Provider that issued a TransArmorToken.
TransArmorTokenA TransArmor Token used in place of a card number or magnetic stripe data.
TransArmorTokenTypeSpecifies the type of TransArmor token that will be used.
TransArmorUpdateIndicatorIndicates whether your TransArmorKey needs to be updated.
UpdateTransArmorKeyAllows you to update your TransArmor Key.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the control binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

ApplicationId Property (FDMSHotel Control)

Identifies the merchant application to the Datawire System.

Syntax

fdmshotelcontrol.ApplicationId[=string]

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

Data Type

String

ArrivalDate Property (FDMSHotel Control)

The arrival date of the guest.

Syntax

fdmshotelcontrol.ArrivalDate[=string]

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

Type of credit card being used in this transaction.

Syntax

fdmshotelcontrol.CardType[=integer]

Possible Values

ctUnknown(0), 
ctVisa(1), 
ctMasterCard(2), 
ctAMEX(3), 
ctDiscover(4), 
ctDiners(5), 
ctJCB(6), 
ctVisaElectron(7), 
ctMaestro(8), 
ctLaser(10)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

ctUnknown (0) Invalid or unknown prefix, card type not known.
ctVisa (1) Visa or Delta Card.
ctMasterCard (2) MasterCard.
ctAMEX (3) American Express Card.
ctDiscover (4) Discover Card.
ctDiners (5) Diners Club or Carte Blanche Card.
ctJCB (6) JCB Card.
ctVisaElectron (7) Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8) Maestro Card
ctLaser (10) Laser Card (Ireland)

This property is not available at design time.

Data Type

Integer

CardCVVData Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.CardCVVData[=string]

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

Indicates the presence of the card verification value.

Syntax

fdmshotelcontrol.CardCVVPresence[=integer]

Possible Values

cvpNotProvided(0), 
cvpProvided(1), 
cvpIllegible(2), 
cvpNotOnCard(3)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The control 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 (FDMSHotel Control)

This property contains a 1-character code identifying the source of the customer data.

Syntax

fdmshotelcontrol.CardEntryDataSource[=integer]

Possible Values

edsTrack1(0), 
edsTrack2(1), 
edsManualEntryTrack1Capable(2), 
edsManualEntryTrack2Capable(3), 
edsManualEntryNoCardReader(4), 
edsTrack1Contactless(5), 
edsTrack2Contactless(6), 
edsManualEntryContactlessCapable(7), 
edsIVR(8), 
edsKiosk(9)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

edsTrack1 (0) Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1) Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2) Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (CardNumber, CardExpMonth, and CardExpYear are sent).
edsKiosk (9)Automated kiosk transaction. Track1 or Track2 data must be sent in CardMagneticStripe, the transaction cannot be manually entered.

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.

TSYSHCBenefit edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce edsManualEntryNoCardReader
TSYSHCRetail edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (FDMSHotel Control)

Expiration month of the credit card specified in Number .

Syntax

fdmshotelcontrol.CardExpMonth[=integer]

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

Expiration year of the credit card specified in Number .

Syntax

fdmshotelcontrol.CardExpYear[=integer]

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

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

fdmshotelcontrol.CardIsEncrypted[=boolean]

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

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

Syntax

fdmshotelcontrol.CardMagneticStripe[=string]

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

control.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" control.CardEntryDataSource = edsTrack1 or control.CardMagneticStripe = "4788250000028291=05121015432112345678" control.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 (FDMSHotel Control)

Customer's credit card number for the transaction.

Syntax

fdmshotelcontrol.CardNumber[=string]

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

The name of the Cardholder.

Syntax

fdmshotelcontrol.CardholderName[=string]

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

The customer's billing address.

Syntax

fdmshotelcontrol.CustomerAddress[=string]

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

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

Syntax

fdmshotelcontrol.CustomerZip[=string]

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

Identifies the merchant to the Datawire System.

Syntax

fdmshotelcontrol.DatawireId[=string]

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 control). 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 (FDMSHotel Control)

The departure date of the guest.

Syntax

fdmshotelcontrol.DepartureDate[=string]

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

List of extra charges for Hotel transactions.

Syntax

fdmshotelcontrol.ExtraCharges[=string]

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.

Value Hotel Definition
0 None.
2 Restaurant.
3 Gift Shop.
4 Mini Bar.
5 Telephone.
6 Other.
7 Laundry.

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

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

Syntax

fdmshotelcontrol.FDMSPlatform[=integer]

Possible Values

fpNorth(0), 
fpNashville(1)

Default Value

0

Remarks

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

fpNorth (0) North/Cardnet platform.
fpNashville (1) Nashville platform.

Data Type

Integer

InvoiceNumber Property (FDMSHotel Control)

The Folio or Room Agreement number assigned by the hotel.

Syntax

fdmshotelcontrol.InvoiceNumber[=string]

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

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

Syntax

fdmshotelcontrol.MerchantNumber[=string]

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

Used to identify a unique terminal within a merchant location.

Syntax

fdmshotelcontrol.MerchantTerminalNumber[=string]

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

Indicates whether the guest did not show.

Syntax

fdmshotelcontrol.NoShow[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

PrestigiousIndicator Property (FDMSHotel Control)

Prestigious Lodging Program indicator for the Hotel Industry Type.

Syntax

fdmshotelcontrol.PrestigiousIndicator[=integer]

Possible Values

piNotParticipating(0), 
pi500Limit(1), 
pi1000Limit(2), 
pi1500Limit(3)

Default Value

0

Remarks

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

Valid indicators include:

piNotParticipating (0) Non-Participating Property
pi500Limit (1) Prestigious Property with $500 Limit
pi1000Limit (2) Prestigious Property with $1000 Limit
pi1500Limit (3) Prestigious Property with $1500 Limit

Data Type

Integer

ProgramIndicator Property (FDMSHotel Control)

Special Program Indicator.

Syntax

fdmshotelcontrol.ProgramIndicator[=integer]

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:

Value Description
1 (Default) Standard
2 No Show
3 Card Deposit
4 Delayed Charge
5 Express Service
6 Assured Reservation

Data Type

Integer

ProxyAuthScheme Property (FDMSHotel Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

fdmshotelcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control 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 control. Look at the configuration file for the control 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 (FDMSHotel Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

fdmshotelcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.ProxyPassword[=string]

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

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fdmshotelcontrol.ProxyPort[=integer]

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

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

Syntax

fdmshotelcontrol.ProxyServer[=string]

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

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fdmshotelcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

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:

psAutomatic (0)Default setting. If the URL is an https URL, the control will use the psTunnel option. If the URL is an http URL, the control will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.ProxyUser[=string]

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

A reference number assigned by the hotel.

Syntax

fdmshotelcontrol.ReferenceNumber[=string]

Default Value

""

Remarks

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

Data Type

String

ResponseApprovalCode Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.ResponseApprovalCode

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:

Approval CodeMeaning
CALL CARD CENTER System problem.
CVV2 DECLINED Association indicated the transaction wasn't approved due to mismatch of the CVV2 value, but would have been approved had the CVV2 values matched.
DECLINED Decline the sale.
EXPIRED CARD Card is expired.
HOLD - CALL CTR Problem with card.
INV ACCT NUM Invalid card number or prefix.
INV CREDIT PLAN Private label message only.
INV EXP DATE Invalid expiration date.
INV MER ID Merchant is not set up on Host file.
INV TERM ID Terminal is not set up on Host file.
PLEASE RETRY System time-out or other generic system error.
REFERRAL Referral.
REFERRAL INV TR2 Referral - Invalid Track II Data.
REFERRAL INV TR1 Referral - Invalid Track I Data.
SERV NOT ALLOWED Merchant is not entitled to this card type.
SYS REJECT Transaction was rejected by the system due to "batch in progress indicators" being turned on.
UNSUPPORTED TRAN Batch Review (Tran Code 97) not supported.

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.ResponseAuthorizedAmount

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

Contains the Address Verification System result code.

Syntax

fdmshotelcontrol.ResponseAVSResult

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:

CodeDescription
AStreet address matches, ZIP does not.
BStreet address matches. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
CStreet address and postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
DStreet address and postal code match.
FStreet address and postal code match. (U.K. only)
GAddress information not verified for international transaction. (Non-US Issuer does not participate)
IAddress information not verified.
MStreet address and postal code match.
NNo match. Transaction contained postal/ZIP code only, or street address only, or both postal code and street address. Also used when transaction requests AVS, but sends no AVS data.
PPostal code matches. Postal code and street address were sent but street address not verified due to incompatible formats.
RRetry - Issuer system unavailable.
SService not supported by issuer.
UAddress information is unavailable.
WNot applicable.
YStreet address and postal code match.
ZPostal/ZIP matches; street address does not match or street address not included in the request.

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

DStreet addresses and postal codes match for international transaction.
IAddress information not verified for international transaction.
MStreet addresses and postal codes match for international transaction.
PPostal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code).

This property is read-only.

Data Type

String

ResponseBalance Property (FDMSHotel Control)

Contains the remaining available balance left on the card.

Syntax

fdmshotelcontrol.ResponseBalance

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

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

Syntax

fdmshotelcontrol.ResponseCaptureFlag

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 control. 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 (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.ResponseCardLevelResult

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

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

Syntax

fdmshotelcontrol.ResponseCommercialCard

Possible Values

cctNotCommercial(0), 
cctPurchaseCard(1), 
cctCorporateCard(2), 
cctBusinessCard(3), 
cctUnknown(4)

Default Value

0

Remarks

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

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

fccNotCommercial (0)Card presented for authorization is not a commercial card
fccPurchaseCard (1)Card presented for authorization is a Purchasing Card.
fccCorporateCard (2)Card presented for authorization is a Corporate Card.
fccBusinessCard (3)Card presented for authorization is a Business Card.
fccUnknown (4)Unable to obtain information from processor.

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

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

Syntax

fdmshotelcontrol.ResponseCVVResult

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:

MCVV2 match.
NCVV2 no match.
PNot processed.
SMerchant has indicated that CVV2 is not present on card.
UUnknown, or Issuer does not participate.
XServer Provider did not respond (Default).

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.ResponseDatawireReturnCode

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:

000 Transaction successfully passed through the Datawire system to the FDMS Payment Processor and back.
200 Host Busy - The processor's Host is busy and is currently unable to service this request.
201 Host Unavailable - The processor's Host is currently unavailable. For example, the server is sending NAK.
202 Host Connect Error - Could not connect to the processor's Host.
203 Host Drop - The processor's Host disconnected during the transaction before sending a response.
204 Host Comm Error - An error was encountered while communicating with the processor's Host.
205 No Response - No response from the processor's Host
206 Host Send Error - An error has encountered when sending the request to the processor, and the Host daemon cannot continue sending packets to the processor because the connection is broken.
405 Vxn Timeout - The request could not be processed.
505 Network Error - The request could not be processed.

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (FDMSHotel Control)

Status of the communication with Datawire.

Syntax

fdmshotelcontrol.ResponseDatawireStatus

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:

OKTransaction has successfully passed through the Datawire system to the FDMS Payment processor and back.
AuthenticationErrorDatawireId in the request was not successfully authenticated.
UnknownServiceIDServiceId part of the URL (in the Service Discovery or Ping request) is unknown.
WrongSessionContextThe SessionContext element of the Session Transaction request does not match the SessionContext returned by the InitiateSession response (applicable to the FDMSSettle control).
AccessDeniedGenerally, occurs when you try to register a merchant after a merchant has already been activated to use the Datawire VXN.
FailedYour Merchant Registration has failed. Contact tech.support@datawire.net for more information.
RetryRegistration is not yet complete. You must send the Registration request again.
TimeoutNo response from the Service Provider was received during the expected period of time.
XMLErrorRequest contains some XML error, such as malformed XML, violation of this DTD, etc.
OtherErrorUnspecified error occurred.
008Network Error

This property is read-only.

Data Type

String

ResponseReturnedACI Property (FDMSHotel Control)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

fdmshotelcontrol.ResponseReturnedACI

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.

ValueDescription
I Incremental to a previously approved authorization
P Preferred Customer (auto rental, hotel, and transport)
Y Transaction is requesting service in CPS/2000 Received by issuer on first authorization, saved in terminal, and returned on reversal and settlement transactions:
" " (Space) Transaction not submitted for REPS processing
A Normal qualified
C Qualified, customer-activated terminal
E Qualified Retail
F Card Not Present (Account Funding - with AVS and CVV2)
I Qualified incremental
J Card not present - Recurring bill payment
K Qualified CPS/Retail Key Entry (AVS is required with K)
N Not qualified
P Qualified Preferred
R AVS not Required - Only available to VISA Health Care and Select Developing Markets
S Card Not Present (E-Commerce - 3D Secure Attempt)
T Transaction cannot participate in CPS programs
V Qualified Address Verification
U Card Not Present (E-Commerce - 3D Secure)
W Card Not Present (E-Commerce - Non 3D Secure w/AVS)

This property is read-only.

Data Type

String

ResponseTransactionDate Property (FDMSHotel Control)

Local transaction date returned from the server in MMDDYY format.

Syntax

fdmshotelcontrol.ResponseTransactionDate

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

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

fdmshotelcontrol.ResponseTransactionId

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

Additional information generated by the card issuer.

Syntax

fdmshotelcontrol.ResponseValidationCode

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

The Room Number assigned by the hotel.

Syntax

fdmshotelcontrol.RoomNumber[=string]

Default Value

""

Remarks

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

Data Type

String

RoomRate Property (FDMSHotel Control)

The daily room rate.

Syntax

fdmshotelcontrol.RoomRate[=string]

Default Value

""

Remarks

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

Examples:

Actual Room Rate RoomRate Value
$49.99 49
$125.00 125

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

Data Type

String

RoomTax Property (FDMSHotel Control)

The daily room tax amount.

Syntax

fdmshotelcontrol.RoomTax[=string]

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

This is the certificate (PEM/Base64 encoded).

Syntax

fdmshotelcontrol.SSLAcceptServerCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FDMSHotel Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmshotelcontrol.SSLCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.SSLCertStore[=string]

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.SSLCertStorePassword[=string]

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

This is the type of certificate store for this certificate.

Syntax

fdmshotelcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.SSLCertSubject[=string]

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (FDMSHotel Control)

This specifies the SSL/TLS implementation to use.

Syntax

fdmshotelcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control 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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (FDMSHotel Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmshotelcontrol.SSLServerCertEncoded

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

StayDuration Property (FDMSHotel Control)

Length of hotel stay in days.

Syntax

fdmshotelcontrol.StayDuration[=integer]

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

A timeout for the control.

Syntax

fdmshotelcontrol.Timeout[=integer]

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

TPPID Property (FDMSHotel Control)

Third Party Processor Identifier assigned by FDMS.

Syntax

fdmshotelcontrol.TPPID[=string]

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

Purchase amount to be authorized.

Syntax

fdmshotelcontrol.TransactionAmount[=string]

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

Uniquely identifies the transaction.

Syntax

fdmshotelcontrol.TransactionNumber[=string]

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 controls 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 (FDMSHotel Control)

Location of the Datawire server to which transactions are sent.

Syntax

fdmshotelcontrol.URL[=string]

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

Data Type

String

VisaIdentifier Property (FDMSHotel Control)

Additional merchant identification field used when authorizing Visa transactions.

Syntax

fdmshotelcontrol.VisaIdentifier[=string]

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:

First 2 bytes: This is the Visa Id, which at the time of this writing should always be "0B"
Next 5 bytes: Visa Business Identifier (BID)
Final 12 bytes: Text representation of the hexadecimal Visa secret Agent Unique Account Result (AUAR).. {0x01, 0x02, 0x03, 0x04, 0x05, 0xFF} will be represented as "0102030405FF".
If there are multiple visa identifiers they may be added by setting VisaIdentifier with a comma-delimited list. There can be a maximum of three entries in this list.

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

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

Syntax

fdmshotelcontrol.Authorize 

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 control. 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 control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

AVSAndCVVOnly Method (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.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 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 (FDMSHotel Control)

Performs a Balance Inquiry Request using the specified Card data.

Syntax

fdmshotelcontrol.BalanceInquiry 

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

Sets or retrieves a configuration setting.

Syntax

fdmshotelcontrol.Config ConfigurationString

Remarks

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

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

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

Syntax

fdmshotelcontrol.GetDetailAggregate 

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 control'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 control 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 (FDMSHotel Control)

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

Syntax

fdmshotelcontrol.GetHotelDataAggregate 

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 control's HotelDataAggregate config in order to reverse the transaction.

The industry data included in the aggregate is:

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

Performs an incremental authorization.

Syntax

fdmshotelcontrol.IncrementalAuth 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 control. 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 control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

Interrupt Method (FDMSHotel Control)

Interrupts the current action.

Syntax

fdmshotelcontrol.Interrupt 

Remarks

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

Reset Method (FDMSHotel Control)

Clears all properties to their default values.

Syntax

fdmshotelcontrol.Reset 

Remarks

This method clears all properties to their default values.

Connected Event (FDMSHotel Control)

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

Syntax

Sub fdmshotelcontrol_Connected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSHotel Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub fdmshotelcontrol_DataPacketIn(DataPacket As String)

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

DataPacketOut Event (FDMSHotel Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub fdmshotelcontrol_DataPacketOut(DataPacket As String)

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

Disconnected Event (FDMSHotel Control)

This event is fired when a connection is closed.

Syntax

Sub fdmshotelcontrol_Disconnected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (FDMSHotel Control)

Fired when information is available about errors during data delivery.

Syntax

Sub fdmshotelcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 (FDMSHotel Control)

Fired after the server presents its certificate to the client.

Syntax

Sub fdmshotelcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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

Fired when secure connection progress messages are available.

Syntax

Sub fdmshotelcontrol_SSLStatus(Message As String)

Remarks

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

Status Event (FDMSHotel Control)

Shows the progress of the FDMS/Datawire connection.

Syntax

Sub fdmshotelcontrol_Status(Message As String)

Remarks

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

Config Settings (FDMSHotel Control)

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

FDMSHotel Config Settings

ACI:   Requested Authorization Characteristics Indicator (ACI).

This 1-character field contains the Requested ACI used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the ACI may be set to "N". By default, the control sends "Y" for all authorizations. This config should be set immediately before calling the Authorize method.

AllowPartialAuths:   Indicates whether partial authorizations are to be supported.

When this setting is True, if the credit card being authorized does not contain sufficient funds to cover the TransactionAmount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount. The customer must then use another form of payment to make up the remainder. The total amount authorized by FDMS will be returned in the ResponseAuthorizedAmount configuration setting. For instance, if the TransactionAmount is $100.00, but card only has a $50.00 balance, the card is charged for $50.00, and the ResponseAuthorizedAmount will be "50.00". The merchant may then collect the remaining $50 in cash, check, credit card, or any other acceptable form of payment. This setting is False by default.

ClientTimeout:   Indicates timeout client application will wait for response.

This setting indicates the interval of time, in seconds, a client will wait for the response for any given request. Normally this value is set to a value 5 seconds less than the Timeout value to allow for a response to be received from Datawire. It may be changed independently by setting this configuration setting AFTER setting the Timeout property. Note that too small a value will cause Datawire to reject a transaction immediately.

CurrencyCode:   Currency Code for this transaction.

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

CustomerAddress:   The customer's billing address.

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 configuration setting 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:   Customer's zip code (or postal code if outside of the USA).

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 configuration setting is 10 characters.

DebugTrace:   Whether to enable debug logging.

If set to True the Status event will fire with the raw request and response information. This is helpful for debugging.

GetTransArmorToken:   Allows you to retrieve a TransArmor Token for a specified card.

This setting allows you to retrieve a TransArmorToken for a specified card. Upon a successful call, both TransArmorToken and TransArmorProviderId will be populated with the values assigned to you by FDMS. In particular, this method is used when performing a Credit or Force using a TransArmorMode of '0' (Tokenization Only) or '1' (Encryption and Tokenization). So prior to adding the needed detail record to the FDMSSettle component, you will first retrieve a TransArmorToken by calling GetTransArmorToken for the card that you wish to use. The received TransArmorToken and TransArmorProviderId will then be set within the detail record (instead of the card data) and can be added to the FDMSSettle component.

IsOnlineRefund:   Indicates whether a transaction is Online Refund Authorization.

Set this config to True when sending an online purchase return authorization request.

TerminalLaneNumber:   The Unique Terminal Lane Number.

This setting allows you to specify a terminal lane number to uniquely identify each POS terminal within a merchant location. This setting takes an alphanumeric value up to 8 characters in length. Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.

TransArmorKey:   Specifies the TransArmor key used to perform the encryption.

This setting allows you to retrieve and specify the key used to perform the encryption of the Card data. When a successful call to UpdateTransArmorKey is made, this setting will be populated with your assigned key. Store this key for future use. This setting is required for any transactions that you perform using TransArmor encryption (TransArmorMode = 1).

TransArmorKeyId:   Specifies the Id of the TransArmor key used to perform the encryption.

This setting allows you to retrieve and specify the Id of the TransArmorKey used to perform the encryption of the Card data. When a successful call to UpdateTransArmorKey is made, this setting will be populated with your assigned key ID. Store this key Id for future use. This setting is required for any transactions that you perform using TransArmor encryption (TransArmorMode = 1).

TransArmorMode:   Specifies the TransArmor Security Level to use.

This setting allows you to specify the type of TransArmor security to be used when authorizing and settling transactions. The available modes are:

0 (default) TransArmor security is not used.
1 TransArmor Encryption and Tokenization. The Card data will be encrypted using the specified TransArmorKey in the initial authorization. All subsequent requests (including settlement) will use the returned TransArmorToken. The type of encryption used is RSA and is currently the only supported encryption type.
2 TransArmor Tokenization only. The Card data will not be encrypted. A TransArmorToken will be returned for the transaction and will be used in all subsequent requests (including settlement).

Note: Your merchant account must be configured to use TransArmor. The configuration is 'Mode' specific and thus you must inform FDMS which type of TransArmor Security Level you wish to use.

TransArmorProviderId:   The Id of the Provider that issued a TransArmorToken.

This setting allows you to retrieve and specify the Provider Id returned in an authorization response when using TransArmor (TransArmorMode = 1 OR 2). When an authorization is performed using TransArmor, a Provider Id will be returned in the response along with a TransArmorToken. This Provider Id will be used in all subsequent requests (such as reversals and settlement) and must be specified along with TransArmorToken.

TransArmorToken:   A TransArmor Token used in place of a card number or magnetic stripe data.

This setting allows you to retrieve and specify the Token returned in an authorization response when using TransArmor (TransArmorMode = 1 OR 2). When an authorization is performed using TransArmor, a Token will be returned in the response. This Token will be used in all subsequent requests (such as reversals and settlement) in place of the CardNumber or CardMagneticStripe.

TransArmorTokenType:   Specifies the type of TransArmor token that will be used.

This setting allows you to retrieve and specify the type of TransArmor token used.

TransArmorUpdateIndicator:   Indicates whether your TransArmorKey needs to be updated.

This setting allows you to identify whether your TransArmorKey needs to be updated. When performing an authorization using TransArmor, it is possible that FDMS will request that you update your TransArmorKey. This setting should be queried after every authorization is performed. If the returned value is "False", no key update is required. If "True" is returned, you should update your key by calling UpdateTransArmorKey after the completion of the function in progress (i.e. authorization). If the key update request was successful, you should update your TransArmorKey and TransArmorKeyId values. If the key update request fails, you can continue using your same TransArmorKey and TransArmorKeyId values until another key update indicator is received.

UpdateTransArmorKey:   Allows you to update your TransArmor Key.

This setting allows you to retrieve a TransArmorKey that will be used to perform TransArmor encryption (TransArmorMode = 1). When this is set to "true" the control will perform the request immediately. Upon a successful call, both TransArmorKey and TransArmorKeyId will be populated with the values assigned to you by FDMS.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the control will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the control whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by controls that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the control fails with an error.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the control returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the control binds.

This must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the control will use IPv4 exclusively. When set to 1, the control will use IPv6 exclusively. To instruct the control to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the control will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the control is the same.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the control will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the control will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The control will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the control fails with an error.

When set to 0 (default) the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the control will use OCSP to check the validity of the server certificate. If set to 1 or 2, the control will first obtain the OCSP URL from the server certificate's OCSP extension. The control will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the control fails with an error.

When set to 0 (default) the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the control when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is by default, but can be set to to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the control will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the control will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the control will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the control fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (FDMSHotel Control)

FDMSHotel Errors

20433    Invalid index.
20502    Invalid length for this property.
20503    Invalid data format for this property.
20504    Value is out of range.
20505    Credit card digit check failed.
20506    Card date invalid.
20507    Card expired.
20520    Corrupt response.
20521    Response payload empty.
20522    Response truncated.
20527    Invalid timeout value.
20594    A property required for this transaction is missing.
20530    Error in XML response.
20531    Status code received in response indicates an error condition.
20532    Return code received in response indicates an error condition.
20533    Cannot generate detail aggregate - this transaction was not successfully authorized.
20534    Internal error constructing payload.

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

HTTP Errors

20119    Firewall Error. Error description contains detailed message.
20144    Busy executing current method.
20152    HTTP protocol error. The error message has the server response.
20153    No server specified in URL
20154    Specified URLScheme is invalid.
20156    Range operation is not supported by server.
20157    Invalid cookie index (out of range).
20302    Interrupted.
20303    Can't open AttachedFile.

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

TCPClient Errors

20101    You cannot change the RemotePort at this time. A connection is in progress.
20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
20103    The RemoteHost address is invalid (0.0.0.0).
20105    Already connected. If you want to reconnect, close the current connection first.
20107    You cannot change the LocalPort at this time. A connection is in progress.
20108    You cannot change the LocalHost at this time. A connection is in progress.
20113    You cannot change MaxLineLength at this time. A connection is in progress.
20117    RemotePort cannot be zero. Please specify a valid service port number.
20118    You cannot change the UseConnection option while the control is active.
20136    Operation would block.
20202    Timeout.
20212    Action impossible in control's present state.
20213    Action impossible while not connected.
20214    Action impossible while listening.
20302    Timeout.
20303    Could not open file.
20435    Unable to convert string to selected CodePage.
21106    Already connecting. If you want to reconnect, close the current connection first.
21118    You need to connect first.
21120    You cannot change the LocalHost at this time. A connection is in progress.
21121    Connection dropped by remote host.

SSL Errors

20271    Cannot load specified security library.
20272    Cannot open certificate store.
20273    Cannot find specified certificate.
20274    Cannot acquire security credentials.
20275    Cannot find certificate chain.
20276    Cannot verify certificate chain.
20277    Error during handshake.
20281    Error verifying certificate.
20282    Could not find client certificate.
20283    Could not find server certificate.
20284    Error encrypting data.
20285    Error decrypting data.

TCP/IP Errors

25005    [10004] Interrupted system call.
25010    [10009] Bad file number.
25014    [10013] Access denied.
25015    [10014] Bad address.
25023    [10022] Invalid argument.
25025    [10024] Too many open files.
25036    [10035] Operation would block.
25037    [10036] Operation now in progress.
25038    [10037] Operation already in progress.
25039    [10038] Socket operation on non-socket.
25040    [10039] Destination address required.
25041    [10040] Message too long.
25042    [10041] Protocol wrong type for socket.
25043    [10042] Bad protocol option.
25044    [10043] Protocol not supported.
25045    [10044] Socket type not supported.
25046    [10045] Operation not supported on socket.
25047    [10046] Protocol family not supported.
25048    [10047] Address family not supported by protocol family.
25049    [10048] Address already in use.
25050    [10049] Can't assign requested address.
25051    [10050] Network is down.
25052    [10051] Network is unreachable.
25053    [10052] Net dropped connection or reset.
25054    [10053] Software caused connection abort.
25055    [10054] Connection reset by peer.
25056    [10055] No buffer space available.
25057    [10056] Socket is already connected.
25058    [10057] Socket is not connected.
25059    [10058] Can't send after socket shutdown.
25060    [10059] Too many references, can't splice.
25061    [10060] Connection timed out.
25062    [10061] Connection refused.
25063    [10062] Too many levels of symbolic links.
25064    [10063] File name too long.
25065    [10064] Host is down.
25066    [10065] No route to host.
25067    [10066] Directory not empty
25068    [10067] Too many processes.
25069    [10068] Too many users.
25070    [10069] Disc Quota Exceeded.
25071    [10070] Stale NFS file handle.
25072    [10071] Too many levels of remote in path.
25092    [10091] Network subsystem is unavailable.
25093    [10092] WINSOCK DLL Version out of range.
25094    [10093] Winsock not loaded yet.
26002    [11001] Host not found.
26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
26005    [11004] Valid name, no data record (check DNS setup).