PTechDebit Class

Properties Methods Events Config Settings Errors

The PTECHDEBIT class is used to complete debit card transactions with the Paymentech NetConnect system on the Tampa platform. This class supports only Retail, Restaurant, and Hotel environments, and allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This class can be integrated into Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

class dpaymentssdk.PTechDebit

Remarks

The PTechDebit class contains a subset of the PTechCharge class's functionality. It only authorizes debit card transactions for the Retail, Restaurant, and Hotel industry_types. This class provides a much simpler interface for processing debit cards (and only debit cards), but otherwise works much like the PTechCharge class.

First, set the merchant_number, terminal_number, client_number, user_id, and password with the information given to you when you signed up for Paymentech service. You should also set your industry_type and pin_capability at this time.

Next, set the card_magnetic_stripe property with Track 2 data read off the card. PIN-based Debit card transactions cannot be manually entered, and are always card-present transactions. Sending Track 1 data in the card_magnetic_stripe property will result in a failed. You must also set the debit_ksn and debit_pin retrieved from the PIN pad after the customer enters his PIN.

Finally, set the transaction_amount and, and if applicable any debit_cash_back amount. Then call sale to send the transaction to the Paymentech server for processing.

The status of the authorization request will be stored in the response_code property, with human-readable text appearing in the response_text property. There are several other Response properties which will contain data that should be logged.

Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, only the Host Capture settlement mode is supported. At the end of the day you should release the current batch using the PTechHostSettle class (the batch may contain other authorizations that were made using different classs from this product. See the documentation for the other classs you are using for more information).

Property List

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


card_magnetic_stripe	Track 2 data read off of the card's magnetic stripe.
client_number	Merchant configuration property, assigned by Paymentech.
debit_cash_back	Optional cash back amount for debit transactions.
debit_ksn	Clear-text Key Sequence Number, used for Debit transactions.
debit_pin	DUKPT DES encrypted PIN block, used for Debit transactions.
duplicate_checking	Indicates whether duplicate checking is enabled.
industry_type	Determines the merchant's industry type.
invoice_number	Merchant-generated invoice number.
merchant_number	A unique number used to identify the merchant, assigned by Paymentech.
password	Password for authentication with the NetConnect Server .
pin_capability	Indicates if the terminal device supports a PIN pad.
pos_retrieval_number	Merchant-generated reference number, used for reversals.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_user	This property contains a username if authentication is to be used for the proxy.
response_approval_code	Contains an authorization code when a transaction has been approved, or an error code.
response_authorized_amount	Used for partial authorizations.
response_auth_source	Indicates the source of the authorization code stored in ApprovalCode .
response_avs_result	Contains the Address Verification System result code.
response_batch_number	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.
response_card_level	This property contains a two-character code created by Visa during the authorization process.
response_card_type	Type of the credit card.
response_code	Indicates the status of the authorization request.
response_cvv_result	Contains the returned CVV result code if it was requested.
response_debit_surcharge	Additional fee charged for debit transactions.
response_debit_trace	This property is returned in the response to a debit card transaction.
response_network_id	Authorizing network Identifier which indicates which network approved this transaction.
response_retrieval_number	Reference number returned from the Paymentech host.
response_sequence_number	SequenceNumber echoed from the authorization.
response_text	Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result.
response_transaction_id	This 15-character property contains the Transaction Identifier assigned by the card issuer or network.
sequence_number	Sequence number of the transaction.
server	The URL for the PaymenTech NetConnect server.
ssl_accept_server_cert_encoded	This is the certificate (PEM/Base64 encoded).
ssl_cert_encoded	This is the certificate (PEM/Base64 encoded).
ssl_cert_store	This is the name of the certificate store for the client certificate.
ssl_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type	This is the type of certificate store for this certificate.
ssl_cert_subject	This is the subject of the certificate used for client authentication.
ssl_provider	This specifies the SSL/TLS implementation to use.
ssl_server_cert_encoded	This is the certificate (PEM/Base64 encoded).
terminal_number	Terminal number assigned by Paymentech.
timeout	A timeout for the class.
transaction_amount	Purchase amount for an authorization.
user_id	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.
credit	Credits a cardholder's account.
interrupt	Interrupt the current method.
reset	Clears all properties to their default values.
sale	Sends a Sale transaction to the host.

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.


on_data_packet_in	Fired when receiving a data packet from the transaction server.
on_data_packet_out	Fired when sending a data packet to the transaction server.
on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	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.


AllowPartialAuths	Indicates whether partial authorizations are to be supported.
CustomerDefinedData	Additional transaction identification data.
DeviceID	Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.
DiscoverAuthAmount	Returns the amount authorized for the transaction.
DiscoverPINCapabability	Indicates if the POS is capable of supporting a PIN.
DiscoverPOSEntryMode	Returns the method by which the primary account number was entered at the POS.
DiscoverProcessingCode	Returns the type of Authorization request that was submitted to Discover.
DiscoverSystemTraceAuditNumber	Returns the value assigned by the host/merhant to assist in identifying a specific transaction.
DiscoverTrackDataCondition	Returns condition of the track data.
EMVData	The EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSource	The EMV Data Entry Source (DES).
HardwareSerialNum	Hardware Serial Number.
HostProcessingTypes	Host Processing Platform.
IsOfflinePINDebit	Specifies whether this is an Offline PIN Debit transaction.
RequestBalanceInfo	Specifies whether to request balance information.
ResponseEMVCardAuthCode	The ChaseNet and Visa card authentication results code.
ResponseEMVData	The response EMV data.
ResponseEMVDownloadIndicator	Whether EMV parameters should be updated.
ResponsePOSRetrievalNumber	POS Retrieval Number sent in the request, echoed back in the response.
SettlementMode	Indicates whether the class uses Paymentech's Host Capture or Terminal Capture system.
SoftwareID	Software Identifier.
SystemInformation	System Information field for Batch Inquiry and Release transactions.
VendorID	Hardware/Vendor Identifier.
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.
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.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
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.

card_magnetic_stripe Property

Track 2 data read off of the card's magnetic stripe.

Syntax

def get_card_magnetic_stripe() -> str: ...
def set_card_magnetic_stripe(value: str) -> None: ...

card_magnetic_stripe = property(get_card_magnetic_stripe, set_card_magnetic_stripe)

Default Value

Remarks

Track 2 data read off of the card's magnetic stripe. Debit cards may only be submitted with Track 2 data, and cannot be manually entered. Setting this property with track 1 data will not cause the class to fail with an error, but the transaction will not be approved, and the Paymentech server may return an error.

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

client_number Property

Merchant configuration property, assigned by Paymentech.

Syntax

def get_client_number() -> str: ...
def set_client_number(value: str) -> None: ...

client_number = property(get_client_number, set_client_number)

Default Value

Remarks

The client_number will be supplied to you by Paymentech.

debit_cash_back Property

Optional cash back amount for debit transactions.

Syntax

def get_debit_cash_back() -> str: ...
def set_debit_cash_back(value: str) -> None: ...

debit_cash_back = property(get_debit_cash_back, set_debit_cash_back)

Default Value

Remarks

This property may contain an optional cash back amount when authorizing a debit card transaction. The value of the transaction_amount must reflect the cost of the goods or service purchased plus this debit_cash_back amount. This property is presented in US Dollars with a decimal point in the proper position. The maximum value for this property is "999999.99".

If the debit_pin and debit_ksn are not populated, the value of this property is ignored.

Note: If either the debit_pin or debit_ksn properties are present, the class will assume this is a debit card transaction. Debit transactions are only supported by the Retail industry_type, and only for Card Present transactions. For any other type of transaction the class fails with an error.

class.IndustryType = itRetail class.CardEntryDataSource = edsTrack2 class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.TransactionAmount = "25.00" class.PINCapability = ppVerifiedPIN class.DebitPIN = "623F36B53CC18393" class.DebitKSN = "000000008F000021" class.DebitCashBack = "5.00" class.Sale()

This must be formatted as a dollar amount with a real decimal point, excluding the dollar sign. For instance "12.00"

debit_ksn Property

Clear-text Key Sequence Number, used for Debit transactions.

Syntax

def get_debit_ksn() -> str: ...
def set_debit_ksn(value: str) -> None: ...

debit_ksn = property(get_debit_ksn, set_debit_ksn)

Default Value

Remarks

The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Debit Card transactions. The maximum length is 16 characters.

debit_pin Property

DUKPT DES encrypted PIN block, used for Debit transactions.

Syntax

def get_debit_pin() -> str: ...
def set_debit_pin(value: str) -> None: ...

debit_pin = property(get_debit_pin, set_debit_pin)

Default Value

Remarks

The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Debit Card transactions. The maximum length is 16 characters.

duplicate_checking Property

Indicates whether duplicate checking is enabled.

Syntax

def get_duplicate_checking() -> int: ...
def set_duplicate_checking(value: int) -> None: ...

duplicate_checking = property(get_duplicate_checking, set_duplicate_checking)

Default Value

Remarks

This Duplicate Checking Indicator is used to tell the Host whether or not to check for duplicate transactions. This property is not valid for batch_inquiry and batch_release transactions.

In order to be viewed as a duplicate, the transaction must be exactly the same as the original. This includes sequence_number and transaction_amount.


duDoNotSendIndicator (0)	Duplicate Checking Indicator is not sent in the authorization request.
duNoDuplicateChecking (1)	No duplicate checking is performed.
duErrorOnDuplicate (2)	Duplicate sequence_numbers are not allowed within the current open batch. Transaction requests containing duplicate sequence_numbers will receive an error response.
duReturnOriginalResponse (3)	Treats authorization requests (within the current batch) containing the same sequence_number, card_number, transaction_amount, and the current Transaction Type as duplicate transactions. If a duplicate is found and it was approved, the host will respond with the original response data. If no duplicate is found, or the duplicate was an error, normal authorization processes will be followed.

industry_type Property

Determines the merchant's industry type.

Syntax

def get_industry_type() -> int: ...
def set_industry_type(value: int) -> None: ...

industry_type = property(get_industry_type, set_industry_type)

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 industry_type has the side effect of changing the card_entry_data_source to the default value for the selected industry type. In addition, setting the industry_type to itDirectMarketing or itECommerce will also reset the pin_capability to ppNoPIN.

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

Note: Only Retail, Restaurant, and Hotel IndustryTypes are supported for debit transactions.

invoice_number Property

Merchant-generated invoice number.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

Remarks

This property contains a merchant-generated invoice number. This number should be unique for each transaction. The maximum length for this properties varies depending on the industry_type. For Retail transactions the max length is 6 characters. For Direct Marketing transactions it is 9 characters, and for Electronic Commerce transactions the maximum length is 16 characters. Any text beyond these limits will be truncated by the class.

merchant_number Property

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

Syntax

def get_merchant_number() -> str: ...
def set_merchant_number(value: str) -> None: ...

merchant_number = property(get_merchant_number, set_merchant_number)

Default Value

Remarks

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

password Property

Password for authentication with the NetConnect Server .

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

Remarks

The password will be supplied to you by Paymentech.

pin_capability Property

Indicates if the terminal device supports a PIN pad.

Syntax

def get_pin_capability() -> int: ...
def set_pin_capability(value: int) -> None: ...

pin_capability = property(get_pin_capability, set_pin_capability)

Default Value

Remarks

This property indicates to the host whether the merchant's terminal has a PIN entry pad. Valid values for this property are:


Unknown (0)	Unknown.
ppAcceptsPIN (1)	Terminal device accepts PIN entry.
ppNoPIN (2)	Terminal device does not accept PIN entry.
ppPadInoperative (8)	PIN pad inoperative.
ppVerifiedPIN (9)	PIN Verified by terminal device.

NOTE: For Host Capture US Debit transactions the valid PINCapability values are ppUnknown(0) and ppAcceptsPIN(1).

pos_retrieval_number Property

Merchant-generated reference number, used for reversals.

Syntax

def get_pos_retrieval_number() -> str: ...
def set_pos_retrieval_number(value: str) -> None: ...

pos_retrieval_number = property(get_pos_retrieval_number, set_pos_retrieval_number)

Default Value

Remarks

This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the PTechReversal class to reverse an authorization or sale.

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

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 proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

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.

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

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

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

Remarks

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

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

proxy_ssl Property

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

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

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.

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

response_approval_code Property

Contains an authorization code when a transaction has been approved, or an error code.

Syntax

def get_response_approval_code() -> str: ...

response_approval_code = property(get_response_approval_code, None)

Default Value

Remarks

Contains an authorization code when a transaction has been approved, or an error code. This six character field contains an authorization code when a transaction has been approved. If the response_code returned indicates that the transaction has not been approved, then this field will contain an error code, and the response_text property will contain the description. Note that the host does not send back an actual authorization code for Credit Returns. Instead, the host sends back six blank spaces in the authorization code field. Credit VOIDS return the original authorization number.

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

This property is read-only.

response_authorized_amount Property

Used for partial authorizations.

Syntax

def get_response_authorized_amount() -> str: ...

response_authorized_amount = property(get_response_authorized_amount, None)

Default Value

Remarks

Used for partial authorizations. Indicates the actual amount authorized from the stored value card. If the customer does not have enough on his stored value card to cover the complete cost of the purchase, the merchant may request that the host perform a partial redemption. The full stored value card will be used to fund as much of the transaction as possible, and the remainder may be funded by some other form of payment. When partial_redemption is set to True, the host will supply the actual amount authorized from the stored value card in the response_authorized_amount field.

Note that the response_authorized_amount will only contain a value if the PartialRedemption property in the authorizing class was set to True. It will remain blank otherwise.

This property is read-only.

response_auth_source Property

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

def get_response_auth_source() -> str: ...

response_auth_source = property(get_response_auth_source, None)

Default Value

Remarks

Indicates the source of the authorization code stored in response_approval_code. This field contains a one character code indicating the source of the response_approval_code. The received code must be stored and submitted in the batch settlement. Valid source codes:


Code	Description
1	STIP (Stand-In Processing): time-out response.
2	STIP: amount below issuer limit.
3	STIP: issuer in Suppress Inquiry mode.
4	STIP: issuer unavailable.
5	Issuer generated response.
6	Off-line approval: POS device generated.
7	Acquirer approval: Base I unavailable.
8	Acquirer approval of a referral.
9	Use for non-authorized transactions; such as credit card credits.
D	Referral: authorization code manually keyed.
E	Off-line approval: authorization code manually keyed.
F	CAFIS Interface Off-Line Post-Auth.*
G	Issuer Approval: Post-Auth.*
T	Advice of a Telcode File change initiated by the VisaPhone Issuer Direct Service.

