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
TibcPTechHotel
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 CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent in card-present retail transactions by filling the CustomerAddress and CustomerZip properties. For any other CardEntryDataSource , the CardMagneticStripe property 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 properties with extra information about the transaction. At minimum you should set the HotelArrivalDate (or reservation date), estimated HotelDuration of stay, HotelDepartureDate (planned or actual), and HotelSaleCode. 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 HotelPreferredCustomer 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 status of the authorization request will be stored in the ResponseCode property, with human-readable text appearing in the ResponseText property. There are several other Response properties which will contain data that should be logged.
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.
CardCVVData | Three digit security code on back of card (optional). |
CardCVVPresence | Indicates the presence of the card verification value. |
CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in Number . |
CardExpYear | Expiration year of the credit card specified in Number . |
CardMagneticStripe | Track data read off of the card's magnetic stripe. |
CardNumber | Customer's credit card number for the transaction. |
ClientNumber | Merchant configuration property, assigned by Paymentech. |
CustomerAddress | The customer's billing address. |
CustomerZip | Customer's zip code (or postal code if outside of the USA). |
HotelArrivalDate | Date the customer checked in, or the expected arrival date when authorizing a reservation. |
HotelChargeDescriptor | Provides additional information about what this transaction was used for at the hotel. |
HotelDepartureDate | Date the customer checked out, or the expected check-out date when authorizing a reservation. |
HotelDuration | The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation. |
HotelExtraChargeAmount | Total amount of extra charges incurred by the customer. |
HotelExtraChargesCode | List of extra charges added to the cost of lodging. |
HotelPreferredCustomer | Set this property to True to process a hotel transaction as card-not-present. |
HotelSaleCode | Provides additional details about the type of this transaction. |
InvoiceNumber | Hotel Folio Number. |
MerchantNumber | A unique number used to identify the merchant, assigned by Paymentech. |
Password | Password for authentication with the NetConnect Server . |
PINCapability | Indicates if the terminal device supports a PIN pad. |
POSRetrievalNumber | Merchant-generated reference number, used for reversals. |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
ResponseDebitSurcharge | Additional fee charged for debit transactions. |
ResponseDebitTrace | This property is returned in the response to a debit card transaction. |
ResponseApprovalCode | Contains an authorization code when a transaction has been approved, or an error code. |
ResponseAuthorizedAmount | Used for partial authorizations. |
ResponseAuthSource | Indicates the source of the authorization code stored in ApprovalCode . |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseBatchNumber | Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTECHHOSTSETTLE component, or after a SendSettlement sent using the PTECHMANUALSETTLE component. |
ResponseCardLevel | This property contains a two-character code created by Visa during the authorization process. |
ResponseCardType | Type of the credit card. |
ResponseCode | Indicates the status of the authorization request. |
ResponseCVVResult | Contains the returned CVV result code if it was requested. |
ResponseNetworkId | Authorizing network Identifier which indicates which network approved this transaction. |
ResponseRetrievalNumber | Reference number returned from the Paymentech host. |
ResponseSequenceNumber | SequenceNumber echoed from the authorization. |
ResponseText | Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result. |
SequenceNumber | Sequence number of the transaction. |
Server | The URL for the PaymenTech NetConnect server. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
TerminalNumber | Terminal number assigned by Paymentech. |
Timeout | A timeout for the component. |
TransactionAmount | Purchase amount for an authorization. |
UserId | UserId 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.
AuthOnly | Sends an AuthOnly transaction to the host. |
Config | Sets or retrieves a configuration setting . |
GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for manual settlement. |
Interrupt | Interrupt the current method. |
Reset | Clears all properties to their default values. |
Sale | Sends a Sale transaction to the host. |
VisaIncremental | Increases the TransactionAmount of a previously-submitted transaction. |
VisaReversal | Decreases 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.
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
CustomerDefinedData | Additional transaction identification data. |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
DeviceID | Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from. |
RequestBalanceInfo | Specifies whether to request balance information. |
ResponseBalanceAmount1 | Credit Prepaid Available Balance #1. |
ResponseBalanceAmount2 | Credit Prepaid Available Balance $2. |
ResponseBalanceCurrency1 | Currency code for ResponseBalanceAmount1. |
ResponseBalanceCurrency2 | Currency code for ResponseBalanceAmount2. |
SystemInformation | System Information field for Batch Inquiry and Release transactions. |
ECommerceIndicator | Used to specify the indicator describing the type of internet transaction. |
CAVV | AuthenticationCAVV data from a ThreeDSecure authentication. |
SettlementMode | Indicates whether the component uses Paymentech's Host Capture or Terminal Capture system. |
ResponsePOSRetrievalNumber | POS Retrieval Number sent in the request, echoed back in the response. |
EMVData | The EMV data returned from a Pin Pad after reading an EMV card. |
EMVEntryDataSource | The EMV Data Entry Source (DES). |
ResponseEMVData | The response EMV data. |
ResponseEMVCardAuthCode | The ChaseNet and Visa card authentication results code. |
ResponseEMVDownloadIndicator | Whether EMV parameters should be updated. |
EMVOnlinePIN | DUKPT DES encrypted PIN block for EMV Online PIN transactions. |
EMVOnlineKSN | Clear-text Key Sequence Number for EMV Online PIN transactions. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |