PTHotel Component [Paymentech Integrator V6]
Properties
Methods
Events
Configuration Settings
The PTHOTEL 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 SSL gateway through a standard Internet
connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because
all SSL communications are handled inside the component, any application or web page can be deployed without
the need for expensive dedicated SSL servers.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
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 Card is Manually Entered, the merchant should fill the
Card, Card, and Card properties.
Address Verification Service (AVS) data may be sent in card-present retail transactions by
filling the CustomerAddress and CustomerZip properties.
For any other Card , the Card 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 Hotel (or reservation date), estimated Hotel of stay,
Hotel (planned or actual), and Hotel. 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 Hotel to True. This indicates a card-not-present transaction for
these two card types. Other card types must use the PTECOMMERCE 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 Response property, with human-readable text appearing
in the Response 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 PTMANUALSETTLE component to send all of these aggregates for processing. The reason
Paymentech cannot handle the batch automatically for the PTHOTEL 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 PTDETAILRECORD
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 PTDETAILRECORD
and PTMANUALSETTLE 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 reason CVV value not supplied. |
| CardEntryDataSource | Determines the manner in which a cardholder's information is being sent to the Host. |
| CardExpMonth | Expiration month of the credit card specified by Number . |
| CardExpYear | Expiration year of the credit card specified by Number . |
| CardMagneticStripe | Track data read off of the card's magnetic stripe. |
| CardNumber | Customer's credit card number. |
| 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. |
| 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 PTHOSTSETTLE component, or after a SendSettlement sent using the PTMANUALSETTLE 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. |
| ResponseData | Contains the entire contents of the Server response. |
| ResponseDebitSurcharge | Additional fee charged for debit transactions. |
| ResponseDebitTrace | This property is returned in the response to a debit card transaction. |
| 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 Visa transaction. |
| VisaReversal | Decreases the TransactionAmount of a previously-submitted Visa 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.
| |
| 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. |
| Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