* Currently in use by Japan Acquirer Services (JAS).

This property is read-only.

response_avs_result Property

Contains the Address Verification System result code.

Syntax

def get_response_avs_result() -> str: ...

response_avs_result = property(get_response_avs_result, None)

Default Value

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below. Please see the response_code property for a more detailed list of response_code and response_avs_result code combinations.

Valid AVS Codes:


Code	Description
0	Address verification was not requested.
A	customer_address matches, customer_zip does not.
E	AVS error / Ineligible (not a mail/phone order).
G	Ver Unavailable - Non-US Issuer does not participate.
I	Ver Unavailable - Address information not verified for international transaction.
M	Exact Match - customer_address match for international transaction.
N	No match on customer_address or customer_zip.
R	Retry - Issuer system unavailable.
S	Service not supported by issuer.
U	Address information is unavailable.
W	Nine digit customer_zip matches, customer_address does not.
X	Exact AVS match, nine digit customer_zip.
Y	Exact AVS match, five digit customer_zip.
Z	Five digit customer_zip matches, customer_address does not.

If supporting international transactions, six additional International Address Verification Service (IAVS) codes are introduced:


B	Street address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
C	Street address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code).
D	Street addresses and postal codes match for international transaction.
I	Address information not verified for international transaction.
M	Street addresses and postal codes match for international transaction.
P	Postal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code).

This property is read-only.

response_batch_number Property

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

def get_response_batch_number() -> str: ...

response_batch_number = property(get_response_batch_number, None)

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.

This property is read-only.

response_card_level Property

This property contains a two-character code created by Visa during the authorization process.

Syntax

def get_response_card_level() -> str: ...

response_card_level = property(get_response_card_level, None)

Default Value

Remarks

This property contains a two-character code created by Visa during the authorization process.

The current list of possible return values can be found below: Visa Card Level Results Code:


Code	Meaning
Spaces	Not applicable
A^	Visa Traditional
AX*	American Express
B^	Visa Traditional Rewards
C^	Visa Signature
D^	Visa Infinite
DI*	Discover
E^	Reserved
F^	Reserved
G^	Visa Business Card
G1	Visa Signature Business
G2	Visa Business Check Card
H^	Classic Visa Check Card
I^	Visa Commerce
J^	Reserved
J1	Visa General Prepaid
J2	Visa Prepaid Gift Card
J3	Visa Prepaid Healthcare
J4	Visa Prepaid Commercial
K^	Visa Corporate Card
K1	Visa GSA Corporate T&E
L^	Reserved
M^*	MasterCard/EuroCard and Diners
N^ - P^	Reserved
Q^	Private Label
Q1	Private Label Prepaid
R^	Proprietary Card
S^	Visa Purchasing Card
S1	Visa Fleet
S2	Visa GSA Purchasing
S3	Visa GSA Purchasing with Fleet
T^	Reserved/Interlink
U^	Visa TravelMoney
W^ - Z^	Reserved
0^ - 9^	Reserved


^	Space
*	Valid only when the transaction was re-routed to Visa for authorization.

This property is read-only.

response_card_type Property

Type of the credit card.

Syntax

def get_response_card_type() -> str: ...

response_card_type = property(get_response_card_type, None)

Default Value

Remarks

Type of the credit card.

Paymentech determines the type of credit card used for each authorization, and returns that value to the merchant in the response. The following is a list of card mnemonics and their meanings.


VI	Visa
MC	MasterCard
AE	American Exp.
DS	Discover
JC	JCB
DB	Debit
EB	EBT
SV	Stored Value
CK	Check Authorization
IG	In Good Taste
PL	Retail PL
CC	Club Card
SC	Smarte Carte
TH	TCH Light Fleet
TS	TCRS Consumer Card
IR	Irving Oil PL
RA	RAI
DY	Disney Rewards
SR	Sears PL
BE	Best
EN	Enmark
GC	FleetCor / GasCard
VY	Voyager
FO	Fleet One
SH	Shell
GT	Gate
WX	WEX
MM	MotoMart
??	Included in Batch Totals by Card Type responses when the host has summarized more than 14 card types within the batch (includes all other card types in the batch over 14).
99	Supported in Enhanced Batch Inquiry requests when "all" details or totals are being requested.

This property is read-only.

response_code Property

Indicates the status of the authorization request.

Syntax

def get_response_code() -> str: ...

response_code = property(get_response_code, None)

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.

response_cvv_result Property

Contains the returned CVV result code if it was requested.

Syntax

def get_response_cvv_result() -> str: ...

response_cvv_result = property(get_response_cvv_result, None)

Default Value

Remarks

