PTechGiftCard Class

Properties   Methods   Events   Config Settings   Errors  

The PTechGiftCard class is used to manipulate funds on Stored Value (Gift) Cards with the Paymentech NetConnect system on the Tampa platform. This class supports card-present gift card transactions, and 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.PTechGiftCard

Remarks

A Stored Value Card (or Gift Card as they are commonly called) is a not actually a type of credit or debit card. Simply put, a Stored Value Card is a card with a magnetic strip on the back that holds information about monies that have been "pre-paid" into an account for the purpose of making financial transactions. Examples include a retailer's gift card, a prepaid telephone card, a college campus meal plan card, a reloadable subway pass, etcetera. Not included are government income-support cards, otherwise known as EBT cards or electronic food stamps.

There just a few steps to setting up the class and sending transactions. 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 pin_capability and cash_register_id at this time.

After the merchant information is setup, you may enter transaction data. When the card_entry_data_source is Manually Entered, the merchant should fill the card_number, card_exp_month, and card_exp_year properties. Otherwise, you should fill the card_magnetic_stripe property with the Track 2 data read from the back of the card, and set card_entry_data_source to Track2. These are the only two Entry Data Sources supported for Stored Value (Gift) Cards.

Now you must choose what transaction you wish to make. Adding Value to a card, Redeeming a card, voiding a previous transaction, or retrieving the card's current balance.

To add funds to an existing Gift Card, simply set the transaction_amount with the amount to add to the card, and then call add_value. Activating a new gift card is handled the same way. If the card indicated by card_magnetic_stripe (or card_number) has not yet been activated, calling add_value will automatically activate it with the amount indicated by transaction_amount.

To redeem funds from a Gift Card due to a customer purchase, set transaction_amount to the total for the purchase and call redeem_card. If the Gift Card account contains enough funds, response_code will indicate the card was approved. If there are not enough funds available on the card to cover the transaction_amount, normally the transaction will be declined. However, the merchant may set partial_redemption to True. This allows the customer to split the cost of the purchase between the Gift Card and another form of payment. Instead of declining the Gift Card, response_authorized_amount will contain the amount deducted from the Gift Card. The merchant may subtract that from transaction_amount to determine the difference to charge the customer.

Finally, you may inquire as to the total funds contained on the card by calling balance_inquiry. This will not effect the amount of funds contained on the card in any way.

The status of any of the above transactions will be stored in the response_code property, with human-readable text appearing in response_text. Like the PTechCharge class, there are several other response fields which will contain data that should be logged. However, there are a few new properties specific to the PTechGiftCard class: response_balance will be returned after all transactions except void_transaction, and will contain the current balance of the Gift Card. response_previous_balance will indicate the balance BEFORE the last transaction went through. The response_trace property is used for tracking after the sale, and must be printed on every customer receipt.

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

Property List

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

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.

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.

cash_out_indicator Property

Indicates to the host that the customer wants the remainder of the card's value returned as cash.

Syntax

def get_cash_out_indicator() -> bool: ...
def set_cash_out_indicator(value: bool) -> None: ...

cash_out_indicator = property(get_cash_out_indicator, set_cash_out_indicator)

Default Value

FALSE

Remarks

When the cash_out_indicator is set to True, the stored value card will be "cashed out". This means that all funds stored on the card is cleared, and the merchant is to return those funds to the customer as cash. Thus, when cash_out_indicator is True the response_cash_out property will contain the amount of money the merchant is to return to the customer in cash. The response_authorized_amount property will contain the total amount removed from the gift card (The sum of the transaction_amount plus the response_cash_out amount).

cash_register_id Property

Cash Register transaction identifier.

Syntax

def get_cash_register_id() -> str: ...
def set_cash_register_id(value: str) -> None: ...

cash_register_id = property(get_cash_register_id, set_cash_register_id)

Default Value

""

Remarks

