PTechManualSettle Class

Properties Methods Events Config Settings Errors

The PTechManualSettle class is used to do a Batch Settlement on all transactions that were successfully authorized with the PTECHCHARGE class in Terminal Capture mode.

Syntax

PTechManualSettle

Remarks

This class allows for a direct, secure connection to the Paymentech transaction server through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers. The PTechManualSettle class is used to settle all transactions previously authorized by the PTechCharge class, when using Terminal Capture mode. Use the PTechHostSettle class 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 PTechManualSettle class 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 class 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 PTechCharge and/or PTechDetailRecord class to the DetailRecords array. Then call SendSettlement. The status of the settlement will be returned in the Response property.

The PTechDetailRecord class can be used to parse aggregates returned from the PTechCharge class in order to modify the transaction data (for instance, to add a gratuity or extra charge). The PTechDetailRecord class 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 Cancel a transaction that has been authorized but has not yet been settled, use the PTechReversal class to reverse the original transaction, and then remove it from the batch settlement. The reversed transaction MUST NOT be included in the DetailRecords array.

Property List

The following is the full list of the properties of the class 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 arrays.
DetailRecordAggregate	Set this property with xml aggregates of the transactions you wish to settle.
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 class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the class 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 Transmission Control Protocol (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 a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUser	This property contains a username 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 PTECHHOSTSETTLE class, or after a SendSettlement sent using the PTECHMANUALSETTLE class.
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.
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	This is the certificate (PEM/Base64 encoded).
SSLCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/Base64 encoded).
TerminalNumber	Terminal number assigned by Paymentech.
Timeout	A timeout for the class.
UserId	UserId 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.


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 class 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	Fired when secure connection progress messages are available.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


SystemInformation	System Information field for Batch Inquiry and Release transactions.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
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.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
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.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class 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.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

BatchNumber Property (PTechManualSettle Class)

Number to assign to this batch.

Syntax

ANSI (Cross Platform)
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Unicode (Windows)
INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);

