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