The cash_register_id identifies the cash register initiating this transaction and should be a unique value defined for each of the merchant's registers. The maximum length of this property is 15 characters.

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.

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.

employee_number Property

Identifies the employee making this transaction.

Syntax

def get_employee_number() -> str: ...
def set_employee_number(value: str) -> None: ...

employee_number = property(get_employee_number, set_employee_number)

Default Value

""

Remarks

The employee_number identifies the operator initiating this transaction and should be a unique value defined for each employee within the client. This field is only required if the merchant participates in a program where operator level reporting is performed. The maximum length of this property is 10 characters.

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:

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

Note: Only the itRetail and itRestaurant industry types are supported for Stored Value transactions.

invoice_number Property

Merchant-generated invoice number.

Syntax

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

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

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

merchant_number Property

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

Syntax

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

merchant_number = property(get_merchant_number, set_merchant_number)

Default Value

""

Remarks

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

partial_redemption Property

Partial Redemption indicator.

Syntax

def get_partial_redemption() -> bool: ...
def set_partial_redemption(value: bool) -> None: ...

partial_redemption = property(get_partial_redemption, set_partial_redemption)

Default Value

FALSE

Remarks

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

Note that the response_authorized_amount will only contain a value if partial_redemption is set to True, and will remain blank otherwise. If the Stored Value card has a zero response_balance, redeem_card will fail with a declined message regardless of the value of partial_redemption.

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:

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_balance Property

Balance after this transaction was completed.

Syntax

def get_response_balance() -> str: ...

response_balance = property(get_response_balance, None)

Default Value

""

Remarks

Balance after this transaction was completed. This property contains the available balance remaining on the card. It is required that this value 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_cash_out Property

The sum of the TransactionAmount plus the remainder of any value left on the card.

Syntax

def get_response_cash_out() -> str: ...

response_cash_out = property(get_response_cash_out, None)

Default Value

""

Remarks

The sum of the transaction_amount plus the remainder of any value left on the card. When the cash_out_indicator property is set to True, the stored value card will be "cashed out". This means that all funds stored on the card is cleared, and the merchant is to return those funds to the customer as cash. When cash_out_indicator is True, the response_cash_out field will contain the amount of money the merchant is to return to the customer in cash. response_authorized_amount will contain the total amount removed from the gift card (The sum of the transaction_amount plus the response_cash_out amount).

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_previous_balance Property

Balance before this transaction started.

Syntax

def get_response_previous_balance() -> str: ...

response_previous_balance = property(get_response_previous_balance, None)

Default Value

""

Remarks

Balance before this transaction started. This property contains the available balance on the card BEFORE this transaction took place. For instance, if a Stored Value card contains funds in the amount of $50.00, and the transaction_amount for this authorization was "20.00", the response_balance will contain "30.00" and the response_previous_balance, if returned, will contain "50.00". This property may or may not be returned by the processor, and is not required to be printed on the customer's receipt.

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_trace Property

Trace number returned for Stored Value transactions.

Syntax

def get_response_trace() -> str: ...

response_trace = property(get_response_trace, None)

Default Value

""

Remarks

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

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.

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.

activate_card Method

Activates a Gift Card.

Syntax

def activate_card() -> None: ...

Remarks

Stored value Activation transactions provide merchants the ability to activate a new stored value card on the Chase Paymentech stored value host. Activation transactions can only be performed on cards that have not been previously activated. Activation transactions are usually used by merchants who wish to identify how many new stored value cards have been issued, from the previously activated stored value cards that have had additional value issued. Merchants have the ability to activate stored value cards with a host configured pre-denominated transaction_amount or activate the cards with a flexible transaction_amount. With pre-denominated cards, dependent on host configurations, the stored value host will either approve the transaction for the amount that the pre-denominated card is setup for (regardless of the amount keyed), or decline the transaction if the amount keyed at the Point-of-Sale if the amount doesn't match the amount identified on the card.

