PTechHealthCare Class

Properties   Methods   Events   Config Settings   Errors  

The PTECHHEALTHCARE class is designed to be a simple interface for those wishing to add Healthcare Auto- Substantiation (IIAS) support without redesigning their entire payment system. This class can be used for the Retail, Direct Marketing, and E-Commerce IndustryType s. It allows for simple, direct, secure communication to the Paymentech NetConnect (Tampa platform) 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.PTechHealthCare

Remarks

The PTechHealthCare class is designed to be a simple interface for those wishing to add healthcare support without re-designing their entire payment system. The same functionality is present in the PTechCharge class, along with much more detailed control over all aspects of a transaction. If you are building a payment system from scratch, you may use this class with any other classs in this package. Or you may use the PTechCharge class, which combines much of the functionality of the PTechRetail, PTechHealthCare, PTechECommerce, PTechDebit, and PTechHotel classs in one compact package.

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 add the healthcare-specific properties. At minimum, you should send the total_medical_amount. If total_medical_amount is left empty the class will send a regular (non-healthcare) transaction. In addition to total_medical_amount, you may also set the prescription_amount, clinic_amount, vision_amount, and/or dental_amount properties with the dollar amount of each within this transaction. The sum total of the prescription_amount, clinic_amount, vision_amount, and dental_amount properties must not exceed the total_medical_amount, and the total_medical_amount may not exceed the total transaction_amount.

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.

Once an authorization request is approved, one of three things happen. If you are using the Host Capture settlement_mode, and your Paymentech account is setup with the Host Auto Close feature, you need take no further action. The host will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. In order for the merchant's batch to be included in the Paymentech Host Auto Close process, the merchant parameter file on the host must indicate that the merchant is Auto Close. Without this flag being set, the merchant's transactions must be settled with a Manual Batch Release.

If you are using the Host Capture settlement_mode, and your Paymentech account not setup with Host Auto Close, then after an authorization is approved the transaction is added to the current batch on the Paymentech server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through the Manual Batch Release Settlement process in order for the blocked money to be transferred to the merchant's account. To release a batch for settlement, please see the PTechHostSettle class.

If you are using the Terminal Capture settlement_mode, you must store the XML aggregate returned from the get_detail_aggregate method and submit it at the end of the day in a manual batch settlement. A detail aggregate for each authorized transaction must be sent in a batch using the PTechManualSettle class. A transaction that has been authorized and then subsequently voided with this class must NOT be added to the batch settlement, and must not be submitted with the PTechManualSettle class. Any transaction not submitted with PTechManualSettle will eventually time out, and the block on the customer's card will be removed (essentially, you may void transactions by simply not sending them in the batch settlement). The Terminal Capture settlement_mode is required for the Restaurant and Hotel industry_types. This is because both industry_types will generally have additional charges added on to the original authorization (for example: a tip for your server, or a drink from the hotel bar charged to your room). Other industry_types may benefit from this functionality as well, but if you do not require your transactions to be authorized for one amount and then settled for a different amount, it is highly recommended you use the much simpler Host Capture settlement_mode.

Note that a transaction authorized in the Host Capture settlement_mode MUST be released for settlement using the PTechHostSettle class. It cannot be added to a manual batch settlement using the PTechManualSettle class. Doing so will result in charging the customer twice! Likewise, transactions authorized with settlement_mode set to Terminal Capture cannot be released using the PTechHostSettle class, because no record of the transaction has been stored on the Paymentech server.

Also note that you cannot mix Host Capture and Terminal Capture settlement_modes on the same merchant_number / terminal_number pair. Contact Paymentech to setup your merchant account for Terminal Capture.

Property List

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

Method List

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

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.

Config Settings

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

allow_partial_auths Property

Indicates whether partial authorizations are to be supported for Health Care Auto-Substantiation transactions.

Syntax

def get_allow_partial_auths() -> bool: ...
def set_allow_partial_auths(value: bool) -> None: ...

allow_partial_auths = property(get_allow_partial_auths, set_allow_partial_auths)

Default Value

FALSE

Remarks

If the total_medical_amount is not the same as the transaction_amount the FSA card may be declined, as FSA cards may only be used for healthcare-related purchases. However, if you set allow_partial_auths to true, the transaction may be authorized for the total_medical_amount. The customer must then make up the difference between the transaction_amount and total_medical_amount via some other form of payment (cash, credit, check, etc).

The total amount authorized by Paymentech will be returned in the response_authorized_amount. For instance, if the transaction_amount is $50, but the total_medical_amount is $42, the card is charged for $42.00 and the response_authorized_amount will be "42.00". The merchant may then collect the remaining $8 in cash, check, credit card, or any other acceptable form of payment.

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.

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.

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.

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.

clinic_amount Property

Total amount of Clinic or Other qualified medical items for Healthcare auto-substantiation.

Syntax

def get_clinic_amount() -> str: ...
def set_clinic_amount(value: str) -> None: ...

clinic_amount = property(get_clinic_amount, set_clinic_amount)

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the total_medical_amount, which must be equal to or less than the transaction_amount.

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

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.

dental_amount Property

Total amount of Dental items for Healthcare auto-substantiation.

Syntax

def get_dental_amount() -> str: ...
def set_dental_amount(value: str) -> None: ...

dental_amount = property(get_dental_amount, set_dental_amount)

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the total_medical_amount, which must be equal to or less than the transaction_amount.

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

duplicate_checking Property

Indicates whether duplicate checking is enabled.

Syntax

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

duplicate_checking = property(get_duplicate_checking, set_duplicate_checking)

Default Value

0

Remarks

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

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

eci Property

Electronic Commerce Indicator.

Syntax

def get_eci() -> str: ...
def set_eci(value: str) -> None: ...

eci = property(get_eci, set_eci)

Default Value

"7"

Remarks

This field contains a 1-character transaction indicator identifying the type of transaction being authorized. This is also known as "MOTO". This value is used only for Card Not Present transactions. See the table below for a list of supported values.

goods_indicator Property

Indicates the type of goods being sold by an e-Commerce merchant.

Syntax

def get_goods_indicator() -> int: ...
def set_goods_indicator(value: int) -> None: ...

goods_indicator = property(get_goods_indicator, set_goods_indicator)

Default Value

0

Remarks

If the merchant is selling physical goods (goods that are shipped or are otherwise tangible) this property must be set to giPhysicalGoods. If the merchant is selling Digital goods, such a membership, or any software or file that is delivered electronically, this field must be set to giDigitalGoods. This property is only valid when the industry_type is set to itECommerce.

industry_type Property

Determines the merchant's industry type.

Syntax

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

industry_type = property(get_industry_type, set_industry_type)

Default Value

0

Remarks

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

invoice_number Property

Merchant-generated invoice number.

Syntax

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

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

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

merchant_number Property

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

Syntax

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

merchant_number = property(get_merchant_number, set_merchant_number)

Default Value

""

Remarks

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

password Property

Password for authentication with the NetConnect Server .

Syntax

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

password = property(get_password, set_password)

Default Value

""

Remarks

The password will be supplied to you by Paymentech.

pin_capability Property

Indicates if the terminal device supports a PIN pad.

Syntax

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

pin_capability = property(get_pin_capability, set_pin_capability)

Default Value

0

Remarks

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

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.

prescription_amount Property

Total amount of Prescription/Rx items for Healthcare auto-substantiation.

Syntax

def get_prescription_amount() -> str: ...
def set_prescription_amount(value: str) -> None: ...

prescription_amount = property(get_prescription_amount, set_prescription_amount)

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the total_medical_amount, which must be equal to or less than the transaction_amount.

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

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:

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:

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:

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

This property is read-only.

response_balance Property

Current available balance in merchant's currency.

Syntax

def get_response_balance() -> str: ...

response_balance = property(get_response_balance, None)

Default Value

""

Remarks

Current available balance in merchant's currency. This is a signed numeric amount with an implied decimal (eg, "100" is $1.00), and represents the balance of the FSA card after this transaction was completed. If this property has a value, it should be printed on the customer's receipt.

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:

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.

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:

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:

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.

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:

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:

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:

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:

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.

total_medical_amount Property

Sum total of all medical item amounts.

Syntax

def get_total_medical_amount() -> str: ...
def set_total_medical_amount(value: str) -> None: ...

total_medical_amount = property(get_total_medical_amount, set_total_medical_amount)

Default Value

""

Remarks

This property is required when submitting a Healthcare Auto-substantiation transaction, and should indicate the sum total of all vision_amounts, prescription_amounts, clinic_amounts, and dental_amounts, plus any additional healthcare-related charges that do not fall under those categories. The category-specific amounts are optional, but at the minimum the total_medical_amount must be present for Healthcare auto-substantiation.

If other amounts are present, the total_medical_amount must be greater than or equal to the total of all other amounts. If the total_medical_amount is left blank, the transaction will be sent as a regular Retail transaction, without the healthcare indicator. If you wish to send a transaction with the healthcare indicator, but no total_medical_amount, set total_medical_amount to "0".

If the transaction is only for healthcare related costs, the total_medical_amount should be equal to the transaction_amount. However, it is possible to authorize a transaction that includes non-healthcare items, where the transaction_amount is higher than the total_medical_amount. It may be required that you set allow_partial_auths to True in order to support this functionality.

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

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.

vision_amount Property

Total amount of Vision or Optical items for Healthcare auto-substantiation.

Syntax

def get_vision_amount() -> str: ...
def set_vision_amount(value: str) -> None: ...

vision_amount = property(get_vision_amount, set_vision_amount)

Default Value

""

Remarks

The sum of all auto-substantiation items cannot be more than the total_medical_amount, which must be equal to or less than the transaction_amount.

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

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

capture Method

Sends a capture transaction to the PaymenTech Server.

Syntax

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

Remarks

Capture (Prior Sales) are typically used when a merchant has previously utilized the auth_only method. A Capture transaction adds the transaction to the current open batch, and the transaction will be settled at the next call to the PTechHostSettle class's BatchRelease method. The Paymentech system treats Capture and Force transactions identically, so this method may also be used when a merchant has obtained voice approval over the phone.

Manually keyed capture: class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.Capture("123456") 'value from voice auth or previous AuthOnly trans

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

credit Method

Credits a cardholder's account.

Syntax

def credit() -> None: ...

Remarks

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

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

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

on_data_packet_in Event

Fired when receiving a data packet from the transaction server.

Syntax

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

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

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

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

# In class PTechHealthCare:
@property
def on_error() -> Callable[[PTechHealthCareErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PTechHealthCareErrorEventParams], 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 PTechHealthCareSSLServerAuthenticationEventParams(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 PTechHealthCare:
@property
def on_ssl_server_authentication() -> Callable[[PTechHealthCareSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[PTechHealthCareSSLServerAuthenticationEventParams], 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 PTechHealthCareSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

PTechHealthCare Config Settings

PTechHealthCare Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

PTechHealthCare Errors

PTechHealthCare Errors

Paymentech Server Errors:

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

Paymentech Issuer Errors

Paymentech Format Errors

Paymentech Host / Setup Errors

Paymentech Debit / EBT Specific Errors

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

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors