4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

PTechHotel Component

Properties   Methods   Events   Configuration Settings   Errors  

The PTECHHOTEL component is used to authorize credit card transactions for the Hotel IndustryType with the Paymentech NetConnect system on the Tampa platform. This component creates a simple interface for processing transactions in the Hotel environment. It allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

DPayments.DPaymentsSDK.Ptechhotel

Remarks

Setting up the component and authorizing a transaction is easy. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your IndustryType and PINCapability at this time.

After the merchant information is setup, you may enter transaction data. When the Credit Card's EntryDataSource is Manually Entered, the merchant should fill the Number, ExpMonth, and ExpYear fields. Address Verification Service (AVS) data may be sent in card-present retail transactions by filling the CustomerAddress and CustomerZip properties. For any other EntryDataSource , the MagneticStripe field should be filled. In addition, the TransactionAmount should be set with the total amount for the transaction, including any taxes.

Now you should set the Hotel fields with extra information about the transaction. At minimum you should set the ArrivalDate (or reservation date), estimated Duration of stay, DepartureDate (planned or actual), and SaleCode. If the transaction is card-not-present (ie: phone or online reservation) and the customer supplies a Visa, MasterCard, or American Express card for payment, you must also set the PreferredCustomer to True. This indicates a card-not-present transaction for these two card types. Other card types must use the PTechECommerce component for card-not-present transactions.

Now simply call the Sale or AuthOnly method to send the authorization to the Paymentech Server.

The result of the authorization request will be stored in the Response property. The Code field will contain the status of the request and the Text field will contain the human-readable response message. The contents of the Response should be logged after a successful transaction.

Hotel transactions only operate in Terminal Capture mode. This means you cannot rely on Paymentech to automatically handle the settlement for you. Instead, you must save the XML aggregate returned from the GetDetailAggregate method, for each and every authorization. At the end of the day, you must then use the PTechManualSettle component to send all of these aggregates for processing. The reason Paymentech cannot handle the batch automatically for the PTechHotel component is because Hotel transactions by nature will usually have additional charges tacked on to the originally authorized amount. It may also be several days between check-in (authorization) and departure (when you can then settle the card). The XML aggregates for each transaction may be manipulated using the PTechDetailRecord component. This will allow you to add or remove additional days to the stay, tack on charges for room service or telephone calls, and more.

Note that when processing transactions in Terminal Capture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle components.

Property List


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

CardContains the customer's credit card information.
ClientNumberMerchant configuration property, assigned by Paymentech.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
HotelContains additional information required for the Hotel/Lodging industry.
InvoiceNumberHotel Folio Number.
MerchantNumberA unique number used to identify the merchant, assigned by Paymentech.
PasswordPassword for authentication with the NetConnect Server .
PINCapabilityIndicates if the terminal device supports a PIN pad.
POSRetrievalNumberMerchant-generated reference number, used for reversals.
ProxyA set of properties related to proxy access.
ResponseContains the response to an authorization.
SequenceNumberSequence number of the transaction.
ServerThe URL for the PaymenTech NetConnect server.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TerminalNumberTerminal number assigned by Paymentech.
TimeoutA timeout for the component.
TransactionAmountPurchase amount for an authorization.
UserIdUserId for authentication with the NetConnect Server .

Method List


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

AuthOnlySends an AuthOnly transaction to the host.
ConfigSets or retrieves a configuration setting .
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for manual settlement.
InterruptInterrupt the current method.
ResetClears all properties to their default values.
SaleSends a Sale transaction to the host.
VisaIncrementalIncreases the TransactionAmount of a previously-submitted transaction.
VisaReversalDecreases the TransactionAmount of a previously-submitted transaction.

Event List


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

DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

CustomerDefinedDataAdditional transaction identification data.
AllowPartialAuthsIndicates whether partial authorizations are to be supported.
DeviceTypeIndicates the Remote Payment Type for MasterCard Contactless Authorizations.
DeviceIDUsed to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.
VendorIDHardware/Vendor Identifier.
SoftwareIDSoftware Identifier.
HardwareSerialNumHardware Serial Number.
HostProcessingTypesHost Processing Platform.
DiscoverProcessingCodeReturns the type of Authorization request that was submitted to Discover.
DiscoverSystemTraceAuditNumberReturns the value assigned by the host/merhant to assist in identifying a specific transaction.
DiscoverPOSEntryModeReturns the method by which the primary account number was entered at the POS.
DiscoverPINCapababilityIndicates if the POS is capable of supporting a PIN.
DiscoverTrackDataConditionReturns condition of the track data.
DiscoverAuthAmountReturns the amount authorized for the transaction.
RequestBalanceInfoSpecifies whether to request balance information.
ResponseBalanceAmount1Credit Prepaid Available Balance #1.
ResponseBalanceAmount2Credit Prepaid Available Balance $2.
ResponseBalanceCurrency1Currency code for ResponseBalanceAmount1.
ResponseBalanceCurrency2Currency code for ResponseBalanceAmount2.
SystemInformationSystem Information field for Batch Inquiry and Release transactions.
ECommerceIndicatorUsed to specify the indicator describing the type of internet transaction.
CAVVAuthenticationCAVV data from a ThreeDSecure authentication.
SettlementModeIndicates whether the component uses Paymentech's Host Capture or Terminal Capture system.
ResponsePOSRetrievalNumberPOS Retrieval Number sent in the request, echoed back in the response.
EMVDataThe EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSourceThe EMV Data Entry Source (DES).
ResponseEMVDataThe response EMV data.
ResponseEMVCardAuthCodeThe ChaseNet and Visa card authentication results code.
ResponseEMVDownloadIndicatorWhether EMV parameters should be updated.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
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.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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 component 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.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2018 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 6863]