Contains the returned CVV result code if it was requested. If a CVV value was present in the card_cvv_data property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CardCVVData property is filled. Instead, an AMEX transaction will be declined if the CVV value does not match, with an response_text indicating such. The following is a list of current result codes:


M	CVV2 match.
N	CVV2 no match.
P	Not processed.
S	Merchant has indicated that CVV2 is not present on card.
U	Issuer not certified and/or has not provided Visa encryption keys.

This property is read-only.

response_debit_surcharge Property

Additional fee charged for debit transactions.

Syntax

def get_response_debit_surcharge() -> str: ...

response_debit_surcharge = property(get_response_debit_surcharge, None)

Default Value

Remarks

Additional fee charged for debit transactions. This property contains the fee, if any, charged by the host for debit card transactions. The Surcharge Fee field is present only if greater than 0.00. If there was no surcharge for this transaction, the response_debit_surcharge property will remain empty. If present, the Surcharge amount must print on receipt and be labeled as "TERMINAL FEE".

This property is read-only.

response_debit_trace Property

This property is returned in the response to a debit card transaction.

Syntax

def get_response_debit_trace() -> str: ...

response_debit_trace = property(get_response_debit_trace, None)

Default Value

Remarks

This property is returned in the response to a debit card transaction. The returned value is used for transaction tracking purposes, and must be printed on the customer's receipt.

Note: For normal credit card transactions, this property may contain Interchange compliance data for qualified Visa and MasterCard transactions.

This property is read-only.

response_network_id Property

Authorizing network Identifier which indicates which network approved this transaction.

Syntax

def get_response_network_id() -> str: ...

response_network_id = property(get_response_network_id, None)

Default Value

Remarks

Authorizing network Identifier which indicates which network approved this transaction. A list of codes follows.


00	Not electronically authorized
31	Chase Paymentech Stored Value
01	VisaNet
65	Comdata/SVS Stored Value
02	MasterCard BankNet
34	Bank of Nova Scotia
03	Maestro Direct
35	Royal Bank of Canada - V
04	Club Card Private Label
36	Royal Bank of Canada - T
05	MAC Direct
37	Royal Bank of Canada - M
06	American Express Direct
38	The Toronto-Dominion Bank - 1
11	WEX (Wright Express)
39	The Toronto-Dominion Bank - 3
12	Novus (Discover)
40	National Bank of Canada
15	Sears Private Label
43	d'economie Desjardins du Quebec
16	Fleet One
44	Credit Union Central of Canada
17	Shell
45	CGI Credit Union Central of Canada - 2
19	TCH
46	CGI
20	Pulse Direct
48	CU Connect
21	Interlink Direct
49	CIBC - 5
22	MotoMart
51	Shazam Direct
23	Private Label - PL1
53	AFFN Direct
25	NYCE Direct
54	CIBC - 6
28	FleetCor / GasCard Authorizer
56	CU Central of British Columbia
29	MPS Gateway - Accell, AFFN, Alaska Option, CU24, CU24M, Explore, Honor, Interlink MPS, Jeannie, MAC-MPS, Maestro, Moneystation, MPS EBT Gateway, NYCE, PULSE, Shazam, Tempo
64	Maestro Canada
30	STAR Direct
69	ACCEL Direct
33	Bank of Montreal
73	ETC Scan Check Authorizer

This property is read-only.

response_retrieval_number Property

Reference number returned from the Paymentech host.

Syntax

def get_response_retrieval_number() -> str: ...

response_retrieval_number = property(get_response_retrieval_number, None)

Default Value

Remarks

Reference number returned from the Paymentech host. This is the reference number of the transaction as assigned by the Paymentech host. This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the void_transaction method.

If the SettlementMode is set to manual this property will contain the POSRetrievalNumber submitted in the authorization. If no POSRetrievalNumber was sent, this property will contain all zeros, and you will not have a reference number for the transaction.

If the SettlementMode is set to host settle, this property will always contain the Paymentech-generated retrieval number returned by the transaction server, regardless of the value contained in the POSRetrievalNumber property.

In all cases, the response_retrieval_number will contain the number used to reference the transaction when issuing voids or reversals.

This property is read-only.

response_sequence_number Property

SequenceNumber echoed from the authorization.

Syntax

def get_response_sequence_number() -> str: ...

response_sequence_number = property(get_response_sequence_number, None)

Default Value

Remarks

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

This property is read-only.

response_text Property

Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result.

Syntax

def get_response_text() -> str: ...

response_text = property(get_response_text, None)

Default Value

Remarks

Approval/Decline/Error text message information This field contains a response or display text message, and is used by the terminal to display the authorization result. This property will contain human-readable text indicating whether the transaction was approved or declined, or will contain a description of the error. The actual error code will be returned in the response_approval_code property. The response_text property is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the response_code property to determine this.

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

This property is read-only.

response_transaction_id Property

This 15-character property contains the Transaction Identifier assigned by the card issuer or network.

Syntax