int dpaymentssdk_ptechmanualsettle_getbatchnumber(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setbatchnumber(void* lpObj, int iBatchNumber);

int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Default Value

Remarks

The range of this property is 1 to 999. The BatchNumber must be incremented for each batch settlement.

Data Type

Integer

ClientNumber Property (PTechManualSettle Class)

Merchant configuration property, assigned by Paymentech.

Syntax

ANSI (Cross Platform)
char* GetClientNumber();
int SetClientNumber(const char* lpszClientNumber);

Unicode (Windows)
LPWSTR GetClientNumber();
INT SetClientNumber(LPCWSTR lpszClientNumber);

char* dpaymentssdk_ptechmanualsettle_getclientnumber(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setclientnumber(void* lpObj, const char* lpszClientNumber);

QString GetClientNumber();
int SetClientNumber(QString qsClientNumber);

Default Value

Remarks

The ClientNumber will be supplied to you by Paymentech.

Data Type

String

DetailRecordCount Property (PTechManualSettle Class)

The number of records in the DetailRecord arrays.

Syntax

ANSI (Cross Platform)
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

Unicode (Windows)
INT GetDetailRecordCount();
INT SetDetailRecordCount(INT iDetailRecordCount);

int dpaymentssdk_ptechmanualsettle_getdetailrecordcount(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setdetailrecordcount(void* lpObj, int iDetailRecordCount);

int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

Default Value

Remarks

This property controls the size of the following arrays:

DetailRecordAggregate

The array indices start at 0 and end at DetailRecordCount - 1.

This property is not available at design time.

Data Type

Integer

DetailRecordAggregate Property (PTechManualSettle Class)

Set this property with xml aggregates of the transactions you wish to settle.

Syntax

ANSI (Cross Platform)
char* GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, const char* lpszDetailRecordAggregate);

Unicode (Windows)
LPWSTR GetDetailRecordAggregate(INT iDetailRecordIndex);
INT SetDetailRecordAggregate(INT iDetailRecordIndex, LPCWSTR lpszDetailRecordAggregate);

char* dpaymentssdk_ptechmanualsettle_getdetailrecordaggregate(void* lpObj, int detailrecordindex);
int dpaymentssdk_ptechmanualsettle_setdetailrecordaggregate(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAggregate);

QString GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, QString qsDetailRecordAggregate);

Default Value

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the PTechCharge, PTechECommerce, PTechRetail, PTechHotel, PTechHealthCare, or PTechDetailRecord class's GetDetailAggregate method. For instance:

PTechManualSettle.DetailRecords.Add(new PTechRecordtype(PTechRetail1.GetDetailAggregate()));

On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the PTechDetailRecord class.

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

IndustryType Property (PTechManualSettle Class)

Determines the merchant's industry type.

Syntax

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

Possible Values

PIT_RETAIL(0), 
PIT_DIRECT_MARKETING(1), 
PIT_ECOMMERCE(2), 
PIT_RESTAURANT(3), 
PIT_HOTEL(4)

int dpaymentssdk_ptechmanualsettle_getindustrytype(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

Remarks

This property sets the merchant's industry type. Valid values are shown in the table below:


Industry Type	Description
pitRetail (0)	Retail environments are classified as those environments where the card and cardholder are physically present at the time of purchase.
pitDirectMarketing (1)	Mail Order or Phone Order (MOPO) environments are classified as those environments where the card and/or cardholder are not physically present at the time of purchase and the transaction is performed through the mail or over the telephone.
pitECommerce (2)	Electronic Commerce environments are classified as those environments where the card and/or cardholder are not physically present at the time of purchase and the transaction is performed over the Internet.
pitRestaurant (3)	Restaurant environments are similar to retail environments, where the card and cardholder are physically present at the time of purchase.* A gratuity may be added at the time of authorization, or before settlement. Note that the itRestaurant industry type requires merchants to use Paymentech's Terminal Capture System (TCS) to process transactions, and batches must be manually settled using the PTechManualSettle class.
pitHotel (4)	Hotel/Lodging environments allow for both card-present and card-not-present transactions* (for instance, a phoned-in reservation or a charge for a no-show). Additional hotel (PTechHotelInfo) information must be submitted in the authorization and capture. Additional charges may be added on to the initial authorization using the PTechDetailRecord class before the transaction is settled with the PTechManualSettle class. Note that the itHotel industry type requires merchants to use Paymentech's Terminal Capture System (TCS) to process transactions, and batches must be manually settled using the PTechManualSettle class.

Note: Setting the IndustryType has the side effect of changing the CardEntryDataSource to the default value for the selected industry type. In addition, setting the IndustryType to itDirectMarketing or itECommerce will also reset the PINCapability to ppNoPIN.

* Restaurant orders taken over the phone should be processed as itDirectMarketing transactions. Hotel transactions should always be processed in the itHotel IndustryType. Setting the HotelPreferredCustomer property to True.

Data Type

Integer

MerchantNumber Property (PTechManualSettle Class)

A unique number used to identify the merchant, assigned by Paymentech.

Syntax

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber);

Unicode (Windows)
LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);

char* dpaymentssdk_ptechmanualsettle_getmerchantnumber(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

Default Value

Remarks

This 12 digit field contains a unique number to identify the merchant to the host.

Data Type

String

NetAmount Property (PTechManualSettle Class)

Net amount (charges - credits) of all transactions in the batch.

Syntax

ANSI (Cross Platform)
char* GetNetAmount();

Unicode (Windows)
LPWSTR GetNetAmount();

char* dpaymentssdk_ptechmanualsettle_getnetamount(void* lpObj);

QString GetNetAmount();

Default Value

Remarks

Querying this property will calculate the net amount of the batch settlement using the Settlement Amounts from each detail record.

This property is read-only and not available at design time.

Data Type

String

Password Property (PTechManualSettle Class)

Password for authentication with the NetConnect Server .

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* dpaymentssdk_ptechmanualsettle_getpassword(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

The Password will be supplied to you by Paymentech.

Data Type

String

ProxyAuthScheme Property (PTechManualSettle Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dpaymentssdk_ptechmanualsettle_getproxyauthscheme(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (PTechManualSettle Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dpaymentssdk_ptechmanualsettle_getproxyautodetect(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (PTechManualSettle Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dpaymentssdk_ptechmanualsettle_getproxypassword(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (PTechManualSettle Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dpaymentssdk_ptechmanualsettle_getproxyport(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (PTechManualSettle Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dpaymentssdk_ptechmanualsettle_getproxyserver(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (PTechManualSettle Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dpaymentssdk_ptechmanualsettle_getproxyssl(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (PTechManualSettle Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dpaymentssdk_ptechmanualsettle_getproxyuser(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseBatchClose Property (PTechManualSettle Class)

Date at which the current batch was closed.

Syntax

ANSI (Cross Platform)
char* GetResponseBatchClose();

Unicode (Windows)
LPWSTR GetResponseBatchClose();

char* dpaymentssdk_ptechmanualsettle_getresponsebatchclose(void* lpObj);

QString GetResponseBatchClose();

Default Value

Remarks

Date at which the current batch was closed. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

This property is read-only.

Data Type

String

ResponseBatchNetAmount Property (PTechManualSettle Class)

Net amount of the current batch.

Syntax

ANSI (Cross Platform)
char* GetResponseBatchNetAmount();

Unicode (Windows)
LPWSTR GetResponseBatchNetAmount();

char* dpaymentssdk_ptechmanualsettle_getresponsebatchnetamount(void* lpObj);

QString GetResponseBatchNetAmount();

Default Value

Remarks

Net amount of the current batch. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class. This property will contain the net transaction totals of the currently open (or just released) batch. This value may be between the range "-9999999.99" to "9999999.99".

Note, when using the PTechManualSettle class to send manual batch settlements, this property will always be "00.00", because the Paymentech host is not maintaining the state of the batch.

This property is read-only.

Data Type

String

ResponseBatchNumber Property (PTechManualSettle Class)

Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTECHHOSTSETTLE class, or after a SendSettlement sent using the PTECHMANUALSETTLE class.

Syntax

ANSI (Cross Platform)
char* GetResponseBatchNumber();

Unicode (Windows)
LPWSTR GetResponseBatchNumber();

char* dpaymentssdk_ptechmanualsettle_getresponsebatchnumber(void* lpObj);

QString GetResponseBatchNumber();

Default Value

Remarks

Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

Note that when using the PTechManualSettle class to manually settle transactions via Paymentech's Terminal Capture System (TCS), this property will contain the original batch number incremented by one.

This property is read-only.

Data Type

String

ResponseBatchOpen Property (PTechManualSettle Class)

Date at which the current batch was opened.

Syntax

ANSI (Cross Platform)
char* GetResponseBatchOpen();

Unicode (Windows)
LPWSTR GetResponseBatchOpen();

char* dpaymentssdk_ptechmanualsettle_getresponsebatchopen(void* lpObj);

QString GetResponseBatchOpen();

Default Value

Remarks

Date at which the current batch was opened. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

This property is read-only.

Data Type

String

ResponseBatchTransCount Property (PTechManualSettle Class)

Total number of transactions in the batch.

Syntax

ANSI (Cross Platform)
int GetResponseBatchTransCount();

Unicode (Windows)
INT GetResponseBatchTransCount();

int dpaymentssdk_ptechmanualsettle_getresponsebatchtranscount(void* lpObj);

int GetResponseBatchTransCount();

Default Value

Remarks

Total number of transactions in the batch. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

Note, when using the PTechManualSettle class to send manual batch settlements, this property will always be "0", because the Paymentech host is not maintaining the state of the batch.

This property is read-only.

Data Type

Integer

ResponseCode Property (PTechManualSettle Class)

Indicates the status of the authorization request.

Syntax

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* dpaymentssdk_ptechmanualsettle_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

Remarks

Indicates the status of the authorization request. This is the property used to determine whether a transaction has been approved or not. Valid values for this property are:


A	Transaction is Approved.
E	Error condition or card declined (see the Error section of the help file for more information).

See the list of errors for this class for more information.

This property is read-only.

Data Type

String

ResponseInquiryCount Property (PTechManualSettle Class)

Number of BatchInquiry s performed on the current open batch.

Syntax

ANSI (Cross Platform)
int GetResponseInquiryCount();

Unicode (Windows)
INT GetResponseInquiryCount();

int dpaymentssdk_ptechmanualsettle_getresponseinquirycount(void* lpObj);

int GetResponseInquiryCount();

Default Value

Remarks

Number of BatchInquirys performed on the current open batch. The number returned in this field indicates how many times a batch inquiry has been requested from the host.

This property is read-only.

Data Type

Integer

ResponseSequenceNumber Property (PTechManualSettle Class)

SequenceNumber echoed from the authorization.

Syntax

ANSI (Cross Platform)
char* GetResponseSequenceNumber();

Unicode (Windows)
LPWSTR GetResponseSequenceNumber();

char* dpaymentssdk_ptechmanualsettle_getresponsesequencenumber(void* lpObj);

QString GetResponseSequenceNumber();

Default Value

Remarks

SequenceNumber echoed from the authorization. After any transaction this property will contain the same value sent in the SequenceNumber property.

This property is read-only.

Data Type

String

ResponseText Property (PTechManualSettle Class)

Syntax

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* dpaymentssdk_ptechmanualsettle_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

Remarks

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. This property will contain human-readable text indicating whether the Inquiry or Release was successful, or it will contain a description of any error encountered.

See the list of errors for this class for more information.

This property is read-only.

Data Type

String

SequenceNumber Property (PTechManualSettle Class)

Sequence number of the transaction.

Syntax

ANSI (Cross Platform)
int GetSequenceNumber();
int SetSequenceNumber(int iSequenceNumber);

Unicode (Windows)
INT GetSequenceNumber();
INT SetSequenceNumber(INT iSequenceNumber);

int dpaymentssdk_ptechmanualsettle_getsequencenumber(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setsequencenumber(void* lpObj, int iSequenceNumber);

int GetSequenceNumber();
int SetSequenceNumber(int iSequenceNumber);

Default Value

Remarks

This field is user definable and can be used at the users discretion. When submitting any type of transaction for approval, this sequence number may be any numeric value 0 to 2400. This is a purely optional field for the Host Capture SettlementMode, and you may choose to send a unique number or simply send every transaction with zeros. The host will echo the sequence number submitted from the authorization request back in the ResponseSequenceNumber property.

However, if you are processing with the Terminal Capture SettlementMode, SequenceNumber CANNOT remain zero, and must contain a number that is incremented for each transaction you authorized. When it reaches 2400, the SequenceNumber should then start over at 1 again.

Data Type

Integer

Server Property (PTechManualSettle Class)

The URL for the PaymenTech NetConnect server.

Syntax

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer);

Unicode (Windows)
LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);

char* dpaymentssdk_ptechmanualsettle_getserver(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setserver(void* lpObj, const char* lpszServer);

QString GetServer();
int SetServer(QString qsServer);

Default Value

"https://netconnect1.chasepaymentech.com/NetConnect/controller"

Remarks

This property contains the server to which all transactions are sent.

Data Type

String

SSLAcceptServerCertEncoded Property (PTechManualSettle Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_ptechmanualsettle_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_ptechmanualsettle_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (PTechManualSettle Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_ptechmanualsettle_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_ptechmanualsettle_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (PTechManualSettle Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_ptechmanualsettle_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_ptechmanualsettle_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (PTechManualSettle Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_ptechmanualsettle_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (PTechManualSettle Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_ptechmanualsettle_getsslcertstoretype(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (PTechManualSettle Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_ptechmanualsettle_getsslcertsubject(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (PTechManualSettle Class)

This specifies the SSL/TLS implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_ptechmanualsettle_getsslprovider(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (PTechManualSettle Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dpaymentssdk_ptechmanualsettle_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

TerminalNumber Property (PTechManualSettle Class)

Terminal number assigned by Paymentech.

Syntax

ANSI (Cross Platform)
char* GetTerminalNumber();
int SetTerminalNumber(const char* lpszTerminalNumber);

Unicode (Windows)
LPWSTR GetTerminalNumber();
INT SetTerminalNumber(LPCWSTR lpszTerminalNumber);

char* dpaymentssdk_ptechmanualsettle_getterminalnumber(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setterminalnumber(void* lpObj, const char* lpszTerminalNumber);

QString GetTerminalNumber();
int SetTerminalNumber(QString qsTerminalNumber);

Default Value

Remarks

3-digit field assigned by Paymentech, which identifies the terminal to the host.

Data Type

String

Timeout Property (PTechManualSettle Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_ptechmanualsettle_gettimeout(void* lpObj);
int dpaymentssdk_ptechmanualsettle_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (PTechManualSettle Class)

UserId for authentication with the NetConnect Server .

Syntax

ANSI (Cross Platform)
char* GetUserId();
int SetUserId(const char* lpszUserId);

Unicode (Windows)
LPWSTR GetUserId();
INT SetUserId(LPCWSTR lpszUserId);

char* dpaymentssdk_ptechmanualsettle_getuserid(void* lpObj);
int dpaymentssdk_ptechmanualsettle_setuserid(void* lpObj, const char* lpszUserId);

QString GetUserId();
int SetUserId(QString qsUserId);

Default Value

Remarks

The UserId will be supplied to you by PaymenTech.

Data Type

String

Config Method (PTechManualSettle Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_ptechmanualsettle_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (PTechManualSettle Class)

Interrupt the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_ptechmanualsettle_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (PTechManualSettle Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_ptechmanualsettle_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

SendSettlement Method (PTechManualSettle Class)

Begins a Batch Settlement transaction with the Paymentech server.

Syntax

ANSI (Cross Platform)
int SendSettlement();

Unicode (Windows)
INT SendSettlement();

int dpaymentssdk_ptechmanualsettle_sendsettlement(void* lpObj);

int SendSettlement();

Remarks

This begins a Batch Settlement transaction. The Header Record, Header2 Record, all transaction Detail Records, and the computed Trailer Record are sent sequentially to the Paymentech host.

Error Handling (C++)

DataPacketIn Event (PTechManualSettle Class)

Fired when receiving a data packet from the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketIn(PTechManualSettleDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} PTechManualSettleDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(PTechManualSettleDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} PTechManualSettleDataPacketInEventParams;

#define EID_PTECHMANUALSETTLE_DATAPACKETIN 1

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class PTechManualSettleDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(PTechManualSettleDataPacketInEventParams *e);

// Or, subclass PTechManualSettle and override this emitter function.
virtual int FireDataPacketIn(PTechManualSettleDataPacketInEventParams *e) {...}

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (PTechManualSettle Class)

Fired when sending a data packet to the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketOut(PTechManualSettleDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} PTechManualSettleDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(PTechManualSettleDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} PTechManualSettleDataPacketOutEventParams;

#define EID_PTECHMANUALSETTLE_DATAPACKETOUT 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class PTechManualSettleDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(PTechManualSettleDataPacketOutEventParams *e);

// Or, subclass PTechManualSettle and override this emitter function.
virtual int FireDataPacketOut(PTechManualSettleDataPacketOutEventParams *e) {...}

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting.

Error Event (PTechManualSettle Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(PTechManualSettleErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PTechManualSettleErrorEventParams;


Unicode (Windows)
virtual INT FireError(PTechManualSettleErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PTechManualSettleErrorEventParams;

#define EID_PTECHMANUALSETTLE_ERROR 3

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PTechManualSettleErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PTechManualSettleErrorEventParams *e);

// Or, subclass PTechManualSettle and override this emitter function.
virtual int FireError(PTechManualSettleErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (PTechManualSettle Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(PTechManualSettleSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} PTechManualSettleSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(PTechManualSettleSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} PTechManualSettleSSLServerAuthenticationEventParams;

#define EID_PTECHMANUALSETTLE_SSLSERVERAUTHENTICATION 4

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class PTechManualSettleSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(PTechManualSettleSSLServerAuthenticationEventParams *e);

// Or, subclass PTechManualSettle and override this emitter function.
virtual int FireSSLServerAuthentication(PTechManualSettleSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (PTechManualSettle Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(PTechManualSettleSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} PTechManualSettleSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(PTechManualSettleSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} PTechManualSettleSSLStatusEventParams;

#define EID_PTECHMANUALSETTLE_SSLSTATUS 5

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class PTechManualSettleSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(PTechManualSettleSSLStatusEventParams *e);

// Or, subclass PTechManualSettle and override this emitter function.
virtual int FireSSLStatus(PTechManualSettleSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (PTechManualSettle Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

PTechManualSettle Config Settings

SystemInformation: System Information field for Batch Inquiry and Release transactions.

System Information that all software packages must supply to the Paymentech host when sending a Batch Inquiry or Release transaction. Unless Paymentech indicates otherwise, the value of this configuration setting should not be changed. If it is changed, it should meet the specifications below.

The class will construct the System Information data based on the following specifications:

Application Name - 7 characters
Release Date - 6 characters (MMDDYY)
EPROM / Version Number - 10 characters

For example: DIRPAYI110613VERSION6.0

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.