PTManualSettle Component [Paymentech Integrator V6]
Properties
Methods
Events
Configuration Settings
The PTManualSettle component is used to do a Batch Settlement on all transactions that were successfully authorized
with the PTCHARGE component in Terminal Capture mode.
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
This component allows for a direct, secure connection to the Paymentech transaction server 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.
The PTManualSettle component is used to settle all transactions previously authorized by the PTCHARGE
component, when using Terminal Capture mode. Use the PTHOSTSETTLE component when operating in Host Capture mode.
(Terminal Capture is usually only used when supporting the Hotel/Lodging or Restaurant IndustryTypes.)
When a transaction is authorized, money in the customer's account is
blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions
are settled with the PTManualSettle component the funds are deducted from the customer's account and added to the
merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement
when operating in Terminal Capture mode.
There are three steps to setting up the component and sending a batch settlement. First, set the MerchantNumber,
TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed
up for Paymentech service. After the merchant information is setup add the transaction aggregates from the PTCHARGE and/or PTDETAILRECORD
component to the DetailRecords array. Then call SendSettlement. The status of the settlement will be returned in the Response property.
The PTDETAILRECORD component can be used to parse aggregates returned from the PTCHARGE component in order to modify the transaction
data (for instance, to add a gratuity or extra charge). The PTDETAILRECORD component can also be used to create off-line Credit and
voice authorization (Capture) transactions to be added to the batch settlement.
Thousands of detail records may be settled in the above manner, just by adding transactions to the DetailRecords array.
However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease
the number of records that must be resent in the event of an error.
To Void a transaction that has been authorized but has not yet been settled, Void it with the PTCHARGE component, and then remove it
from the batch settlement. A voided transaction MUST NOT be included in the DetailRecords array.
Property List
The following is the full list of the properties of the component with short
descriptions. Click on the links for further details.
| |
| BatchNumber | Number to assign to this batch. |
| ClientNumber | Merchant configuration property, assigned by Paymentech. |
| DetailRecordCount | The number of records in the DetailRecord array. |
| DetailRecord | Array containing a list of detail record aggregates for transactions to be settled. |
| IndustryType | Determines the merchant's industry type. |
| MerchantNumber | A unique number used to identify the merchant, assigned by Paymentech. |
| NetAmount | Net amount (charges - credits) of all transactions in the batch. |
| Password | Password for authentication with the NetConnect Server. |
| 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. |
| ResponseBatchClose | Date at which the current batch was closed. |
| ResponseBatchNetAmount | Net amount of the current batch. |
| 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. |
| ResponseBatchOpen | Date at which the current batch was opened. |
| ResponseBatchTransCount | Total number of transactions in the batch. |
| ResponseCode | Indicates the status of the authorization request. |
| ResponseData | Contains the entire contents of the Server response. |
| ResponseInquiryCount | Number of BatchInquiry s performed on the current open batch. |
| ResponseSequenceNumber | SequenceNumber echoed from the authorization. |
| ResponseText | Approval/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. |
| 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. |
| 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.
| |
| Config | Sets or retrieves a configuration setting. |
| Interrupt | Interrupt the current method. |
| Reset | Clears all properties to their default values. |
| SendSettlement | Begins a Batch Settlement transaction with the Paymentech server. |
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.
| |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| Authorization | The Authorization string to be sent to the server. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| 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. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| 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. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| 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). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
