PTechDebit Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DPaymentsSDK_PTechDebit

Procedural Interface

 dpaymentssdk_ptechdebit_open();
 dpaymentssdk_ptechdebit_close($res);
 dpaymentssdk_ptechdebit_register_callback($res, $id, $function);
 dpaymentssdk_ptechdebit_get_last_error($res);
 dpaymentssdk_ptechdebit_get_last_error_code($res);
 dpaymentssdk_ptechdebit_set($res, $id, $index, $value);
 dpaymentssdk_ptechdebit_get($res, $id, $index);
 dpaymentssdk_ptechdebit_do_config($res, $configurationstring);
 dpaymentssdk_ptechdebit_do_credit($res);
 dpaymentssdk_ptechdebit_do_interrupt($res);
 dpaymentssdk_ptechdebit_do_reset($res);
 dpaymentssdk_ptechdebit_do_sale($res);

Remarks

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

First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your IndustryType and PINCapability at this time.

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

Finally, set the TransactionAmount and, and if applicable any DebitCashBack amount. Then call Sale to send the transaction to the Paymentech Server for processing.

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

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

Property List

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

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.

CardMagneticStripe Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 1 );


dpaymentssdk_ptechdebit_set($res, 1, $value );

Default Value

''

Remarks

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

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

Data Type

String

ClientNumber Property (DPaymentsSDK_PTechDebit Class)

Merchant configuration property, assigned by Paymentech.

Object Oriented Interface

public function getClientNumber();


public function setClientNumber($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 2 );


dpaymentssdk_ptechdebit_set($res, 2, $value );

Default Value

''

Remarks

The ClientNumber will be supplied to you by Paymentech.

Data Type

String

DebitCashBack Property (DPaymentsSDK_PTechDebit Class)

Optional cash back amount for debit transactions.

Object Oriented Interface

public function getDebitCashBack();


public function setDebitCashBack($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 3 );


dpaymentssdk_ptechdebit_set($res, 3, $value );

Default Value

''

Remarks

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

If the DebitPIN and DebitKSN are not populated, the value of this property is ignored.

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

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

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

Data Type

String

DebitKSN Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getDebitKSN();


public function setDebitKSN($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 4 );


dpaymentssdk_ptechdebit_set($res, 4, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

DebitPIN Property (DPaymentsSDK_PTechDebit Class)

DUKPT DES encrypted PIN block, used for Debit transactions.

Object Oriented Interface

public function getDebitPIN();


public function setDebitPIN($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 5 );


dpaymentssdk_ptechdebit_set($res, 5, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

DuplicateChecking Property (DPaymentsSDK_PTechDebit Class)

Indicates whether duplicate checking is enabled.

Object Oriented Interface

public function getDuplicateChecking();


public function setDuplicateChecking($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 6 );


dpaymentssdk_ptechdebit_set($res, 6, $value );

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 BatchInquiry and BatchRelease transactions.

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

Data Type

Integer

IndustryType Property (DPaymentsSDK_PTechDebit Class)

Determines the merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 7 );


dpaymentssdk_ptechdebit_set($res, 7, $value );

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 IndustryType. Setting the HotelPreferredCustomer property to True.

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

Data Type

Integer

InvoiceNumber Property (DPaymentsSDK_PTechDebit Class)

Merchant-generated invoice number.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 8 );


dpaymentssdk_ptechdebit_set($res, 8, $value );

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

Data Type

String

MerchantNumber Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getMerchantNumber();


public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 9 );


dpaymentssdk_ptechdebit_set($res, 9, $value );

Default Value

''

Remarks

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

Data Type

String

Password Property (DPaymentsSDK_PTechDebit Class)

Password for authentication with the NetConnect Server .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 10 );


dpaymentssdk_ptechdebit_set($res, 10, $value );

Default Value

''

Remarks

The Password will be supplied to you by Paymentech.

Data Type

String

PINCapability Property (DPaymentsSDK_PTechDebit Class)

Indicates if the terminal device supports a PIN pad.

Object Oriented Interface

public function getPINCapability();


public function setPINCapability($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 11 );


dpaymentssdk_ptechdebit_set($res, 11, $value );

Default Value

1

Remarks

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

Data Type

Integer

POSRetrievalNumber Property (DPaymentsSDK_PTechDebit Class)

Merchant-generated reference number, used for reversals.

Object Oriented Interface

public function getPOSRetrievalNumber();


public function setPOSRetrievalNumber($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 12 );


dpaymentssdk_ptechdebit_set($res, 12, $value );

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.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 13 );


dpaymentssdk_ptechdebit_set($res, 13, $value );

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 ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

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

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 14 );


dpaymentssdk_ptechdebit_set($res, 14, $value );

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.

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 15 );


dpaymentssdk_ptechdebit_set($res, 15, $value );

Default Value

''

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 16 );


dpaymentssdk_ptechdebit_set($res, 16, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 17 );


dpaymentssdk_ptechdebit_set($res, 17, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 18 );


dpaymentssdk_ptechdebit_set($res, 18, $value );

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:

Data Type

Integer

ProxyUser Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 19 );


dpaymentssdk_ptechdebit_set($res, 19, $value );

Default Value

''

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 20 );

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 ResponseCode returned indicates that the transaction has not been approved, then this field will contain an error code, and the ResponseText 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.

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_PTechDebit Class)

Used for partial authorizations.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 21 );

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 PartialRedemption is set to True, the host will supply the actual amount authorized from the stored value card in the ResponseAuthorizedAmount field.

Note that the ResponseAuthorizedAmount 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.

Data Type

String

ResponseAuthSource Property (DPaymentsSDK_PTechDebit Class)

Indicates the source of the authorization code stored in ApprovalCode .

Object Oriented Interface

public function getResponseAuthSource();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 22 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_PTechDebit Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 23 );

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 ResponseCode property for a more detailed list of ResponseCode and ResponseAVSResult code combinations.

Valid AVS Codes:

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

This property is read-only and not available at design time.

Data Type

String

ResponseBatchNumber Property (DPaymentsSDK_PTechDebit Class)

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.

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 24 );

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.

Data Type

String

ResponseCardLevel Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getResponseCardLevel();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 25 );

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 and not available at design time.

Data Type

String

ResponseCardType Property (DPaymentsSDK_PTechDebit Class)

Type of the credit card.

Object Oriented Interface

public function getResponseCardType();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 26 );

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.

Data Type

String

ResponseCode Property (DPaymentsSDK_PTechDebit Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 27 );

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.

Data Type

String

ResponseCVVResult Property (DPaymentsSDK_PTechDebit Class)

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 28 );

Default Value

''

Remarks

Contains the returned CVV result code if it was requested. If a CVV value was present in the CardCVVData 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 ResponseText indicating such. The following is a list of current result codes:

This property is read-only and not available at design time.

Data Type

String

ResponseDebitSurcharge Property (DPaymentsSDK_PTechDebit Class)

Additional fee charged for debit transactions.

Object Oriented Interface

public function getResponseDebitSurcharge();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 29 );

Default Value

''

Remarks

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

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

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

This property is read-only.

Data Type

String

ResponseDebitTrace Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getResponseDebitTrace();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 30 );

Default Value

''

Remarks

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

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

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

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

This property is read-only.

Data Type

String

ResponseNetworkId Property (DPaymentsSDK_PTechDebit Class)

Authorizing network Identifier which indicates which network approved this transaction.

Object Oriented Interface

public function getResponseNetworkId();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 31 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (DPaymentsSDK_PTechDebit Class)

Reference number returned from the Paymentech host.

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 32 );

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 VoidTransaction 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 ResponseRetrievalNumber will contain the number used to reference the transaction when issuing voids or reversals.

This property is read-only.

Data Type

String

ResponseSequenceNumber Property (DPaymentsSDK_PTechDebit Class)

SequenceNumber echoed from the authorization.

Object Oriented Interface

public function getResponseSequenceNumber();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 33 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ResponseText Property (DPaymentsSDK_PTechDebit Class)

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.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 34 );

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 ResponseApprovalCode property. The ResponseText property is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the ResponseCode property to determine this.

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

This property is read-only.

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 35 );

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.

Data Type

String

SequenceNumber Property (DPaymentsSDK_PTechDebit Class)

Sequence number of the transaction.

Object Oriented Interface

public function getSequenceNumber();


public function setSequenceNumber($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 36 );


dpaymentssdk_ptechdebit_set($res, 36, $value );

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 SettlementMode, 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 ResponseSequenceNumber property.

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

Data Type

Integer

Server Property (DPaymentsSDK_PTechDebit Class)

The URL for the PaymenTech NetConnect server.

Object Oriented Interface

public function getServer();


public function setServer($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 37 );


dpaymentssdk_ptechdebit_set($res, 37, $value );

Default Value

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

Remarks

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_PTechDebit Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 39 );


dpaymentssdk_ptechdebit_set($res, 39, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_PTechDebit Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 67 );


dpaymentssdk_ptechdebit_set($res, 67, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 83 );


dpaymentssdk_ptechdebit_set($res, 83, $value );

Default Value

'MY'

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

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

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 84 );


dpaymentssdk_ptechdebit_set($res, 84, $value );

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.

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_PTechDebit Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 85 );


dpaymentssdk_ptechdebit_set($res, 85, $value );

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:

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_PTechDebit Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 86 );


dpaymentssdk_ptechdebit_set($res, 86, $value );

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.

Data Type

String

SSLProvider Property (DPaymentsSDK_PTechDebit Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 94 );


dpaymentssdk_ptechdebit_set($res, 94, $value );

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.

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_PTechDebit Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 96 );

Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

TerminalNumber Property (DPaymentsSDK_PTechDebit Class)

Terminal number assigned by Paymentech.

Object Oriented Interface

public function getTerminalNumber();


public function setTerminalNumber($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 123 );


dpaymentssdk_ptechdebit_set($res, 123, $value );

Default Value

''

Remarks

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

Data Type

String

Timeout Property (DPaymentsSDK_PTechDebit Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 124 );


dpaymentssdk_ptechdebit_set($res, 124, $value );

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

Data Type

Integer

TransactionAmount Property (DPaymentsSDK_PTechDebit Class)

Purchase amount for an authorization.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 125 );


dpaymentssdk_ptechdebit_set($res, 125, $value );

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 TransactionAmount must include the total cost of the purchase, PLUS the DebitCashBack amount.

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

Data Type

String

UserId Property (DPaymentsSDK_PTechDebit Class)

UserId for authentication with the NetConnect Server .

Object Oriented Interface

public function getUserId();


public function setUserId($value);

Procedural Interface

dpaymentssdk_ptechdebit_get($res, 126 );


dpaymentssdk_ptechdebit_set($res, 126, $value );

Default Value

''

Remarks

The UserId will be supplied to you by PaymenTech.

Data Type

String

Config Method (DPaymentsSDK_PTechDebit Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_ptechdebit_do_config($res, $configurationstring);

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

Credits a cardholder's account.

Object Oriented Interface

public function doCredit();

Procedural Interface

dpaymentssdk_ptechdebit_do_credit($res);

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 VoidTransaction method instead.

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

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

Interrupt Method (DPaymentsSDK_PTechDebit Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_ptechdebit_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_PTechDebit Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_ptechdebit_do_reset($res);

Remarks

This method clears all properties to their default values.

Sale Method (DPaymentsSDK_PTechDebit Class)

Sends a Sale transaction to the host.

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_ptechdebit_do_sale($res);

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

DataPacketIn Event (DPaymentsSDK_PTechDebit Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_ptechdebit_register_callback($res, 1, array($this, 'fireDataPacketIn'));

Parameter List

 'datapacket'

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.

DataPacketOut Event (DPaymentsSDK_PTechDebit Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_ptechdebit_register_callback($res, 2, array($this, 'fireDataPacketOut'));

Parameter List

 'datapacket'

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.

Error Event (DPaymentsSDK_PTechDebit Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_ptechdebit_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

SSLServerAuthentication Event (DPaymentsSDK_PTechDebit Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_ptechdebit_register_callback($res, 4, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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.

SSLStatus Event (DPaymentsSDK_PTechDebit Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_ptechdebit_register_callback($res, 5, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (PTechDebit Class)

PTechDebit 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

Trappable Errors (PTechDebit Class)

PTechDebit 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 ResponseCode property will contain "E", the error code will be contained in the ResponseApprovalCode property, and the description in ResponseText

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