This transaction is automatically added to the current open batch, and will be settled when the PTechHostSettle class's BatchRelease method is called.

The gift card may be specified by either a card_magnetic_stripe returned by a card reader, (Track2 only), or manually entered through the card_number, card_exp_month, and card_exp_year.A 3-digit Card Verification Value code may also be supplied in the card_cvv_data property.

The response_code and response_text properties indicate whether this transaction was successful.

Note: Activation transactions will fail at the stored value host if the card has been previously activated or has previously had value issued to it. Also, activate_card cannot be used to activate a card that has been deactivated via the deactivate_card method. You must use the reactivate_card method instead.

add_value Method

Activates and/or adds funds to a Gift Card.

Syntax

def add_value() -> None: ...

Remarks

add_value transactions allows a merchant to issue or add value to a stored value card at the host. This transaction can be used on both new and existing stored value cards. The add_value transaction can be used in place of an activate_card transaction.

add_value transactions can be performed on a stored value card more than once over the lifetime of the card, as the cardholder chooses to "reload" the card.

Merchants have the ability to issue stored value cards with a host configured pre-denominated amount, or issue the cards with a flexible transaction amount. With pre-denominated cards, based on the selections indicated at sign-up, the stored value host will either approve the transaction for the amount that the pre-denominated card is setup for (regardless of the amount keyed), or decline the transaction if the amount keyed at the Point Of Sale doesn't match the amount identified on the card.

This transaction is automatically added to the current open batch, and will be settled when the PTechHostSettle class's BatchRelease method is called.

The gift card may be specified by either a card_magnetic_stripe returned by a card reader, (Track2 only), or manually entered through the card_number, card_exp_month, and card_exp_year.A 3-digit Card Verification Value code may also be supplied in the card_cvv_data property.

The response_code and response_text properties indicate whether this transaction was successful.

balance_inquiry Method

Retrieves the balance remaining on a gift card.

Syntax

def balance_inquiry() -> None: ...

Remarks

A balance_inquiry transaction requests that the host return the quantity of funds remaining in the customer's Stored Value (Gift) Card. This transaction is not added to the batch and cannot be settled by the PTechHostSettle class. No charge is made to the customer's gift card.

The gift card may be specified by either a card_magnetic_stripe returned by a card reader, (Track2 only), or manually entered through the card_number, card_exp_month, and card_exp_year.A 3-digit Card Verification Value code may also be supplied in the card_cvv_data property.

The response_code and response_text properties indicate whether this transaction was successful. The response_balance property will contain the card's current balance.

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.

deactivate_card Method

Deactivates a gift card.

Syntax

def deactivate_card() -> None: ...

Remarks

A stored value Deactivation transaction is the process of removing the remaining balance from a card account and placing the card into an inactive status. This transaction is most often used when the cardholder has lost the card, yet still has the card number. The terminal will initiate a transaction to the host, which will redeem the total balance on the card. Once a card is deactivated, it can only be restored to circulation using the reactivate_card method. Calling add_value on a deactivated card will result in an error.

The gift card may be specified by either a card_magnetic_stripe returned by a card reader, (Track2 only), or manually entered through the card_number, card_exp_month, and card_exp_year.A 3-digit Card Verification Value code may also be supplied in the card_cvv_data property.

The response_code and response_text properties indicate whether this transaction was successful.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

reactivate_card Method

Re-activates Gift Card that has been previously deactivated.

Syntax

def reactivate_card() -> None: ...

Remarks

This method re-activates and returns to circulation a Gift Card that was deactivated through the deactivate_card method. Note that any balance that was present before the card was deactivated is lost, and the card starts fresh with a $0.00 balance. You must specify a transaction_amount to initialize the reactivated card with funds (you cannot reactivate a card with a $0.00 transaction_amount).

The gift card may be specified by either a card_magnetic_stripe returned by a card reader, (Track2 only), or manually entered through the card_number, card_exp_month, and card_exp_year.A 3-digit Card Verification Value code may also be supplied in the card_cvv_data property.

The response_code and response_text properties indicate whether this transaction was successful.

redeem_card Method

Deducts funds from a gift card for the purchase of goods or services.

Syntax

def redeem_card() -> None: ...

Remarks

A Redemption transaction is the process of deducting value from the Gift Card, and is very similar to a Credit Card Sale transaction, except that funds are immediately removed from the balance of the gift card. redeem_card requests that the host verify and remove funds from the cardholder's Stored Value (Gift) Card. This transaction is automatically added to the current open batch, and will be settled when the PTechHostSettle class's BatchRelease method is called.

The gift card may be specified by either a card_magnetic_stripe returned by a card reader, (Track2 only), or manually entered through the card_number, card_exp_month, and card_exp_year.A 3-digit Card Verification Value code may also be supplied in the card_cvv_data property.

The response_code and response_text properties indicate whether this transaction was successful. The host will return either an approval if the card has the requested value, or a decline if the card has less than the requested value.

If the merchant allows it, at the time of purchase a customer my Cash Out his gift card, and receive the remainder of the gift card's stored value as cash. To cash out a gift card, set the cash_out_indicator to True before calling redeem_card. The change to be returned to the customer (The gift card's total value minus the transaction_amount) will be returned in response_cash_out, and the response_balance will be "0.00".

In the case that the customer's gift card does not have enough funds to cover the entire transaction_amount, the merchant may request that the host perform a Partial Redemption. With partial_redemption set to True, the Point of Sale is capable of processing a Redemption transaction for more than the card balance and still receive an approval. All of the funds remaining on the gift card will be put towards the transaction_amount, and the merchant will be required to obtain an additional form of payment for the remaining balance. The amount actually removed from the card will be returned in response_authorized_amount, and the customer's receipt should indicate the remaining amount (transaction_amount - response_authorized_amount) due.

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

void_transaction Method

Voids a transaction in the current batch.

Syntax

def void_transaction(retrieval_number_to_void: str, last_retrieval_number: str) -> None: ...

Remarks

A stored value Void transaction allows the removal of a transaction from the open batch in the terminal. The void will communicate to the stored value host so that the host can reverse the requested stored value transaction.

The void_transaction method has two parameters, RetrievalNumberToVoid and LastRetrievalNumber. RetrievalNumberToVoid is the response_retrieval_number of the transaction you wish to void. LastRetrievalNumber should be set to the last response_retrieval_number received from the Paymentech server. If LastRetrievalNumber is left blank, the contents of the response_retrieval_number property will be used instead.

Before sending a void, you must make sure that the card_number property contains the card number from the original transaction. For example:

class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.RedeemCard() cnumToVoid = class.CardNumber refNumToVoid = class.ResponseRetrievalNumber ... more sale transactions ... 'All that's needed for a void: class.SequenceNumber = class.SequenceNumber + 1 class.CardNumber = cnumToVoid class.VoidTransaction(refNumToVoid, class.ResponseRetrievalNumber)

In the above void, if you use a new instance of the class or otherwise reset it's state, you must set the LastRetrievalNumber parameter as well.

Note: Voids cannot be performed on balance_inquiry or Forced transactions.

on_data_packet_in Event

Fired when receiving a data packet from the transaction server.

Syntax

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

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

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

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

# In class PTechGiftCard:
@property
def on_error() -> Callable[[PTechGiftCardErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PTechGiftCardErrorEventParams], 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 PTechGiftCardSSLServerAuthenticationEventParams(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 PTechGiftCard:
@property
def on_ssl_server_authentication() -> Callable[[PTechGiftCardSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[PTechGiftCardSSLServerAuthenticationEventParams], 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 PTechGiftCardSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

PTechGiftCard Config Settings

PTechGiftCard 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

PTechGiftCard Errors

PTechGiftCard 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