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_type | Type of credit card being used in this transaction. |
card_cvv_data | Three digit security code on back of card (optional). |
card_cvv_presence | Indicates the presence of the card verification value. |
card_entry_data_source | This property contains a 1-character code identifying the source of the customer data. |
card_exp_month | Expiration month of the credit card specified in Number . |
card_exp_year | Expiration year of the credit card specified in Number . |
card_is_encrypted | Determines whether data set to the Number or MagneticStripe properties is validated. |
card_magnetic_stripe | Track data read off of the card's magnetic stripe. |
card_number | Customer's credit card number for the transaction. |
client_number | Merchant configuration property, assigned by Paymentech. |
customer_address | The customer's billing address. |
customer_zip | Customer's zip code (or postal code if outside of the USA). |
hotel_arrival_date | Date the customer checked in, or the expected arrival date when authorizing a reservation. |
hotel_charge_descriptor | Provides additional information about what this transaction was used for at the hotel. |
hotel_departure_date | Date the customer checked out, or the expected check-out date when authorizing a reservation. |
hotel_duration | The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation. |
hotel_extra_charge_amount | Total amount of extra charges incurred by the customer. |
hotel_extra_charges_code | List of extra charges added to the cost of lodging. |
hotel_preferred_customer | Set this property to True to process a hotel transaction as card-not-present. |
hotel_sale_code | Provides additional details about the type of this transaction. |
invoice_number | Hotel Folio Number. |
merchant_number | A unique number used to identify the merchant, assigned by Paymentech. |
password | Password for authentication with the NetConnect Server . |
pin_capability | Indicates if the terminal device supports a PIN pad. |
pos_retrieval_number | Merchant-generated reference number, used for reversals. |
proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
proxy_password | This property contains a password if authentication is to be used for the proxy. |
proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | This property contains a username if authentication is to be used for the proxy. |
response_approval_code | Contains an authorization code when a transaction has been approved, or an error code. |
response_authorized_amount | Used for partial authorizations. |
response_auth_source | Indicates the source of the authorization code stored in ApprovalCode . |
response_avs_result | Contains the Address Verification System result code. |
response_batch_number | Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTECHHOSTSETTLE class, or after a SendSettlement sent using the PTECHMANUALSETTLE class. |
response_card_level | This property contains a two-character code created by Visa during the authorization process. |
response_card_type | Type of the credit card. |
response_code | Indicates the status of the authorization request. |
response_cvv_result | Contains the returned CVV result code if it was requested. |
response_debit_surcharge | Additional fee charged for debit transactions. |
response_debit_trace | This property is returned in the response to a debit card transaction. |
response_network_id | Authorizing network Identifier which indicates which network approved this transaction. |
response_retrieval_number | Reference number returned from the Paymentech host. |
response_sequence_number | SequenceNumber echoed from the authorization. |
response_text | Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result. |
response_transaction_id | This 15-character property contains the Transaction Identifier assigned by the card issuer or network. |
sequence_number | Sequence number of the transaction. |
server | The URL for the PaymenTech NetConnect server. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_cert_store_type | This is the type of certificate store for this certificate. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_provider | This specifies the SSL/TLS implementation to use. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
terminal_number | Terminal number assigned by Paymentech. |
timeout | A timeout for the class. |
transaction_amount | Purchase amount for an authorization. |
user_id | UserId for authentication with the NetConnect Server . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
auth_only | Sends an AuthOnly transaction to the host. |
config | Sets or retrieves a configuration setting. |
credit | Credits a cardholder's account or obtains a Return Authorization. |
get_detail_aggregate | Returns an aggregate containing details of this transaction, which is then used for manual settlement. |
interrupt | Interrupt the current method. |
reset | Clears all properties to their default values. |
sale | Sends a Sale transaction to the host. |
visa_incremental | Increases the TransactionAmount of a previously-submitted transaction. |
visa_reversal | Decreases 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_in | Fired when receiving a data packet from the transaction server. |
on_data_packet_out | Fired when sending a data packet to the transaction server. |
on_error | Information about errors during data delivery. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
CAVV | AuthenticationCAVV data from a ThreeDSecure authentication. |
CustomerDefinedData | Additional transaction identification data. |
DeviceID | Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from. |
DeviceType | Indicates the Remote Payment Type for MasterCard Contactless Authorizations. |
DiscoverAuthAmount | Returns the amount authorized for the transaction. |
DiscoverPINCapabability | Indicates if the POS is capable of supporting a PIN. |
DiscoverPOSEntryMode | Returns the method by which the primary account number was entered at the POS. |
DiscoverProcessingCode | Returns the type of Authorization request that was submitted to Discover. |
DiscoverSystemTraceAuditNumber | Returns the value assigned by the host/merhant to assist in identifying a specific transaction. |
DiscoverTrackDataCondition | Returns condition of the track data. |
ECommerceIndicator | Used to specify the indicator describing the type of internet transaction. |
EMVData | The EMV data returned from a Pin Pad after reading an EMV card. |
EMVEntryDataSource | The EMV Data Entry Source (DES). |
EMVOnlineKSN | Clear-text Key Sequence Number for EMV Online PIN transactions. |
EMVOnlinePIN | DUKPT DES encrypted PIN block for EMV Online PIN transactions. |
HardwareSerialNum | Hardware Serial Number. |
HostProcessingTypes | Host Processing Platform. |
MessageReasonCode | Message Reason Code. |
MITTransactionId | Transaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale or AuthOnly transaction. |
POSEntryModeCOF | POS Entry Mode Credential on File. |
POSEnvironmentCode | POS Environment Code. |
RequestBalanceInfo | Specifies whether to request balance information. |
RequestTransactionId | Indicates the Transaction Identifier is requested. |
ResponseBalanceAmount1 | Credit Prepaid Available Balance #1. |
ResponseBalanceAmount2 | Credit Prepaid Available Balance $2. |
ResponseBalanceCurrency1 | Currency code for ResponseBalanceAmount1. |
ResponseBalanceCurrency2 | Currency code for ResponseBalanceAmount2. |
ResponseEMVCardAuthCode | The ChaseNet and Visa card authentication results code. |
ResponseEMVData | The response EMV data. |
ResponseEMVDownloadIndicator | Whether EMV parameters should be updated. |
ResponsePOSRetrievalNumber | POS Retrieval Number sent in the request, echoed back in the response. |
SettlementMode | Indicates whether the class uses Paymentech's Host Capture or Terminal Capture system. |
SoftwareID | Software Identifier. |
SystemInformation | System Information field for Batch Inquiry and Release transactions. |
VendorID | Hardware/Vendor Identifier. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
card_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. |
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:
Code | Description |
1 | STIP (Stand-In Processing): time-out response. |
2 | STIP: amount below issuer limit. |
3 | STIP: issuer in Suppress Inquiry mode. |
4 | STIP: issuer unavailable. |
5 | Issuer generated response. |
6 | Off-line approval: POS device generated. |
7 | Acquirer approval: Base I unavailable. |
8 | Acquirer approval of a referral. |
9 | Use for non-authorized transactions; such as credit card credits. |
D | Referral: authorization code manually keyed. |
E | Off-line approval: authorization code manually keyed. |
F | CAFIS Interface Off-Line Post-Auth.* |
G | Issuer Approval: Post-Auth.* |
T | Advice of a Telcode File change initiated by the VisaPhone Issuer Direct Service. |
This property is read-only.
response_avs_result Property
Contains the Address Verification System result code.
Syntax
def get_response_avs_result() -> str: ...
response_avs_result = property(get_response_avs_result, None)
Default Value
""
Remarks
Contains the Address Verification System result code. This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below. Please see the response_code property for a more detailed list of response_code and response_avs_result code combinations.
Valid AVS Codes:
Code | Description |
0 | Address verification was not requested. |
A | customer_address matches, customer_zip does not. |
E | AVS error / Ineligible (not a mail/phone order). |
G | Ver Unavailable - Non-US Issuer does not participate. |
I | Ver Unavailable - Address information not verified for international transaction. |
M | Exact Match - customer_address match for international transaction. |
N | No match on customer_address or customer_zip. |
R | Retry - Issuer system unavailable. |
S | Service not supported by issuer. |
U | Address information is unavailable. |
W | Nine digit customer_zip matches, customer_address does not. |
X | Exact AVS match, nine digit customer_zip. |
Y | Exact AVS match, five digit customer_zip. |
Z | Five digit customer_zip matches, customer_address does not. |
If supporting international transactions, six additional International Address Verification Service (IAVS) codes are introduced:
B | Street address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code). |
C | Street address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code). |
D | Street addresses and postal codes match for international transaction. |
I | Address information not verified for international transaction. |
M | Street addresses and postal codes match for international transaction. |
P | Postal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code). |
This property is read-only.
response_batch_number Property
Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTECHHOSTSETTLE class, or after a SendSettlement sent using the PTECHMANUALSETTLE class.
Syntax
def get_response_batch_number() -> str: ...
response_batch_number = property(get_response_batch_number, None)
Default Value
""
Remarks
Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.
This property is read-only.
response_card_level Property
This property contains a two-character code created by Visa during the authorization process.
Syntax
def get_response_card_level() -> str: ...
response_card_level = property(get_response_card_level, None)
Default Value
""
Remarks
This property contains a two-character code created by Visa during the authorization process.
The current list of possible return values can be found below: Visa Card Level Results Code:
Code | Meaning |
Spaces | Not applicable |
A^ | Visa Traditional |
AX* | American Express |
B^ | Visa Traditional Rewards |
C^ | Visa Signature |
D^ | Visa Infinite |
DI* | Discover |
E^ | Reserved |
F^ | Reserved |
G^ | Visa Business Card |
G1 | Visa Signature Business |
G2 | Visa Business Check Card |
H^ | Classic Visa Check Card |
I^ | Visa Commerce |
J^ | Reserved |
J1 | Visa General Prepaid |
J2 | Visa Prepaid Gift Card |
J3 | Visa Prepaid Healthcare |
J4 | Visa Prepaid Commercial |
K^ | Visa Corporate Card |
K1 | Visa GSA Corporate T&E |
L^ | Reserved |
M^* | MasterCard/EuroCard and Diners |
N^ - P^ | Reserved |
Q^ | Private Label |
Q1 | Private Label Prepaid |
R^ | Proprietary Card |
S^ | Visa Purchasing Card |
S1 | Visa Fleet |
S2 | Visa GSA Purchasing |
S3 | Visa GSA Purchasing with Fleet |
T^ | Reserved/Interlink |
U^ | Visa TravelMoney |
W^ - Z^ | Reserved |
0^ - 9^ | Reserved |
^ | Space |
* | Valid only when the transaction was re-routed to Visa for authorization. |
This property is read-only.
response_card_type Property
Type of the credit card.
Syntax
def get_response_card_type() -> str: ...
response_card_type = property(get_response_card_type, None)
Default Value
""
Remarks
Type of the credit card.
Paymentech determines the type of credit card used for each authorization, and returns that value to the merchant in the response. The following is a list of card mnemonics and their meanings.
VI | Visa |
MC | MasterCard |
AE | American Exp. |
DS | Discover |
JC | JCB |
DB | Debit |
EB | EBT |
SV | Stored Value |
CK | Check Authorization |
IG | In Good Taste |
PL | Retail PL |
CC | Club Card |
SC | Smarte Carte |
TH | TCH Light Fleet |
TS | TCRS Consumer Card |
IR | Irving Oil PL |
RA | RAI |
DY | Disney Rewards |
SR | Sears PL |
BE | Best |
EN | Enmark |
GC | FleetCor / GasCard |
VY | Voyager |
FO | Fleet One |
SH | Shell |
GT | Gate |
WX | WEX |
MM | MotoMart |
?? | Included in Batch Totals by Card Type responses when the host has summarized more than 14 card types within the batch (includes all other card types in the batch over 14). |
99 | Supported in Enhanced Batch Inquiry requests when "all" details or totals are being requested. |
This property is read-only.
response_code Property
Indicates the status of the authorization request.
Syntax
def get_response_code() -> str: ...
response_code = property(get_response_code, None)
Default Value
""
Remarks
Indicates the status of the authorization request. This is the property used to determine whether a transaction has been approved or not. Valid values for this property are:
A | Transaction is Approved. |
E | Error condition or card declined (see the Error section of the help file for more information). |
See the list of errors for this class for more information.
This property is read-only.
response_cvv_result Property
Contains the returned CVV result code if it was requested.
Syntax
def get_response_cvv_result() -> str: ...
response_cvv_result = property(get_response_cvv_result, None)
Default Value
""
Remarks
Contains the returned CVV result code if it was requested. If a CVV value was present in the card_cvv_data property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CardCVVData property is filled. Instead, an AMEX transaction will be declined if the CVV value does not match, with an response_text indicating such. The following is a list of current result codes:
M | CVV2 match. |
N | CVV2 no match. |
P | Not processed. |
S | Merchant has indicated that CVV2 is not present on card. |
U | Issuer not certified and/or has not provided Visa encryption keys. |
This property is read-only.
response_debit_surcharge Property
Additional fee charged for debit transactions.
Syntax
def get_response_debit_surcharge() -> str: ...
response_debit_surcharge = property(get_response_debit_surcharge, None)
Default Value
""
Remarks
Additional fee charged for debit transactions. This property contains the fee, if any, charged by the host for debit card transactions. The Surcharge Fee field is present only if greater than 0.00. If there was no surcharge for this transaction, the response_debit_surcharge property will remain empty. If present, the Surcharge amount must print on receipt and be labeled as "TERMINAL FEE".
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.
00 | Not electronically authorized |
31 | Chase Paymentech Stored Value |
01 | VisaNet |
65 | Comdata/SVS Stored Value |
02 | MasterCard BankNet |
34 | Bank of Nova Scotia |
03 | Maestro Direct |
35 | Royal Bank of Canada - V |
04 | Club Card Private Label |
36 | Royal Bank of Canada - T |
05 | MAC Direct |
37 | Royal Bank of Canada - M |
06 | American Express Direct |
38 | The Toronto-Dominion Bank - 1 |
11 | WEX (Wright Express) |
39 | The Toronto-Dominion Bank - 3 |
12 | Novus (Discover) |
40 | National Bank of Canada |
15 | Sears Private Label |
43 | d'economie Desjardins du Quebec |
16 | Fleet One |
44 | Credit Union Central of Canada |
17 | Shell |
45 | CGI Credit Union Central of Canada - 2 |
19 | TCH |
46 | CGI |
20 | Pulse Direct |
48 | CU Connect |
21 | Interlink Direct |
49 | CIBC - 5 |
22 | MotoMart |
51 | Shazam Direct |
23 | Private Label - PL1 |
53 | AFFN Direct |
25 | NYCE Direct |
54 | CIBC - 6 |
28 | FleetCor / GasCard Authorizer |
56 | CU Central of British Columbia |
29 | MPS Gateway - Accell, AFFN, Alaska Option, CU24, CU24M, Explore, Honor, Interlink MPS, Jeannie, MAC-MPS, Maestro, Moneystation, MPS EBT Gateway, NYCE, PULSE, Shazam, Tempo |
64 | Maestro Canada |
30 | STAR Direct |
69 | ACCEL Direct |
33 | Bank of Montreal |
73 | ETC Scan Check Authorizer |
This property is read-only.
response_retrieval_number Property
Reference number returned from the Paymentech host.
Syntax
def get_response_retrieval_number() -> str: ...
response_retrieval_number = property(get_response_retrieval_number, None)
Default Value
""
Remarks
Reference number returned from the Paymentech host. This is the reference number of the transaction as assigned by the Paymentech host. This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the void_transaction method.
If the SettlementMode is set to manual this property will contain the POSRetrievalNumber submitted in the authorization. If no POSRetrievalNumber was sent, this property will contain all zeros, and you will not have a reference number for the transaction.
If the SettlementMode is set to host settle, this property will always contain the Paymentech-generated retrieval number returned by the transaction server, regardless of the value contained in the POSRetrievalNumber property.
In all cases, the response_retrieval_number will contain the number used to reference the transaction when issuing voids or reversals.
This property is read-only.
response_sequence_number Property
SequenceNumber echoed from the authorization.
Syntax
def get_response_sequence_number() -> str: ...
response_sequence_number = property(get_response_sequence_number, None)
Default Value
""
Remarks
sequence_number echoed from the authorization. After any transaction this property will contain the same value sent in the sequence_number property.
This property is read-only.
response_text Property
Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result.
Syntax
def get_response_text() -> str: ...
response_text = property(get_response_text, None)
Default Value
""
Remarks
Approval/Decline/Error text message information This field contains a response or display text message, and is used by the terminal to display the authorization result. This property will contain human-readable text indicating whether the transaction was approved or declined, or will contain a description of the error. The actual error code will be returned in the response_approval_code property. The response_text property is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the response_code property to determine this.
See the list of errors for this class for more information.
This property is read-only.
response_transaction_id Property
This 15-character property contains the Transaction Identifier assigned by the card issuer or network.
Syntax
def get_response_transaction_id() -> str: ...
response_transaction_id = property(get_response_transaction_id, None)
Default Value
""
Remarks
This 15-character property contains the Transaction Identifier assigned by the card issuer or network. Transaction Identifier is used to link subsequent MIT transactions to an original CIT transaction.
Note: Merchants are responsible for retaining the response TransactionId from the original transaction and submitting the TransactionId in subsequent MIT transactions.
This property is read-only.
sequence_number Property
Sequence number of the transaction.
Syntax
def get_sequence_number() -> int: ... def set_sequence_number(value: int) -> None: ...
sequence_number = property(get_sequence_number, set_sequence_number)
Default Value
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
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:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_provider Property
This specifies the SSL/TLS implementation to use.
Syntax
def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
Default Value
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. |
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
class.Config("CAVV=" + ThreeDSecure.AuthenticationCAVV);
Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.
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 |
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). |
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. |
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) |
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.
Value | Description |
Y | Credential on file |
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. |
Value | Description |
R | Recurring transaction |
A | Re-Authorization Full Amount |
P | Partial/Split transaction |
The default value is False.
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.
Default value is "010C".
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
Default value is "0076".
HTTP Config Settings
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.
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.
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]".
The default value is False.
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
- "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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
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).
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.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect 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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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.
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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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.
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.
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.
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".
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.
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.
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
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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.
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.
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.
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
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.
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.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (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.
This setting is only applicable when ssl_provider is set to Internal.
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.
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.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
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-----
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.
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)
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"
- "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 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
Note: This option is not valid for UDP ports.
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.
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
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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.
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.
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. |
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_code | response_text | Description |
200 | Auth Declined | Cardholder's bank did not approve transaction. |
201 | Call Voice Oper | Authorizer needs more information for approval. |
202 | Hold - Call | Card issuer does not want that card used. Call for further instructions. |
203 | Call Voice Oper | Authorizer didn't respond within allotted time. |
204 | Invalid Card No | Account #/mag stripe is invalid. |
205 | Invalid Exp. Date | Expiration date is either incorrect format or prior to today. |
206 | Invalid ICA No | Invalid International Control Account number. |
207 | Invalid ABA No | Invalid American Banking Association number. |
208 | Invalid PIN No | The Personal ID Number for a debit transaction is incorrect. |
209 | Invalid Bank MID | The Bank Merchant ID is incorrect. |
210 | Invalid Term No | The merchant ID is not valid or active. |
211 | Invalid Amount | Amount is either: equal to 0, has no decimal, has decimal in wrong place, or has multiple decimals. |
213 | Invalid Tran Fmt | The transaction format isn't valid, typically invalid SIC code |
214 | Call Voice Oper | Authorization center cannot be reached. |
215 | Lost/Stolen Card | Card has been reported lost or stolen. |
216 | Invalid PIN | Personal ID code is incorrect. |
217 | Over Credit Flr | Amount requested exceeds credit limit. |
218 | Request Denied | Transaction is not valid for this authorizer. |
220 | Not Online to XX | Fatal communications error. |
221 | Auth Down-Retry | Debit authorizer temporarily unavailable. |
222 | Auth Declined | Vehicle not found in positive file. |
223 | Invalid Pin No | Driver # not found in positive file. |
224 | Auth Declined | Card is on private label negative file. |
225 | Card Not Allowed | Merchant does not accept this card. |
226 | PL Setup Reqd | Merchant not set up for Private Label. |
227 | BIN Not Allowed | Merchant cannot accept this Private Label BIN range. |
228 | Card Not Allowed | Merchant cannot accept this card. |
229 | Inv Merc Rstrct Code | Restriction code field contains invalid data. |
230 | Prod Restricted | Merchant attempted a product code not permitted by this merchant. |
231 | Prod Not On File | Merchant attempted a product code that does not exist on host. |
232 | Auth Declined | Invalid card type for Prior Auth sale. |
233 | Auth Declined | Terminal Type not supported. |
234 | Auth Declined | T&E card used for Sale when merchant only allows Auth Only. |
235 | *Request Denied* | Prior Auth selected with no Auth code provided. |
238 | Invalid Driver Number | The Driver Number entered is invalid. |
247 | PIN Not Selected | EBT recipient has not selected a PIN for this card. |
248 | Unmatch Vch Info | Voucher submitted does not match one previously issued. |
248 | CVC2/CID ERROR | CVC2 or CID entered was not valid for the card number. |
249 | Tran Not Defined | This type of transaction is not allowed for this type of card. |
257 | Block Act Not Alwd | The merchant.is not allowed to process Stored Value Block Activations |
258 | Incorrect Act Amt | The activation amount requested does not match the predenominated amount for the card. |
292 | Auth Down - Retry | Authorizer is not responding. |
293 | Auth Busy - Retry | Authorizer not available at this time. |
294 | Auth Busy - Retry | Authorizer not available at this time. |
297 | Auth Error - Retry | Authorizer not available at this time. |
298 | Err - Pls Retry | Debit authorizer experienced an error. |
299 | Err - Pls Retry | Debit authorizer experienced an error. |
Paymentech Format Errors
response_approval_code | response_text | Description |
300 | Invalid Term ID | The length of the merchant ID is incorrect or contains invalid data. |
301 | Invalid Function | Tran code is incorrect or wrong length. |
302 | Invalid Card | Mag stripe contains invalid data or account # is greater than 19 digits |
303 | Invalid Exp. Date | Card has expired, month was not 01-12 or year was not 00-99. |
304 | Invalid Action Code | Action code is longer than 1 digit. |
305 | Amt Entry Error | Amount less than .01 or greater than 99999.99 or contained non- numeric data. |
306 | Invalid PIN | Incorrect PIN block length. |
307 | Invalid Card | Invalid card type or account number. |
308 | Auth # Not Entered | Auth code was not entered on a Prior Auth, Incremental or Rev. |
309 | Invalid Down Pay Ind | Insurance down payment indicator is invalid. |
310 | Policy # Wrong Len | Insurance policy number is incorrect length. |
311 | Invalid Ind Code | Industry type must be RE or DM. |
312 | Invalid Function | Tran code is invalid or contains alpha data. |
313 | Entry Mode Invalid | POS Entry mode is less than 01 or greater than 04. |
314 | Invalid Industry Data | The Industry Specific field contains invalid data. |
315 | Inv Fleet Data | The Fleet Card field contains invalid data. |
316 | Invalid Sys Info | The System Information field contains invalid data. |
317 | Invalid Format | Payment Service indicator or Transaction ID is invalid. |
318 | Inv Transaction Class | Transaction class not "F" for financial transaction. |
319 | Inv PIN Capability | Pin capability code field contains invalid data. |
320 | Inv/Missing Retr Ref | Retrieval Reference # is missing or contains alpha data. |
321 | Inv MSDI | Market Specific Data field contains invalid data. |
322 | Invalid Duration | Market specific data field Duration is 00, blank or missing. |
323 | Inv Pref Cust Ind | Preferred Customer indicator contains invalid data. |
324 | Inv MO/TO Number | Mail/Telephone Order number is invalid (invoice_number must have a value). |
325 | Inv Sale/Chg Des/Folio | Hotel Sale Code, Charge Descriptor or Folio contains invalid data. |
326 | Inv Mult Clr Seq No | Multiple Clearing sequence number is invalid. |
327 | Inv Purch Card Data | Purchasing card field contains invalid data. |
328 | Inv Input/Use VRU | Insurance transaction not from VRU. |
329 | Invalid EC Data 329 | Invalid Electronic Commerce Data. |
330 | INV Function or Multiple FS or Unknown TKN | Indicates system problem, notify Paymentech Network Services or Multiple field separators received without required data or A token of unknown definition was received |
331 | INV TKN Value | Invalid token value was received. |
332 | CVD Data Error | Error with the cardholder verification data received; invalid value or not allowable for this card for this transaction. |
333 | TKN Data Error | Indicates system problem, notify Paymentech Network Services. |
359 | Invalid Sequence Number | The sequence_number must be a number between 0 and 2400. |
Paymentech Host / Setup Errors
response_approval_code | response_text | Description |
400 | Invalid Term ID | Merchant ID not found in merchant file. |
401 | Invalid Term ID | Merchant ID not found in terminal file. |
402 | Term Not Active | Active flag for merchant set to "N". |
403 | Invalid Act Code | Merchant not set up for cash advance function. |
404 | Void Not Allowed | The transaction requested for voiding is not an EFT transaction. |
405 | Ref Num Not Found | Transaction requested for reversal not found. |
406 | Proc Error 7 | The host can't clear all transaction records for the requested Batch Release. |
407 | Too Many Batches | There are 999 open batches for this merchant. |
408 | Release Batch | Current batch has 999 records. Release batch before continuing. |
409 | Invalid Function | Debit transaction requested but debit flag is set to "N". |
410 | Invalid Term ID | The Terminal ID portion of the merchant ID is incorrect. |
411 | Invalid Term ID | The maximum retries for this merchant have been exceeded. |
412 | Proc Error 13 | Unable to read reference number file. |
413 | Proc Error 14 | 413 |
414 | Proc Error 15 | 414 |
415 | Invalid Function | 415 |
416 | Invalid Function | Merchant is Authorization Only and a debit record was sent. |
417 | Invalid Function | Private label flag is "N" but a private label account number was sent. |
418 | Please Try Again | Incorrect debit working key. |
419 | Invalid Function | Manually entered transactions are not allowed for this terminal ID. |
420 | Amount Too Large | Maximum sale amount exceeded. |
421 | Amount Too Large | Maximum return amount exceeded. |
422 | Invalid Term ID | Host couldn't read terminal file within specified time. |
423 | Proc Error 24 | Host couldn't read reference number file within specified time. |
424 | Invalid Term ID | Transaction open flag has been set to "Y" within prior 3 minutes. |
425 | Invalid Function | Cash management not allowed for this merchant ID. |
426 | Rev Not Allowed | Host found no batch number matching the one sent. |
427 | Rev Not Allowed | Host found no transactions meeting the specifications sent. |
428 | Dscv Not Allowed | Merchant not set up for Discover transactions. |
429 | Rev Not Allowed | The batch containing the transaction to void has been released. |
430 | Dscv Not Allowed | Merchant not set up for Discover. |
431 | DC Not Allowed | Merchant not set up for Diners Club. |
432 | CB Not Allowed | Merchant not set up for Carte Blanche. |
433 | Invalid Key | No AMEX subscriber number, process control ID or product code set up |
434 | Invalid Key | Future use. |
435 | Failed-Plz Call | Debit transaction being sent to an authorizer not set up on host file. |
436 | Failed-Plz Call | Debit security key does not exist on the security management file. |
437 | Failed-Plz Call | Failure occurred during encryption/decryption of PIN. |
438 | Failed-Plz Call | Error occurred while generating a debit working key. |
439 | Failed-Plz Call | The DB (debit) sponsor institution on the merchant file is not set up on sponsor file. |
440 | Failed-Plz Call | The network set up on the sponsoring bank file for this institution is not set up on the host's network file. |
441 | Failed-Plz Call | The host is unable to communicate with decryption device. |
442 | JCB Not Allowed | JCB CD flag on merchant record not set up for JCB transactions. |
443 | JCB Not Allowed | JCB subscriber number not set up for JCB transactions. |
444 | Bank Not On File | Debit BIN not set up for this merchant in routing table. |
445 | No Sponsor Inst | No valid sponsorship was found on Merchant record. |
446 | Failed Plz Call | Future use. |
447 | WX Not Allowed | Merchant not set up to accept WEX. |
448 | Amount Too Large | Amount exceeds maximum limit. |
449 | Reenter Odometer | Odometer was 000000 or contained non-numeric data. |
450 | Duplicate Tran | No ACK reversal was followed by a duplicate request |
451 | Tran Not Allowed | Requested transaction type is not allowed for this card/merchant. |
452 | Bat Already Rels | Batch has already been released. |
453 | Invalid Rtng Ind | Invalid Routing Indicator field. |
454 | AX Not Allowed | AMEX not allowed. |
999 | Invalid Merchant | Merchant number not on file. |
Paymentech Debit / EBT Specific Errors
response_approval_code | response_text | Description |
602 | Call Voice Op | Auth center cannot be reached. |
692 | Auth Down-Retry | Debit authorizer temporarily unavailable. |
693 | Auth Busy-Retry | Queue for debit authorizer too long. |
694 | Auth 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.
ErrorCode | response_text | Description |
105 | Invalid Term ID | Merchant ID on a Batch Inquiry or Release is incorrect. |
106 | Term Not Active | Active flag for the merchant ID is set to N. |
107 | No Transactions | A Batch Inquiry or Release was requested but no open batch exists. |
108 | Bat Already Rels | A second batch release was attempted. |
109 | Batch Not Found | Requested 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). |