Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

PTechHostSettle Class

Properties   Methods   Events   Configuration Settings   Errors  

The PTechHostSettle component is used to manually settle an open Batch with the Paymentech NetConnect system on the Tampa platform. This component supports Direct Marketing, e-Commerce, and Retail environments, and 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.

Class Name

InPayDirect_PTechHostSettle

Procedural Interface

 inpaydirect_ptechhostsettle_open();
 inpaydirect_ptechhostsettle_close($res);
 inpaydirect_ptechhostsettle_register_callback($res, $id, $function);
 inpaydirect_ptechhostsettle_get_last_error($res);
 inpaydirect_ptechhostsettle_get_last_error_code($res);
 inpaydirect_ptechhostsettle_set($res, $id, $index, $value);
 inpaydirect_ptechhostsettle_get($res, $id, $index);
 inpaydirect_ptechhostsettle_do_batchinquiry($res);
 inpaydirect_ptechhostsettle_do_batchrelease($res, $netdeposit);
 inpaydirect_ptechhostsettle_do_config($res, $configurationstring);
 inpaydirect_ptechhostsettle_do_interrupt($res);
 inpaydirect_ptechhostsettle_do_reset($res);

Remarks

Once an authorization request is approved with either the PTechCharge or PTechGiftCard class, one of two things happen. If your Paymentech account is setup with the Host Auto Close feature enabled, you need take no further action. The host will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. In order for the merchant's batch to be included in the Paymentech Host Auto Close process, the merchant parameter file on the host must indicate that the merchant is Auto Close. If this flag is set, the PTechHostSettle class is not necessary.

However, if your account is not setup with Host Auto Close, then after an authorization is approved the transaction is added to the current batch on the Paymentech Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through the Manual Batch Release Settlement process in order for the blocked money to be transferred to the merchant's account. To release a batch for settlement, first set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. Then get the Net Amount of the batch by calling the BatchInquiry method. Compare this amount to the amount in your transaction records. If they match, you may send a BatchRelease to settle the funds.

The status of a batch inquiry or release is returned in the ResponseCode. with a human-readable description contained in ResponseText. Additional Response properties indicate the number of transactions in the batch, the date and time the batch was opened and closed, and Net amount of the batch.

Normally a BatchRelease is done at the end of each business day. Outstanding authorizations (even those in an open batch) will expire after 7 to 10 days depending on the cardholder's bank, so it is wise to release the batch often.

Note that this class only supports the Manual Batch Release (Host Capture) settlement method, and does not support Terminal Capture processing (this class is not required for Host Auto Close).

Property List


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

CardTypeIndicates the card type for which the terminal is requesting totals or details on.
ClientNumberMerchant configuration property, assigned by Paymentech.
InquiryTypeThe type of batch inquiry to be submitted.
MerchantNumberA unique number used to identify the merchant, assigned by Paymentech.
MoreDataIndicates whether the Paymentech server has more data to return.
PasswordPassword for authentication with the NetConnect Server .
PaymentTypeCountThe number of records in the PaymentType arrays.
PaymentTypeNameName of the payment type at the current index.
PaymentTypeNetAmountNet transaction amount for the payment type.
PaymentTypeTransCountTotal number of transactions for the payment type.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component 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 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 SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RequestStatusUsed with enhanced BatchInquiry s to retrieve the next set of transaction data.
ResponseBatchCloseDate at which the current batch was closed.
ResponseBatchNetAmountNet amount of the current batch.
ResponseBatchNumberCurrent 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.
ResponseBatchOpenDate at which the current batch was opened.
ResponseBatchTransCountTotal number of transactions in the batch.
ResponseCodeIndicates the status of the authorization request.
ResponseInquiryCountNumber of BatchInquiry s performed on the current open batch.
ResponseSequenceNumberSequenceNumber echoed from the authorization.
ResponseTextApproval/Decline/Error text message information This property contains a response message returned from the Paymentech host, and is used by the terminal to display the Batch Inquiry or Release result.
SequenceNumberSequence number of the transaction.
ServerThe URL for the PaymenTech NetConnect server.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TerminalNumberTerminal number assigned by Paymentech.
TimeoutA timeout for the component.
DetailsCountThe number of records in the Details arrays.
DetailsApprovalCodeApproval code of transaction pending settlement.
DetailsCardTypeCredit card used in transaction pending settlement.
DetailsSequenceNumberSequence number of transaction pending settlement.
DetailsTransAmountAuthorized amount of transaction pending settlement.
DetailsTransTypeTransaction type of transaction pending settlement.
TotalsCountThe number of records in the Totals arrays.
TotalsCardTypeCredit card used in transaction pending settlement.
TotalsNetAmountTotal dollar amount of all transactions in the open batch that match the indicated CardType .
TotalsTransCountTotal number of transactions in the open batch that match the indicated CardType .
UserIdUserId for authentication with the NetConnect Server .

Method List


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

BatchInquiryRetrieves the current state of the open batch.
BatchReleaseReleases the current batch for settlement.
ConfigSets or retrieves a configuration setting .
InterruptInterrupt the current method.
ResetClears all properties to their default values.

Event List


The following is the full list of the events fired by the class 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 class with short descriptions. Click on the links for further details.

ErrorCodeBatch Management Error Code.
SystemInformationSystem Information field for Batch Inquiry and Release transactions.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
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.
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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
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).
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.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0