PTechHotel Class

Properties   Methods   Events   Config Settings   Errors  

The PTECHHOTEL class is used to authorize credit card transactions for the Hotel IndustryType with the Paymentech NetConnect system on the Tampa platform. This class creates a simple interface for processing transactions in the Hotel environment. It allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

class dpaymentssdk.PTechHotel

Remarks

Setting up the class and authorizing a transaction is easy. 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.

After the merchant information is setup, you may enter transaction data. When the Credit Card's card_entry_data_source is Manually Entered, the merchant should fill the card_number, card_exp_month, and card_exp_year properties. Address Verification Service (AVS) data may be sent in card-present retail transactions by filling the customer_address and customer_zip properties. For any other card_entry_data_source , the card_magnetic_stripe property should be filled. In addition, the transaction_amount should be set with the total amount for the transaction, including any taxes.

Now you should set the hotel properties with extra information about the transaction. At minimum you should set the hotel_arrival_date (or reservation date), estimated hotel_duration of stay, hotel_departure_date (planned or actual), and hotel_sale_code. If the transaction is card-not-present (ie: phone or online reservation) and the customer supplies a Visa, MasterCard, or American Express card for payment, you must also set the hotel_preferred_customer to True. This indicates a card-not-present transaction for these two card types. Other card types must use the PTechECommerce class for card-not-present transactions.

Now simply call the sale or auth_only method to send the authorization to the Paymentech server.

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.

Hotel transactions only operate in Terminal Capture mode. This means you cannot rely on Paymentech to automatically handle the settlement for you. Instead, you must save the XML aggregate returned from the get_detail_aggregate method, for each and every authorization. At the end of the day, you must then use the PTechManualSettle class to send all of these aggregates for processing. The reason Paymentech cannot handle the batch automatically for the PTechHotel class is because Hotel transactions by nature will usually have additional charges tacked on to the originally authorized amount. It may also be several days between check-in (authorization) and departure (when you can then settle the card). The XML aggregates for each transaction may be manipulated using the PTechDetailRecord class. This will allow you to add or remove additional days to the stay, tack on charges for room service or telephone calls, and more.

Note that when processing transactions in Terminal Capture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle classs.

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_typeType of credit card being used in this transaction.
card_cvv_dataThree digit security code on back of card (optional).
card_cvv_presenceIndicates the presence of the card verification value.
card_entry_data_sourceThis property contains a 1-character code identifying the source of the customer data.
card_exp_monthExpiration month of the credit card specified in Number .
card_exp_yearExpiration year of the credit card specified in Number .
card_is_encryptedDetermines whether data set to the Number or MagneticStripe properties is validated.
card_magnetic_stripeTrack data read off of the card's magnetic stripe.
card_numberCustomer's credit card number for the transaction.
client_numberMerchant configuration property, assigned by Paymentech.
customer_addressThe customer's billing address.
customer_zipCustomer's zip code (or postal code if outside of the USA).
hotel_arrival_dateDate the customer checked in, or the expected arrival date when authorizing a reservation.
hotel_charge_descriptorProvides additional information about what this transaction was used for at the hotel.
hotel_departure_dateDate the customer checked out, or the expected check-out date when authorizing a reservation.
hotel_durationThe number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation.
hotel_extra_charge_amountTotal amount of extra charges incurred by the customer.
hotel_extra_charges_codeList of extra charges added to the cost of lodging.
hotel_preferred_customerSet this property to True to process a hotel transaction as card-not-present.
hotel_sale_codeProvides additional details about the type of this transaction.
invoice_numberHotel Folio Number.
merchant_numberA unique number used to identify the merchant, assigned by Paymentech.
passwordPassword for authentication with the NetConnect Server .
pin_capabilityIndicates if the terminal device supports a PIN pad.
pos_retrieval_numberMerchant-generated reference number, used for reversals.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_userThis property contains a username if authentication is to be used for the proxy.
response_approval_codeContains an authorization code when a transaction has been approved, or an error code.
response_authorized_amountUsed for partial authorizations.
response_auth_sourceIndicates the source of the authorization code stored in ApprovalCode .
response_avs_resultContains the Address Verification System result code.
response_batch_numberCurrent 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_levelThis property contains a two-character code created by Visa during the authorization process.
response_card_typeType of the credit card.
response_codeIndicates the status of the authorization request.
response_cvv_resultContains the returned CVV result code if it was requested.
response_debit_surchargeAdditional fee charged for debit transactions.
response_debit_traceThis property is returned in the response to a debit card transaction.
response_network_idAuthorizing network Identifier which indicates which network approved this transaction.
response_retrieval_numberReference number returned from the Paymentech host.
response_sequence_numberSequenceNumber echoed from the authorization.
response_textApproval/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_idThis 15-character property contains the Transaction Identifier assigned by the card issuer or network.
sequence_numberSequence number of the transaction.
serverThe URL for the PaymenTech NetConnect server.
ssl_accept_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_providerThis specifies the SSL/TLS implementation to use.
ssl_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
terminal_numberTerminal number assigned by Paymentech.
timeoutA timeout for the class.
transaction_amountPurchase amount for an authorization.
user_idUserId 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.

auth_onlySends an AuthOnly transaction to the host.
configSets or retrieves a configuration setting.
creditCredits a cardholder's account or obtains a Return Authorization.
get_detail_aggregateReturns an aggregate containing details of this transaction, which is then used for manual settlement.
interruptInterrupt the current method.
resetClears all properties to their default values.
saleSends a Sale transaction to the host.
visa_incrementalIncreases the TransactionAmount of a previously-submitted transaction.
visa_reversalDecreases the TransactionAmount of a previously-submitted transaction.

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_inFired when receiving a data packet from the transaction server.
on_data_packet_outFired when sending a data packet to the transaction server.
on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusFired 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.

AllowPartialAuthsIndicates whether partial authorizations are to be supported.
CAVVAuthenticationCAVV data from a ThreeDSecure authentication.
CustomerDefinedDataAdditional transaction identification data.
DeviceIDUsed to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.
DeviceTypeIndicates the Remote Payment Type for MasterCard Contactless Authorizations.
DiscoverAuthAmountReturns the amount authorized for the transaction.
DiscoverPINCapababilityIndicates if the POS is capable of supporting a PIN.
DiscoverPOSEntryModeReturns the method by which the primary account number was entered at the POS.
DiscoverProcessingCodeReturns the type of Authorization request that was submitted to Discover.
DiscoverSystemTraceAuditNumberReturns the value assigned by the host/merhant to assist in identifying a specific transaction.
DiscoverTrackDataConditionReturns condition of the track data.
ECommerceIndicatorUsed to specify the indicator describing the type of internet transaction.
EMVDataThe EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSourceThe EMV Data Entry Source (DES).
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
HardwareSerialNumHardware Serial Number.
HostProcessingTypesHost Processing Platform.
MessageReasonCodeMessage Reason Code.
MITTransactionIdTransaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale or AuthOnly transaction.
POSEntryModeCOFPOS Entry Mode Credential on File.
POSEnvironmentCodePOS Environment Code.
RequestBalanceInfoSpecifies whether to request balance information.
RequestTransactionIdIndicates the Transaction Identifier is requested.
ResponseBalanceAmount1Credit Prepaid Available Balance #1.
ResponseBalanceAmount2Credit Prepaid Available Balance $2.
ResponseBalanceCurrency1Currency code for ResponseBalanceAmount1.
ResponseBalanceCurrency2Currency code for ResponseBalanceAmount2.
ResponseEMVCardAuthCodeThe ChaseNet and Visa card authentication results code.
ResponseEMVDataThe response EMV data.
ResponseEMVDownloadIndicatorWhether EMV parameters should be updated.
ResponsePOSRetrievalNumberPOS Retrieval Number sent in the request, echoed back in the response.
SettlementModeIndicates whether the class uses Paymentech's Host Capture or Terminal Capture system.
SoftwareIDSoftware Identifier.
SystemInformationSystem Information field for Batch Inquiry and Release transactions.
VendorIDHardware/Vendor Identifier.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

card_type Property

Type of credit card being used in this transaction.

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the card_number is set, but it can also be changed manually. A list of valid card types is included below.

ctUnknown (0) Invalid or unknown prefix, card type not known.
ctVisa (1) Visa or Delta Card.
ctMasterCard (2) MasterCard.
ctAMEX (3) American Express Card.
ctDiscover (4) Discover Card.
ctDiners (5) Diners Club or Carte Blanche Card.
ctJCB (6) JCB Card.
ctVisaElectron (7) Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8) Maestro Card
ctLaser (10) Laser Card (Ireland)

card_cvv_data Property

Three digit security code on back of card (optional).

Syntax

def get_card_cvv_data() -> str: ...
def set_card_cvv_data(value: str) -> None: ...

card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the card_cvv_data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, card_cvv_presence will be automatically set to cvpProvided. If set to empty string (""), card_cvv_presence will be automatically set to cvpNotProvided.

card_cvv_presence Property

Indicates the presence of the card verification value.

Syntax

def get_card_cvv_presence() -> int: ...
def set_card_cvv_presence(value: int) -> None: ...

card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of card_cvv_data.

The class will automatically set this value to cvpProvided when a card_cvv_data value is specified. You can explicitly specify the card_cvv_presence indicator by setting this property.

Available values are:

  • cvpNotProvided (0)
  • cvpProvided (1)
  • cvpIllegible (2)
  • cvpNotOnCard (3)

card_entry_data_source Property

This property contains a 1-character code identifying the source of the customer data.

Syntax

def get_card_entry_data_source() -> int: ...
def set_card_entry_data_source(value: int) -> None: ...

card_entry_data_source = property(get_card_entry_data_source, set_card_entry_data_source)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

edsTrack1 (0) Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1) Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2) Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (card_number, card_exp_month, and card_exp_year are sent).
edsKiosk (9)Automated kiosk transaction. Track1 or Track2 data must be sent in card_magnetic_stripe, the transaction cannot be manually entered.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

TSYSHCBenefit edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce edsManualEntryNoCardReader
TSYSHCRetail edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

card_exp_month Property

Expiration month of the credit card specified in Number .

Syntax

def get_card_exp_month() -> int: ...
def set_card_exp_month(value: int) -> None: ...

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

1

Remarks

Expiration month of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

card_exp_year Property

Expiration year of the credit card specified in Number .

Syntax

def get_card_exp_year() -> int: ...
def set_card_exp_year(value: int) -> None: ...

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

2000

Remarks

Expiration year of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

card_is_encrypted Property

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

def get_card_is_encrypted() -> bool: ...
def set_card_is_encrypted(value: bool) -> None: ...

card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)

Default Value

FALSE

Remarks

Determines whether data set to the card_number or card_magnetic_stripe fields is validated.

By default, when the card_number or card_magnetic_stripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and card_magnetic_stripe data will be parsed for the track specified by card_entry_data_source. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the card_number or card_magnetic_stripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the card_type may be affected, and the card number will not be verified.

card_magnetic_stripe Property

Track 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 data read off of the card's magnetic stripe.

If card_entry_data_source is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the card_entry_data_source property to indicate which track you are sending.

The following example shows how to set the card_magnetic_stripe and card_entry_data_source properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

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.

card_number Property

Customer's credit card number for the transaction.

Syntax

def get_card_number() -> str: ...
def set_card_number(value: str) -> None: ...

card_number = property(get_card_number, set_card_number)

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with card_magnetic_stripe data, this property should be left empty.

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.

customer_address Property

The customer's billing address.

Syntax

def get_customer_address() -> str: ...
def set_customer_address(value: str) -> None: ...

customer_address = property(get_customer_address, set_customer_address)

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the customer_zip property.

customer_zip Property

Customer's zip code (or postal code if outside of the USA).

Syntax

def get_customer_zip() -> str: ...
def set_customer_zip(value: str) -> None: ...

customer_zip = property(get_customer_zip, set_customer_zip)

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

hotel_arrival_date Property

Date the customer checked in, or the expected arrival date when authorizing a reservation.

Syntax

def get_hotel_arrival_date() -> str: ...
def set_hotel_arrival_date(value: str) -> None: ...

hotel_arrival_date = property(get_hotel_arrival_date, set_hotel_arrival_date)

Default Value

"010101"

Remarks

Date the customer checked in, or the expected arrival date when authorizing a reservation. This property must contain an actual valid date.

hotel_charge_descriptor Property

Provides additional information about what this transaction was used for at the hotel.

Syntax

def get_hotel_charge_descriptor() -> int: ...
def set_hotel_charge_descriptor(value: int) -> None: ...

hotel_charge_descriptor = property(get_hotel_charge_descriptor, set_hotel_charge_descriptor)

Default Value

1

Remarks

Provides additional information about what this transaction was used for at the hotel. If used to pay for actual hotel accommodations, this should be set to cdLodging. If this transaction was used for any hotel-provided services, it should be set to the corresponding description listed below. Available descriptors include:

  • cdHealthClub (0)
  • cdLodging (1)
  • cdRestaurant (2)
  • cdGiftShop (3)
  • cdHairSalon (4)
  • cdConventionFees (5)
  • cdTennisClub (6)
  • cdGolfShop (7)

hotel_departure_date Property

Date the customer checked out, or the expected check-out date when authorizing a reservation.

Syntax

def get_hotel_departure_date() -> str: ...
def set_hotel_departure_date(value: str) -> None: ...

hotel_departure_date = property(get_hotel_departure_date, set_hotel_departure_date)

Default Value

"010101"

Remarks

Date the customer checked out, or the expected check-out date when authorizing a reservation. This property must contain an actual valid date.

hotel_duration Property

The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation.

Syntax

def get_hotel_duration() -> int: ...
def set_hotel_duration(value: int) -> None: ...

hotel_duration = property(get_hotel_duration, set_hotel_duration)

Default Value

1

Remarks

The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation. This property must be between 1 and 99 days.

hotel_extra_charge_amount Property

Total amount of extra charges incurred by the customer.

Syntax

def get_hotel_extra_charge_amount() -> str: ...
def set_hotel_extra_charge_amount(value: str) -> None: ...

hotel_extra_charge_amount = property(get_hotel_extra_charge_amount, set_hotel_extra_charge_amount)

Default Value

"0.00"

Remarks

Total amount of extra charges incurred by the customer. Use the hotel_extra_charges_code to indicate the types of charges that have been added on to this transaction.

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

hotel_extra_charges_code Property

List of extra charges added to the cost of lodging.

Syntax

def get_hotel_extra_charges_code() -> str: ...
def set_hotel_extra_charges_code(value: str) -> None: ...

hotel_extra_charges_code = property(get_hotel_extra_charges_code, set_hotel_extra_charges_code)

Default Value

"000000"

Remarks

List of extra charges added to the cost of lodging. You may include a list of extra charges for hotel transactions. Simply add the code below to this property. Multiple codes may be specified by concatenating them together. Only six extra charges may be added. For instance "240000" indicates the customer dined at the hotel restaurant and drank from the mini bar in his room. Available codes include:

0 None. If there are no extra charges, this property should contain six zeros- "000000".
2 Restaurant.
3 Gift shop.
4 Mini bar.
5 Telephone charges.
6 Other charges not listed.
7 Laundry service.

hotel_preferred_customer Property

Set this property to True to process a hotel transaction as card-not-present.

Syntax

def get_hotel_preferred_customer() -> bool: ...
def set_hotel_preferred_customer(value: bool) -> None: ...

hotel_preferred_customer = property(get_hotel_preferred_customer, set_hotel_preferred_customer)

Default Value

FALSE

Remarks

Set this property to True to process a hotel transaction as card-not-present. This can be used for phoned-in reservations, no-show charges, or any transaction that takes place without the customer's physical card present. This property is only applicable for Visa and MasterCard transactions. Other card types must use the PTechECommerce class for phone or internet reservations.

hotel_sale_code Property

Provides additional details about the type of this transaction.

Syntax

def get_hotel_sale_code() -> int: ...
def set_hotel_sale_code(value: int) -> None: ...

hotel_sale_code = property(get_hotel_sale_code, set_hotel_sale_code)

Default Value

1

Remarks

Provides additional details about the type of this transaction.

invoice_number Property

Hotel Folio 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 hotel folio number associated with the transaction. This number must be 6 characters in length, and must contain only digits. ("0" - "9")

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

0

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: Code 8 is not used at this time. This is for future use by Visa

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

0

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

80

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

0

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:

CodeDescription
1STIP (Stand-In Processing): time-out response.
2STIP: amount below issuer limit.
3STIP: issuer in Suppress Inquiry mode.
4STIP: issuer unavailable.
5Issuer generated response.
6Off-line approval: POS device generated.
7Acquirer approval: Base I unavailable.
8Acquirer approval of a referral.
9Use for non-authorized transactions; such as credit card credits.
DReferral: authorization code manually keyed.
EOff-line approval: authorization code manually keyed.
FCAFIS Interface Off-Line Post-Auth.*
GIssuer Approval: Post-Auth.*
TAdvice 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:

CodeDescription
0Address verification was not requested.
Acustomer_address matches, customer_zip does not.
EAVS error / Ineligible (not a mail/phone order).
GVer Unavailable - Non-US Issuer does not participate.
IVer Unavailable - Address information not verified for international transaction.
MExact Match - customer_address match for international transaction.
NNo match on customer_address or customer_zip.
RRetry - Issuer system unavailable.
SService not supported by issuer.
UAddress information is unavailable.
WNine digit customer_zip matches, customer_address does not.
XExact AVS match, nine digit customer_zip.
YExact AVS match, five digit customer_zip.
ZFive digit customer_zip matches, customer_address does not.

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

BStreet address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
CStreet address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code).
DStreet addresses and postal codes match for international transaction.
IAddress information not verified for international transaction.
MStreet addresses and postal codes match for international transaction.
PPostal 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:

CodeMeaning
SpacesNot 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
G1Visa Signature Business
G2Visa Business Check Card
H^Classic Visa Check Card
I^Visa Commerce
J^Reserved
J1Visa General Prepaid
J2Visa Prepaid Gift Card
J3Visa Prepaid Healthcare
J4Visa Prepaid Commercial
K^Visa Corporate Card
K1Visa GSA Corporate T&E
L^Reserved
M^*MasterCard/EuroCard and Diners
N^ - P^Reserved
Q^Private Label
Q1Private Label Prepaid
R^Proprietary Card
S^Visa Purchasing Card
S1Visa Fleet
S2Visa GSA Purchasing
S3Visa 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.

VIVisa
MCMasterCard
AEAmerican Exp.
DSDiscover
JCJCB
DBDebit
EBEBT
SVStored Value
CKCheck Authorization
IGIn Good Taste
PLRetail PL
CCClub Card
SCSmarte Carte
THTCH Light Fleet
TSTCRS Consumer Card
IRIrving Oil PL
RARAI
DYDisney Rewards
SRSears PL
BEBest
ENEnmark
GCFleetCor / GasCard
VYVoyager
FOFleet One
SHShell
GTGate
WXWEX
MMMotoMart
??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).
99Supported 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:

ATransaction is Approved.
EError 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:

MCVV2 match.
NCVV2 no match.
PNot processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer 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".

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 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: 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()

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.

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

0

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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

0

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail 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

0

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

60

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.

auth_only Method

Sends an AuthOnly transaction to the host.

Syntax

def auth_only() -> None: ...

Remarks

An Auth Only transaction is used to verify and reserve the cardholder's open-to-buy funds available at that time. This transaction is NOT added to the open batch. In order to settle (be paid) for this transaction, the merchant must run a capture transaction using the original response_approval_code obtained during this Auth Only transaction. This will add the transaction to the batch. The funds may then be captured by settling the batch with the batch_release method. Typically any funds blocked with a Sale or Auth Only transaction are reserved for approximately seven (7) to ten (10) days. This may vary from issuer to issuer. Sample transactions follow.

E-Commerce AuthOnly transaction: class.IndustryType = itECommerce class.CardEntryDataSource = dsManuallyEntered class.GoodsIndicator = giPhysicalGoods 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.InvoiceNumber = "1234" class.AuthOnly()

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

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

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 or obtains a Return Authorization.

Syntax

def credit() -> None: ...

Remarks

Also known as a Return, this transaction refunds the cardholder's account. It can be used in both Host Capture and Terminal Capture settlement_modes.

If you are using the Host Capture settlement_mode, the credit method will send a Return request to Paymentech. Paymentech will treat the request as an online purchase return authorization if the online return functionality is available for the given card brand and merchant. In this case an authorization request is sent to the card brand and if the authorization is successful the transaction is automatically included in the current batch for settlement. If that functionality is not available the request will be handled as an off-line credit request and will be included in the batch for settlement without requesting an authorization first.

If you are using the Terminal Capture settlement_mode, the credit method can only be used for online purchase return authorization requests when such functionality is available for the given card and merchant. It cannot be used for off-line credit transactions. When using the credit method in Terminal Capture mode you will need to get the authorization response and include the transaction in the batch to be settled using the PTechManualSettle class.

Manually keyed credit: class.CardNumber = "4444333322221111" class.CardExpMonth = 12 class.CardExpYear = 2025 class.CardEntryDataSource = dsManuallyEntered class.TransactionAmount = "1.00" 'credits $1.00 class.Credit()

get_detail_aggregate Method

Returns an aggregate containing details of this transaction, which is then used for manual settlement.

Syntax

def get_detail_aggregate() -> str: ...

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This is only used when processing on the Terminal Capture System (TCS) and using the PTechManualSettle class Generally, you will only use detail aggregates and manual settlements for the Hotel and Restaurant industry_types.

This aggregate must be passed to the PTechManualSettle class's DetailRecords array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or extra hotel charges for instance), you may use the PTechDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

PTechCharge.Sale(); PTechManualSettle.DetailRecords[0] = PTechCharge.GetDetailAggregate();

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

visa_incremental Method

Increases the TransactionAmount of a previously-submitted transaction.

Syntax

def visa_incremental(approval_code: str) -> None: ...

Remarks

This method is used exactly like sale and auth_only, except that all of the properties of the class must match the values from transaction you wish to increment. Set the transaction_amount property with the ADDITIONAL authorization amount. If the original transaction was for $100, and you wish to increment that to $150, then the transaction_amount should contain "50.00". The hotel properties may reflect additional charges or duration of stay, and these should be ONLY for the additional transaction_amount.

Once all of these properties are all set, simply call this method with the response_approval_code returned in the response to the original transaction.

An incremental transaction must NOT be added to the manual batch settlement. Instead, the detail record of the original transaction should be updated with the new settlement amount and updated hotel properties. An authorization may only be incremented once.

Paymentech has expanded support for this method and ChaseNet, MasterCard, and Visa cards are supported.

visa_reversal Method

Decreases the TransactionAmount of a previously-submitted transaction.

Syntax

def visa_reversal(approval_code: str) -> None: ...

Remarks

This method is used to partially (or fully) reverse a previously authorized transaction. This method is used much like an auth_only or sale, except that all of the properties of the class must match the values from the transaction you wish to reverse. There is however no need to set the hotel properties for a reversal, as they will not be transmitted to the host. The transaction_amount should reflect the new settlement amount - not the amount you wish to reverse. If you want to reduce a $100 transaction by $20, then the transaction_amount should be set to "80.00". If you wish to completely reverse the authorization set the transaction_amount to "0.00".

Once all of these properties are all set, simply call this method with the response_approval_code returned in the response to the original transaction.

A reversal transaction must NOT be added to the manual batch settlement. Instead, the detail record of the original transaction should be updated with the new settlement amount and hotel properties you wish to update. An authorization may be reversed multiple times.

Note: This method was renamed by Paymentech to "partial authorization reversal" (formerly called Visa Auth Reversal). In addition to that, this transaction can be submitted for a ChaseNet, Discover (including US JCB and Diners), MasterCard and Visa transaction.

on_data_packet_in Event

Fired when receiving a data packet from the transaction server.

Syntax

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

# In class PTechHotel:
@property
def on_data_packet_in() -> Callable[[PTechHotelDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[PTechHotelDataPacketInEventParams], 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 PTechHotelDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class PTechHotel:
@property
def on_data_packet_out() -> Callable[[PTechHotelDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[PTechHotelDataPacketOutEventParams], 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 PTechHotelErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class PTechHotel:
@property
def on_error() -> Callable[[PTechHotelErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PTechHotelErrorEventParams], 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 PTechHotelSSLServerAuthenticationEventParams(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 PTechHotel:
@property
def on_ssl_server_authentication() -> Callable[[PTechHotelSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[PTechHotelSSLServerAuthenticationEventParams], 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 PTechHotelSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

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

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

CAVV:   AuthenticationCAVV data from a ThreeDSecure authentication.

This setting is used to pass 3D Secure CAVV data on to the transaction server. This field must be a 28 or 32 byte Base-64 encoded value. This class may be used in conjunction with the IP*Works! 3D Secure MPI class or with any other 3D Secure MPI implementation. For example:

class.Config("CAVV=" + ThreeDSecure.AuthenticationCAVV);

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.

DeviceType:   Indicates the Remote Payment Type for MasterCard Contactless Authorizations.

This configuration setting is used to indicate the remote payment type or device type for MasterCard Contactless MSD Authorizations.

Valid values are:

Value Description
00 Card
01 Mobile Phone or Smartphone with Mobile Network Operator (MNO)
02 Key Fob
03 Watch
04 Mobile Tag
05 Wristband
06 Mobile Phone Case or Sleeve
07 Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO
08 Mobile Phone or Smartphone with Removable secure element not controlled by the MNO
09 Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO
10 Tablet or e-Reader with an MNO controlled removable secure element (SIM or UICC)
11 Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO
12 Removable secure element not controlled by the MNO
13 Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO
14 Mobile Phone or Smartphone with a payment application running in a host processor
15 Tablet or e-Reader with a payment application running in a host processor
16 Mobile Phone or Smartphone with payment application running in the TEE of a host processor
17 Tablet or E-Book with a payment application running in the TEE of a host processor
18 Watch with a payment application running in the TEE of a host processor
19 Watch with a payment application running in a host processor
20 Card
21 Phone
22 Tablet/e-reader
23 Watch/Wristband
24 Sticker
25 PC or laptop
26 Device Peripheral (Mobile phone case or sleeve)
27 Tag (Key fob or mobile tag)
28 Jewelry
29 Fashion Accessory
30 Garment
31 Domestic Appliance
32 Vehicle, including vehicle attached devices
33 Media/Gaming Device or gaming device

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.

ECommerceIndicator:   Used to specify the indicator describing the type of internet transaction.

This field is used for the Restaurant and Hotel industry types and should be set when a transaction is processed over the internet using either of the listed industry types. This enables the merchant to receive better interchange rates and higher chargeback protection.

Valid values:

Value Description
05 Successfully authenticated (VbV & MCSC). Must set CAVV field.
06 Authentication attempted (VbV & MCSC). Must set CAVV field.
07 Non-Authenticated security transaction without SET certificate, such as channel-encrypted.
08 Non-secure transactions.
20 Payment Token data present (Amex only).

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.

EMVOnlineKSN:   Clear-text Key Sequence Number for EMV Online PIN transactions.

This field is used along with EMVOnlinePIN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. This value must be 16 characters in length.

EMVOnlinePIN:   DUKPT DES encrypted PIN block for EMV Online PIN transactions.

This field is used along with EMVOnlineKSN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. This value must be 16 characters in length.

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.

MessageReasonCode:   Message Reason Code.

Use this 4-character config to identify the type of Merchant Initiated Transaction for Visa. Valid values are:

Value Description
3900 Incremental Authorization
3901 Resubmission
3902 Delayed Charges
3903 Reauthorization
3904 No Show

Note: This config is used in Visa card transactions only.

MITTransactionId:   Transaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale or AuthOnly transaction.

Use this 15-character config when sending a subsequent Merchant Initiated sale or auth_only transaction. It should be set with the response_transaction_id from the original (first) authorization response. Note: This config is used in Visa or Discover card transactions only.

POSEntryModeCOF:   POS Entry Mode Credential on File.

This configuration setting is used to indicate that POS Entry Mode Credential is on file. The valid value is:

Value Description
Y Credential on file
Note: If no amount is due at the time credentials are stored, you must submit an Account Verification authorization (zero-amount transaction) using the auth_only method.
POSEnvironmentCode:   POS Environment Code.

Use this 1-character config to indicate that a transaction is a Recurring, Installment, or Unscheduled COF payment, or when placing cardholder Credentials On File for the first time.

Visa card valid values are:

Value Description
C Credential on file. Used for Unscheduled COF transactions or when the cardholder's credentials are saved for the first time.
I Installment. Required for initial and all subsequent Installment payment transactions
R Recurring. Required for initial and all subsequent Recurring transactions.
Discover card valid values are:
Value Description
R Recurring transaction
A Re-Authorization Full Amount
P Partial/Split transaction
Note: Discover valid values are for Merchant Initiated Transactions only.

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.

RequestTransactionId:   Indicates the Transaction Identifier is requested.

Setting this config to 'True' indicates the Transaction Identifier (TXID) is requested.

The default value is False.

ResponseBalanceAmount1:   Credit Prepaid Available Balance #1.

Current available balance in the merchant's currency. Signed numeric amount with an implied decimal point. For instance, a positive $10.00 balance will be represented as "+000000001000". This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseBalanceAmount2:   Credit Prepaid Available Balance $2.

Current available balance in the customer's currency. Signed numeric amount with an implied decimal point. For instance, a positive $10.00 balance will be represented as "+000000001000". This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseBalanceCurrency1:   Currency code for ResponseBalanceAmount1.

If present, this indicates the currency code for the ResponseBalanceAmount1. This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseBalanceCurrency2:   Currency code for ResponseBalanceAmount2.

If present, this indicates the currency code for the ResponseBalanceAmount2. This setting is only valid for Credit Prepaid transactions, and is read-only.

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.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and proxy_auto_detect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when ssl_provider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

PTechHotel Errors

PTechHotel Errors

432   Invalid Index
501   Property length is invalid
504   Luhn digit check failed.
505   Card date invalid.
506   Card expired.
511   Property is set with invalid data.
517   Response length mismatch.
518   LRC check failed.
519   Corrupt response.
545   Error found in token data
546   Missing property for current method call.
593   Verification of post data failed: Invalid mix of properties for the current method call.
594   You cannot manually settle a transaction made with settlement_mode set to Host Capture.

Paymentech Server Errors:

The following is a list of error codes which may be returned by the Paymentech server. In the case of a server-side error condition, the response_code property will contain "E", the error code will be contained in the response_approval_code property, and the description in response_text

Paymentech Issuer Errors

response_approval_coderesponse_textDescription
200Auth DeclinedCardholder's bank did not approve transaction.
201Call Voice OperAuthorizer needs more information for approval.
202Hold - CallCard issuer does not want that card used. Call for further instructions.
203Call Voice OperAuthorizer didn't respond within allotted time.
204Invalid Card NoAccount #/mag stripe is invalid.
205Invalid Exp. DateExpiration date is either incorrect format or prior to today.
206Invalid ICA NoInvalid International Control Account number.
207Invalid ABA NoInvalid American Banking Association number.
208Invalid PIN NoThe Personal ID Number for a debit transaction is incorrect.
209Invalid Bank MID The Bank Merchant ID is incorrect.
210Invalid Term NoThe merchant ID is not valid or active.
211Invalid AmountAmount is either: equal to 0, has no decimal, has decimal in wrong place, or has multiple decimals.
213Invalid Tran FmtThe transaction format isn't valid, typically invalid SIC code
214Call Voice OperAuthorization center cannot be reached.
215Lost/Stolen CardCard has been reported lost or stolen.
216Invalid PINPersonal ID code is incorrect.
217Over Credit FlrAmount requested exceeds credit limit.
218Request DeniedTransaction is not valid for this authorizer.
220Not Online to XXFatal communications error.
221Auth Down-RetryDebit authorizer temporarily unavailable.
222Auth DeclinedVehicle not found in positive file.
223Invalid Pin NoDriver # not found in positive file.
224Auth DeclinedCard is on private label negative file.
225Card Not AllowedMerchant does not accept this card.
226PL Setup ReqdMerchant not set up for Private Label.
227BIN Not AllowedMerchant cannot accept this Private Label BIN range.
228Card Not AllowedMerchant cannot accept this card.
229Inv Merc Rstrct CodeRestriction code field contains invalid data.
230Prod RestrictedMerchant attempted a product code not permitted by this merchant.
231Prod Not On FileMerchant attempted a product code that does not exist on host.
232Auth DeclinedInvalid card type for Prior Auth sale.
233Auth DeclinedTerminal Type not supported.
234Auth DeclinedT&E card used for Sale when merchant only allows Auth Only.
235*Request Denied*Prior Auth selected with no Auth code provided.
238Invalid Driver NumberThe Driver Number entered is invalid.
247PIN Not SelectedEBT recipient has not selected a PIN for this card.
248Unmatch Vch InfoVoucher submitted does not match one previously issued.
248CVC2/CID ERRORCVC2 or CID entered was not valid for the card number.
249Tran Not DefinedThis type of transaction is not allowed for this type of card.
257Block Act Not AlwdThe merchant.is not allowed to process Stored Value Block Activations
258Incorrect Act AmtThe activation amount requested does not match the predenominated amount for the card.
292Auth Down - RetryAuthorizer is not responding.
293Auth Busy - RetryAuthorizer not available at this time.
294Auth Busy - RetryAuthorizer not available at this time.
297Auth Error - RetryAuthorizer not available at this time.
298Err - Pls RetryDebit authorizer experienced an error.
299Err - Pls RetryDebit authorizer experienced an error.

Paymentech Format Errors

response_approval_coderesponse_textDescription
300Invalid Term IDThe length of the merchant ID is incorrect or contains invalid data.
301Invalid FunctionTran code is incorrect or wrong length.
302Invalid CardMag stripe contains invalid data or account # is greater than 19 digits
303Invalid Exp. DateCard has expired, month was not 01-12 or year was not 00-99.
304Invalid Action CodeAction code is longer than 1 digit.
305Amt Entry ErrorAmount less than .01 or greater than 99999.99 or contained non- numeric data.
306Invalid PINIncorrect PIN block length.
307Invalid Card Invalid card type or account number.
308Auth # Not EnteredAuth code was not entered on a Prior Auth, Incremental or Rev.
309Invalid Down Pay IndInsurance down payment indicator is invalid.
310Policy # Wrong LenInsurance policy number is incorrect length.
311Invalid Ind CodeIndustry type must be RE or DM.
312Invalid FunctionTran code is invalid or contains alpha data.
313Entry Mode InvalidPOS Entry mode is less than 01 or greater than 04.
314Invalid Industry DataThe Industry Specific field contains invalid data.
315Inv Fleet DataThe Fleet Card field contains invalid data.
316Invalid Sys InfoThe System Information field contains invalid data.
317Invalid FormatPayment Service indicator or Transaction ID is invalid.
318Inv Transaction ClassTransaction class not "F" for financial transaction.
319Inv PIN CapabilityPin capability code field contains invalid data.
320Inv/Missing Retr RefRetrieval Reference # is missing or contains alpha data.
321Inv MSDIMarket Specific Data field contains invalid data.
322Invalid DurationMarket specific data field Duration is 00, blank or missing.
323Inv Pref Cust IndPreferred Customer indicator contains invalid data.
324Inv MO/TO NumberMail/Telephone Order number is invalid (invoice_number must have a value).
325Inv Sale/Chg Des/FolioHotel Sale Code, Charge Descriptor or Folio contains invalid data.
326Inv Mult Clr Seq NoMultiple Clearing sequence number is invalid.
327Inv Purch Card DataPurchasing card field contains invalid data.
328Inv Input/Use VRUInsurance transaction not from VRU.
329Invalid EC Data 329Invalid Electronic Commerce Data.
330INV Function or Multiple FS or Unknown TKNIndicates system problem, notify Paymentech Network Services or Multiple field separators received without required data or A token of unknown definition was received
331INV TKN ValueInvalid token value was received.
332CVD Data ErrorError with the cardholder verification data received; invalid value or not allowable for this card for this transaction.
333TKN Data ErrorIndicates system problem, notify Paymentech Network Services.
359Invalid Sequence NumberThe sequence_number must be a number between 0 and 2400.

Paymentech Host / Setup Errors

response_approval_coderesponse_textDescription
400Invalid Term IDMerchant ID not found in merchant file.
401Invalid Term IDMerchant ID not found in terminal file.
402Term Not ActiveActive flag for merchant set to "N".
403Invalid Act CodeMerchant not set up for cash advance function.
404Void Not AllowedThe transaction requested for voiding is not an EFT transaction.
405Ref Num Not FoundTransaction requested for reversal not found.
406Proc Error 7The host can't clear all transaction records for the requested Batch Release.
407Too Many BatchesThere are 999 open batches for this merchant.
408Release BatchCurrent batch has 999 records. Release batch before continuing.
409Invalid FunctionDebit transaction requested but debit flag is set to "N".
410Invalid Term IDThe Terminal ID portion of the merchant ID is incorrect.
411Invalid Term IDThe maximum retries for this merchant have been exceeded.
412Proc Error 13Unable to read reference number file.
413Proc Error 14413
414Proc Error 15414
415Invalid Function 415
416Invalid FunctionMerchant is Authorization Only and a debit record was sent.
417Invalid FunctionPrivate label flag is "N" but a private label account number was sent.
418Please Try AgainIncorrect debit working key.
419Invalid Function Manually entered transactions are not allowed for this terminal ID.
420Amount Too LargeMaximum sale amount exceeded.
421Amount Too LargeMaximum return amount exceeded.
422Invalid Term IDHost couldn't read terminal file within specified time.
423Proc Error 24Host couldn't read reference number file within specified time.
424Invalid Term IDTransaction open flag has been set to "Y" within prior 3 minutes.
425Invalid FunctionCash management not allowed for this merchant ID.
426Rev Not AllowedHost found no batch number matching the one sent.
427Rev Not AllowedHost found no transactions meeting the specifications sent.
428Dscv Not AllowedMerchant not set up for Discover transactions.
429Rev Not AllowedThe batch containing the transaction to void has been released.
430Dscv Not AllowedMerchant not set up for Discover.
431DC Not AllowedMerchant not set up for Diners Club.
432CB Not AllowedMerchant not set up for Carte Blanche.
433Invalid KeyNo AMEX subscriber number, process control ID or product code set up
434Invalid KeyFuture use.
435Failed-Plz CallDebit transaction being sent to an authorizer not set up on host file.
436Failed-Plz CallDebit security key does not exist on the security management file.
437Failed-Plz CallFailure occurred during encryption/decryption of PIN.
438Failed-Plz CallError occurred while generating a debit working key.
439Failed-Plz CallThe DB (debit) sponsor institution on the merchant file is not set up on sponsor file.
440Failed-Plz CallThe network set up on the sponsoring bank file for this institution is not set up on the host's network file.
441Failed-Plz CallThe host is unable to communicate with decryption device.
442JCB Not AllowedJCB CD flag on merchant record not set up for JCB transactions.
443JCB Not AllowedJCB subscriber number not set up for JCB transactions.
444Bank Not On FileDebit BIN not set up for this merchant in routing table.
445No Sponsor InstNo valid sponsorship was found on Merchant record.
446Failed Plz CallFuture use.
447WX Not AllowedMerchant not set up to accept WEX.
448Amount Too LargeAmount exceeds maximum limit.
449Reenter OdometerOdometer was 000000 or contained non-numeric data.
450Duplicate TranNo ACK reversal was followed by a duplicate request
451Tran Not AllowedRequested transaction type is not allowed for this card/merchant.
452Bat Already RelsBatch has already been released.
453Invalid Rtng IndInvalid Routing Indicator field.
454AX Not AllowedAMEX not allowed.
999Invalid MerchantMerchant number not on file.

Paymentech Debit / EBT Specific Errors

response_approval_coderesponse_textDescription
602Call Voice OpAuth center cannot be reached.
692Auth Down-Retry Debit authorizer temporarily unavailable.
693Auth Busy-Retry Queue for debit authorizer too long.
694Auth Busy-Retry Debit authorizer not responding in time.

Paymentech Batch Management Errors (use the ErrorCode configuration setting to retrieve this information from the PTechHostSettle class.

ErrorCoderesponse_textDescription
105Invalid Term IDMerchant ID on a Batch Inquiry or Release is incorrect.
106Term Not ActiveActive flag for the merchant ID is set to N.
107No TransactionsA Batch Inquiry or Release was requested but no open batch exists.
108Bat Already RelsA second batch release was attempted.
109Batch Not FoundRequested batch does not exist.

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in url
153   Specified url_scheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100   You cannot change the remote_port at this time. A connection is in progress.
101   You cannot change the remote_host (Server) at this time. A connection is in progress.
102   The remote_host address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the local_port at this time. A connection is in progress.
107   You cannot change the local_host at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   remote_port cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).