def get_response_transaction_id() -> str: ...

response_transaction_id = property(get_response_transaction_id, None)

Default Value

Remarks

This 15-character property contains the Transaction Identifier assigned by the card issuer or network. Transaction Identifier is used to link subsequent MIT transactions to an original CIT transaction.

Note: Merchants are responsible for retaining the response TransactionId from the original transaction and submitting the TransactionId in subsequent MIT transactions.

This property is read-only.

sequence_number Property

Sequence number of the transaction.

Syntax

def get_sequence_number() -> int: ...
def set_sequence_number(value: int) -> None: ...

sequence_number = property(get_sequence_number, set_sequence_number)

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 settlement_mode, 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 response_sequence_number property.

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

server Property

The URL for the PaymenTech NetConnect server.

Syntax

def get_server() -> str: ...
def set_server(value: str) -> None: ...

server = property(get_server, set_server)

Default Value

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

Remarks

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

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

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 list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password 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.

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

Remarks

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

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

This property is read-only.

terminal_number Property

Terminal number assigned by Paymentech.

Syntax

def get_terminal_number() -> str: ...
def set_terminal_number(value: str) -> None: ...

terminal_number = property(get_terminal_number, set_terminal_number)

Default Value

Remarks

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

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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

transaction_amount Property

Purchase amount for an authorization.

Syntax

def get_transaction_amount() -> str: ...
def set_transaction_amount(value: str) -> None: ...

transaction_amount = property(get_transaction_amount, set_transaction_amount)

Default Value

Remarks

This field contains the transaction amount to be authorized. The transaction amount is presented in US Dollars with a decimal point in the proper position. If sending a Debit transaction and the customer requests cash back, the transaction_amount must include the total cost of the purchase, PLUS the debit_cash_back amount.

This must be formatted as a dollar amount with a real decimal point, excluding the dollar sign. For instance "12.00"

user_id Property

UserId for authentication with the NetConnect Server .

Syntax

def get_user_id() -> str: ...
def set_user_id(value: str) -> None: ...

user_id = property(get_user_id, set_user_id)

Default Value

Remarks

The user_id will be supplied to you by PaymenTech.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

credit Method

Credits a cardholder's account.

Syntax

def credit() -> None: ...

Remarks

Also known as a Return, this transaction refunds the cardholder's account. This can be performed any time and in any batch, and is not based on a previous transaction. To credit a transaction in the current open batch, use the void_transaction method instead.

Manually keyed credit: class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" 'credits $1.00 class.Credit()

Note: This method is not available when using the Terminal Capture settlement_mode.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

sale Method

Sends a Sale transaction to the host.

Syntax

def sale() -> None: ...

Remarks

A basic sale transaction. This transaction decrements the cardholder's open-to-buy funds for the sale amount. This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the PTechHostSettle class. Sample transactions follow.

E-Commerce Sale transaction: class.IndustryType = itECommerce class.GoodsIndicator = giPhysicalGoods class.CardEntryDataSource = dsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.CustomerAddress = "123 Nowhere Ln." ' optional AVS data class.CustomerZip = "90210" ' optional AVS data class.TransactionAmount = "1.00" class.Sale()

Retail Sale transaction: class.IndustryType = itRetail class.CardEntryDataSource = dsTrack1 class.CardMagneticStripe = "B4788250000028291^PAYMENTECH^05121015432112345678" class.TransactionAmount = "1.00" class.Sale()

Retail manually keyed Sale transaction: class.IndustryType = itRetail class.CardEntryDataSource = dsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.Sale()

on_data_packet_in Event

Fired when receiving a data packet from the transaction server.

Syntax

class PTechDebitDataPacketInEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class PTechDebit:
@property
def on_data_packet_in() -> Callable[[PTechDebitDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[PTechDebitDataPacketInEventParams], None]) -> None: ...

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.

on_data_packet_out Event

Fired when sending a data packet to the transaction server.

Syntax

class PTechDebitDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class PTechDebit:
@property
def on_data_packet_out() -> Callable[[PTechDebitDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[PTechDebitDataPacketOutEventParams], None]) -> None: ...

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.

on_error Event

Information about errors during data delivery.

Syntax

class PTechDebitErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PTechDebit:
@property
def on_error() -> Callable[[PTechDebitErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PTechDebitErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class PTechDebitSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class PTechDebit:
@property
def on_ssl_server_authentication() -> Callable[[PTechDebitSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[PTechDebitSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class PTechDebitSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class PTechDebit:
@property
def on_ssl_status() -> Callable[[PTechDebitSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[PTechDebitSSLStatusEventParams], None]) -> None: ...

Remarks

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

PTechDebit Config Settings

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.

PTechDebit Config Settings

AllowPartialAuths: Indicates whether partial authorizations are to be supported.

When this setting is True, if the credit card being authorized does not contain sufficient funds to cover the transaction_amount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount, which is equal to the balance of the credit card. The customer must then use another form of payment to make up the remainder. The total amount authorized by Paymentech will be returned in the response_authorized_amount configuration setting. For instance, if the transaction_amount is $50, but credit card only has a $42 balance, the card is charged for $42.00, and the response_authorized_amount will be "42.00". The merchant may then collect the remaining $8 in cash, check, credit card, or any other acceptable form of payment. This setting is True by default.

CustomerDefinedData: Additional transaction identification data.

This data field will allow merchants to assign a unique value to their transaction that will assist them in reconciling their authorization activity to their settlement activity. This field is supported for all transactions and all industry_types. The data will be stored on the Paymentech system, however only Paymentech acquired merchants will see this value in their back-end reporting (Combined Extract File). Note that the maximum length for the CustomerDefinedData is 30 characters. Strings longer than 30 characters will be truncated by the class.

DeviceID: Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.

The specified value must be 4 characters long. If the DeviceID you wish to use is less than 4 characters, you must zero-fill the value. The first 2 characters are used to specify the Inside Device ID and the last 2 characters are used to specify the Outside Fuel Dispenser ID where the transaction was processed.

Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.

DiscoverAuthAmount: Returns the amount authorized for the transaction.

After an operation this setting may be queried to return the amount authorized for that transaction. The decimal point in the returned value is implied. This is a read-only configuration setting valid only for Discover transactions.

DiscoverPINCapabability: Indicates if the POS is capable of supporting a PIN.

After an operation this setting may be queried to return the code which indicates if the POS is capable of supporting a PIN. This value is determined at the host based on transaction and terminal parameter settings. This is a read-only configuration setting valid only for Discover transactions.

DiscoverPOSEntryMode: Returns the method by which the primary account number was entered at the POS.

After an operation this setting may be queried to return the method by which the PAN was entered at the POS. This is a read-only configuration setting valid only for Discover transactions.

DiscoverProcessingCode: Returns the type of Authorization request that was submitted to Discover.

After an operation this setting may be queried to return the type of authorization request that was submitted to Discover. This is a read-only configuration setting valid only for Discover transactions.

DiscoverSystemTraceAuditNumber: Returns the value assigned by the host/merhant to assist in identifying a specific transaction.

After an operation this setting may be queried to return the value assigned by the host/merhant to assist in identifying a specific transaction. This is a read-only configuration setting valid only for Discover transactions.

DiscoverTrackDataCondition: Returns condition of the track data.

After an operation this setting may be queried to return the condition of the track data. This is a read-only configuration setting valid only for Discover transactions.

EMVData: The EMV data returned from a Pin Pad after reading an EMV card.

This configuration setting takes the entire TLV (tag-length-value) EMV data received from a Pin Pad after reading an EMV card.

EMVEntryDataSource: The EMV Data Entry Source (DES).

This configuration setting tells the host what the device capability is and how the account information was physically obtained by the POS.

Valid values are:


Value	Device Capability	Presentation Method	Supported Card Types/Comments
36	Chip and Contactless Capable	Track 2 read from inserted	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
37	Chip and Contactless Capable	Insert attempted, fall back to Track 1 from swiped	Allowed on American Express, ChaseNet, International Maestro, JCB, MasterCard and Visa transactions
38	Chip and Contactless Capable	Insert attempted, fall back to Track 2 from swiped	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
39	Chip and Contactless Capable	Insert attempted, swipe attempted, fall back to keyed/ manually entered	Allowed on American Express, ChaseNet, Discover, International Maestro, JCB, MasterCard and Visa transactions
40	Chip and Contactless Capable	Track 1 read from proximity w/chip	Allowed on American Express, ChaseNet, MasterCard and Visa transactions
41	Chip and Contactless Capable	Track 2 read from proximity w/chip	Allowed on American Express, Canadian Debit, ChaseNet, Discover, MasterCard, *US Debit and Visa transactions
42	Chip and Contactless Capable	Track 1 read from proximity w/mag stripe	Allowed on American Express, ChaseNet, Discover, MasterCard and Visa transactions
43	Chip and Contactless Capable	Track 2 read from proximity w/mag stripe	Allowed on American Express, Canadian Debit, ChaseNet, Discover, MasterCard, *US Debit and Visa transactions
44	Chip and Contactless Capable	Track 1 read from swiped	Allowed on all card types except US Debit, Canadian Debit, EBT, and stored value
45	Chip and Contactless Capable	Track 2 read from swiped	Allowed on all card types
46	Chip and Contactless Capable	Keyed / Manually Entered	Allowed on all card types except US Debit and Canadian Debit (note that this code is permitted on Debit Reversal Advices however)
48	Chip (but not Contactless) Capable	Track 2 read from inserted	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
49	Chip (but not Contactless) Capable	Insert attempted, fall back to Track 1 from Swiped	Allowed on American Express, ChaseNet, International Maestro, JCB, MasterCard and Visa transactions
50	Chip (but not Contactless) Capable	Insert attempted, fall back to Track 2 from Swiped	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
51	Chip (but not Contactless) Capable	Insert attempted, swipe attempted, fall back to manually entered	Allowed on American Express, ChaseNet, Discover, International Maestro, JCB, MasterCard and Visa transactions
52	Chip (but not Contactless) Capable	Track 1 from swiped	Allowed on all card types except US Debit, Canadian Debit, EBT, and stored value.
53	Chip (but not Contactless) Capable	Track 2 from swiped	Allowed on all card types
54	Chip (but not Contactless) Capable	Keyed / Manually Entered	Allowed on all card types except US Debit and Canadian Debit.
55	Contactless Capable	Barcode read	Allowed on American Express only.
56	Chip and Contactless Capable	Barcode read	Allowed on American Express only.
57	Chip (but not Contactless) Capable	Barcode read	Allowed on American Express only.

HardwareSerialNum: Hardware Serial Number.

This field is used for POS/VAR Capabilities Data. It determines the serial number of hardware device.

HostProcessingTypes: Host Processing Platform.

This field is used for POS/VAR Capabilities Data. It can be set to the binary 'OR' of one or more of the following values:

Valid values:


Description	Value
TAS Only Credit	128 (Hex 0x80)
TAS/TCS Credit	64 (Hex 0x40)
TCS Only Credit	32 (Hex 0x20)
HCS Auth Only Credit	16 (Hex 0x10)
HCS Auth/Settle Credit	8 (Hex 0x8)
Host Extended Product Support (Debit, SV, EBT)	4 (Hex 0x4)

For TAS/TCS Credit and Host Extended Product, this configuration setting must be set to 68.

IsOfflinePINDebit: Specifies whether this is an Offline PIN Debit transaction.

When this setting is 'True', the transaction will be processed as an Offline PIN Debit transaction. You need to set EMVData configuration setting to the value returned by the POS Terminal. This setting is 'False' by default.

RequestBalanceInfo: Specifies whether to request balance information.

When this setting is 'True', the available card balance amounts will be returned via ResponseBalanceAmount1 and ResponseBalanceAmount2 and the currency codes for each amount will be returned via ResponseBalanceCurrency1 and ResponseBalanceCurrency2. This setting is 'False' by default.

ResponseEMVCardAuthCode: The ChaseNet and Visa card authentication results code.

The ChaseNet and Visa card authentication results code.

ResponseEMVData: The response EMV data.

This configuration setting contains the EMV Data in TLV (tag-length-value) format. This field will only be populated if an EMV transaction was performed and EMV Data was received in the response.

ResponseEMVDownloadIndicator: Whether EMV parameters should be updated.

If true, EMV parameters should be updated. EMVKeyMgr may be used to download current EMV parameters. This is only applicable when settlement_mode is set to 0 (Host Capture).

ResponsePOSRetrievalNumber: POS Retrieval Number sent in the request, echoed back in the response.

If the SettlementMode is set to Host Capture, Paymentech ignores the value of the pos_retrieval_number property and generates its own response_retrieval_number to reference the transaction. The ResponsePOSRetrievalNumber configuration setting can be used to return the value you sent in the request, but the response_retrieval_number will always contain the number used to reference the transaction.

SettlementMode: Indicates whether the class uses Paymentech's Host Capture or Terminal Capture system.

Possible values are:


0	Host Capture (default)
1	Terminal Capture

Note that for PTechReversal, 1 (Terminal Capture) will be the default value. If Host Capture is being used, a value of 0 will need to be set.

Host-Capture means that you authorize your transactions using the auth_only or sale methods, and you process refunds and capture outstanding authorizations with the credit and capture methods. Paymentech handles all batch management. All you need to do is use the PTechHostSettle class to release the batch for settlement (you may even set your account up for Host Auto-Close, which will automatically release the batch for settlement at the end of the business day).

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging and Restaurant industry_types, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a restaurant authorization may have a GratuityAmount added to the original charge before the transaction is settled. Likewise, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types supported by PTechCharge may be processed in smTerminalCapture mode. However, Restaurant and Hotel transactions MUST be authorized and settled in smTerminalCapture mode. Attempting to authorize a Restaurant or Hotel/Lodging transaction with the SettlementMode; set to 0 (Host Capture) will cause the class fails with an error.

When processing transactions in smTerminalCapture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle classs. Attempting to call the void_transaction or capture methods the class fails with an error.

SoftwareID: Software Identifier.

This field is used for POS/VAR Capabilities Data. It is assigned by Paymentech at the time of certification.

Default value is "010C".

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

VendorID: Hardware/Vendor Identifier.

This field is used for POS/VAR Capabilities Data. It is assigned by Paymentech at the time of certification.

Default value is "0076".

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 http_version 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 local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file 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 auth_scheme 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 on_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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 on_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 follow_redirects 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 http_version 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 proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

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