PTechReversal Class

Properties   Methods   Events   Config Settings   Errors  

The PTECHREVERSAL class is used to reverse a transaction that was previously authorized with the Paymentech NetConnect system on the Tampa platform. This immediately releases the funds in the cardholder's open-to-buy that were blocked by the original authorization.

Class Name

DPaymentsSDK_PTechReversal

Procedural Interface

 dpaymentssdk_ptechreversal_open();
 dpaymentssdk_ptechreversal_close($res);
 dpaymentssdk_ptechreversal_register_callback($res, $id, $function);
 dpaymentssdk_ptechreversal_get_last_error($res);
 dpaymentssdk_ptechreversal_get_last_error_code($res);
 dpaymentssdk_ptechreversal_set($res, $id, $index, $value);
 dpaymentssdk_ptechreversal_get($res, $id, $index);
 dpaymentssdk_ptechreversal_do_config($res, $configurationstring);
 dpaymentssdk_ptechreversal_do_interrupt($res);
 dpaymentssdk_ptechreversal_do_reset($res);
 dpaymentssdk_ptechreversal_do_reverse($res);

Remarks

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

After the merchant information is setup, enter the data from the transaction you wish to reverse. Note that the transaction must be a currently open authorization, and cannot have already been settled via the PTechManualSettle class. To reverse an authorization, set the CardNumber, CardExpMonth, CardExpYear, IndustryType, and POSRetrievalNumber which were sent in the original transaction. Also indicate the type of the original authorization (Auth-only or Sale) in the OriginalTransactionType property. The OriginalTransactionAmount should be set to the amount originally sent in the TransactionAmount property of the class that authorized the transaction. It does not matter if the amount actually authorized was less, the originally submitted amount must be sent in the OriginalTransactionAmount property.

For example: class.IndustryType = itRetail class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.OriginalTransactionType = ttAuthOnly class.OriginalTransactionAmount = "1.00" class.POSRetrievalNumber = "1234567890" class.Reverse()

The status of the reversal 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.

Reversal transactions must NOT be added to the batch settlement, and the authorization which was reversed by this class MUST be removed from the batch. Settling a reversed transaction will result in transfer of funds from the customer's credit card to your merchant account, so care must be taken to ensure that reversed transaction are not included in the manual settlement.

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.

CardExpMonth Property (DPaymentsSDK_PTechReversal Class)

Expiration month of the credit card specified by CardNumber .

Object Oriented Interface

public function getCardExpMonth();
public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 1 );
dpaymentssdk_ptechreversal_set($res, 1, $value );

Default Value

1

Remarks

This property contains the expiration date of the credit card used in the transaction that is being reversed. This property must be in the range 1 - 12.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_PTechReversal Class)

Expiration year of the credit card specified by CardNumber .

Object Oriented Interface

public function getCardExpYear();
public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 2 );
dpaymentssdk_ptechreversal_set($res, 2, $value );

Default Value

0

Remarks

This property contains the expiration date of the credit card used in the transaction that is being reversed. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 cannot be specified.

Data Type

Integer

CardNumber Property (DPaymentsSDK_PTechReversal Class)

Credit card used in the transaction that is now being reversed.

Object Oriented Interface

public function getCardNumber();
public function setCardNumber($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 3 );
dpaymentssdk_ptechreversal_set($res, 3, $value );

Default Value

''

Remarks

This property contains the number of the credit card used in the transaction that is being reversed.

Data Type

String

ClientNumber Property (DPaymentsSDK_PTechReversal Class)

Merchant configuration property, assigned by Paymentech.

Object Oriented Interface

public function getClientNumber();
public function setClientNumber($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 4 );
dpaymentssdk_ptechreversal_set($res, 4, $value );

Default Value

''

Remarks

The ClientNumber will be supplied to you by Paymentech.

Data Type

String

IndustryType Property (DPaymentsSDK_PTechReversal Class)

Determines the merchant's industry type.

Object Oriented Interface

public function getIndustryType();
public function setIndustryType($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 5 );
dpaymentssdk_ptechreversal_set($res, 5, $value );

Possible Values

PTECHREVERSAL_INDUSTRYTYPE_RETAIL(0), 
PTECHREVERSAL_INDUSTRYTYPE_DIRECT_MARKETING(1), 
PTECHREVERSAL_INDUSTRYTYPE_ECOMMERCE(2), 
PTECHREVERSAL_INDUSTRYTYPE_RESTAURANT(3), 
PTECHREVERSAL_INDUSTRYTYPE_HOTEL(4)

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: This class can only be used to submit itRetail, itHotel, and itRestaurant transactions. Attempting to set any other IndustryType will cause the class to fails with an error

Data Type

Integer

MerchantNumber Property (DPaymentsSDK_PTechReversal 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_ptechreversal_get($res, 6 );
dpaymentssdk_ptechreversal_set($res, 6, $value );

Default Value

''

Remarks

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

Data Type

String

OriginalTransactionAmount Property (DPaymentsSDK_PTechReversal Class)

Transaction amount sent in the original sale or auth-only transaction.

Object Oriented Interface

public function getOriginalTransactionAmount();
public function setOriginalTransactionAmount($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 7 );
dpaymentssdk_ptechreversal_set($res, 7, $value );

Default Value

''

Remarks

This field contains the original amount sent in the transaction which is now to be reversed. It does not matter if the approved amount was less than the transaction amount, you must still send the transaction amount that was submitted in the original transaction.

When performing a partial reversal, when AllowPartialReversals is 'True', this value will be the final amount the customer will be charged.

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

Data Type

String

OriginalTransactionType Property (DPaymentsSDK_PTechReversal Class)

Indicates whether the original transaction was an auth-only or a sale.

Object Oriented Interface

public function getOriginalTransactionType();
public function setOriginalTransactionType($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 8 );
dpaymentssdk_ptechreversal_set($res, 8, $value );

Possible Values

PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_SALE(0), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_AUTH_ONLY(1), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_CAPTURE_FORCE(2), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_CREDIT(3), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_DEBIT_SALE(4), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_DEBIT_SALE_CASHBACK(5), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_DEBIT_CREDIT(6), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_GIFT_CARD_ADD_VALUE(7), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_GIFT_CARD_ACTIVATE_CARD(8), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_GIFT_CARD_REDEEM_CARD(9), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_GIFT_CARD_DEACTIVATE_CARD(10), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_GIFT_CARD_REACTIVATE_CARD(11), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_EBTSALE(12), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_EBTFORCE(13), 
PTECHREVERSAL_ORIGINALTRANSACTIONTYPE_EBTCREDIT(14)

Default Value

0

Remarks

When reversing a transaction you must indicate whether the original transaction was an Auth-only transaction, a Sale transaction, a Capture/Force (Voice Authorization) transaction, or a Credit (Refund) transaction.

If reversing a Debit transaction, you must specify whether the original transaction was a DebitSale, DebitSaleCashback (a Debit Sale transaction in which a Cashback amount was specified), or a DebitCredit (Credit transaction using a Debit card).

If reversing a Gift Card transaction, you must specify whether the original transaction was a AddValue, ActivateCard, RedeemCard, DeactivateCard or a ReactivateCard.

If reversing an EBT card transaction, you must specify whether the original transaction was a Sale, a Force (Voice Authorization) transaction, or Credit (Refund) transaction.

This is so the host can match the reversal to the original authorization.

Data Type

Integer

Password Property (DPaymentsSDK_PTechReversal Class)

Password for authentication with the NetConnect Server .

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 9 );
dpaymentssdk_ptechreversal_set($res, 9, $value );

Default Value

''

Remarks

The Password will be supplied to you by Paymentech.

Data Type

String

PINCapability Property (DPaymentsSDK_PTechReversal Class)

Indicates if the terminal device supports a PIN pad.

Object Oriented Interface

public function getPINCapability();
public function setPINCapability($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 10 );
dpaymentssdk_ptechreversal_set($res, 10, $value );

Possible Values

PTECHREVERSAL_PINCAPABILITY_UNKNOWN(0), 
PTECHREVERSAL_PINCAPABILITY_ACCEPTS_PIN(1), 
PTECHREVERSAL_PINCAPABILITY_NO_PIN(2), 
PTECHREVERSAL_PINCAPABILITY_PAD_INOPERATIVE(8), 
PTECHREVERSAL_PINCAPABILITY_VERIFIED_PIN(9)

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:

Data Type

Integer

POSRetrievalNumber Property (DPaymentsSDK_PTechReversal Class)

Merchant-generated reference number from the original transaction.

Object Oriented Interface

public function getPOSRetrievalNumber();
public function setPOSRetrievalNumber($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 11 );
dpaymentssdk_ptechreversal_set($res, 11, $value );

Default Value

''

Remarks

This property must contain the retrieval number that was sent with the original authorization.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_PTechReversal Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 12 );
dpaymentssdk_ptechreversal_set($res, 12, $value );

Possible Values

PTECHREVERSAL_PROXYAUTHSCHEME_BASIC(0), 
PTECHREVERSAL_PROXYAUTHSCHEME_DIGEST(1), 
PTECHREVERSAL_PROXYAUTHSCHEME_PROPRIETARY(2), 
PTECHREVERSAL_PROXYAUTHSCHEME_NONE(3), 
PTECHREVERSAL_PROXYAUTHSCHEME_NTLM(4), 
PTECHREVERSAL_PROXYAUTHSCHEME_NEGOTIATE(5)

Default Value

0

Remarks

The 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 class 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_PTechReversal Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 13 );
dpaymentssdk_ptechreversal_set($res, 13, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_PTechReversal Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 14 );
dpaymentssdk_ptechreversal_set($res, 14, $value );

Default Value

''

Remarks

A password 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

ProxyPort Property (DPaymentsSDK_PTechReversal Class)

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_ptechreversal_get($res, 15 );
dpaymentssdk_ptechreversal_set($res, 15, $value );

Default Value

80

Remarks

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_PTechReversal 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_ptechreversal_get($res, 16 );
dpaymentssdk_ptechreversal_set($res, 16, $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_PTechReversal Class)

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_ptechreversal_get($res, 17 );
dpaymentssdk_ptechreversal_set($res, 17, $value );

Possible Values

PTECHREVERSAL_PROXYSSL_AUTOMATIC(0), 
PTECHREVERSAL_PROXYSSL_ALWAYS(1), 
PTECHREVERSAL_PROXYSSL_NEVER(2), 
PTECHREVERSAL_PROXYSSL_TUNNEL(3)

Default Value

0

Remarks

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_PTechReversal Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 18 );
dpaymentssdk_ptechreversal_set($res, 18, $value );

Default Value

''

Remarks

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_PTechReversal Class)

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

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 19 );

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_PTechReversal Class)

Used for partial authorizations.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 20 );

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_PTechReversal Class)

Indicates the source of the authorization code stored in ApprovalCode .

Object Oriented Interface

public function getResponseAuthSource();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 21 );

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_PTechReversal Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 22 );

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_PTechReversal 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_ptechreversal_get($res, 23 );

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_PTechReversal Class)

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

Object Oriented Interface

public function getResponseCardLevel();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 24 );

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_PTechReversal Class)

Type of the credit card.

Object Oriented Interface

public function getResponseCardType();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 25 );

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_PTechReversal Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 26 );

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_PTechReversal Class)

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 27 );

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_PTechReversal Class)

Additional fee charged for debit transactions.

Object Oriented Interface

public function getResponseDebitSurcharge();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 28 );

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_PTechReversal Class)

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

Object Oriented Interface

public function getResponseDebitTrace();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 29 );

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_PTechReversal Class)

Authorizing network Identifier which indicates which network approved this transaction.

Object Oriented Interface

public function getResponseNetworkId();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 30 );

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_PTechReversal Class)

Reference number returned from the Paymentech host.

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 31 );

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_PTechReversal Class)

SequenceNumber echoed from the authorization.

Object Oriented Interface

public function getResponseSequenceNumber();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 32 );

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_PTechReversal 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_ptechreversal_get($res, 33 );

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_PTechReversal 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_ptechreversal_get($res, 34 );

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

ReversalReason Property (DPaymentsSDK_PTechReversal Class)

Reason the transaction is being reversed.

Object Oriented Interface

public function getReversalReason();
public function setReversalReason($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 35 );
dpaymentssdk_ptechreversal_set($res, 35, $value );

Possible Values

PTECHREVERSAL_REVERSALREASON_NOT_SET(0), 
PTECHREVERSAL_REVERSALREASON_NO_RESPONSE_FROM_HOST(1), 
PTECHREVERSAL_REVERSALREASON_LATE_RESPONSE_FROM_HOST(2), 
PTECHREVERSAL_REVERSALREASON_UNABLE_TO_DELIVER_TO_POS(3), 
PTECHREVERSAL_REVERSALREASON_CARD_DECLINED(4), 
PTECHREVERSAL_REVERSALREASON_AUTH_REVERSAL_SUSPECTED_FRAUD(9)

Default Value

0

Remarks

This property indicates to the host the reason why the original transaction is now being reversed. The valid values are shown below:

Data Type

Integer

SequenceNumber Property (DPaymentsSDK_PTechReversal Class)

Sequence number of the transaction.

Object Oriented Interface

public function getSequenceNumber();
public function setSequenceNumber($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 36 );
dpaymentssdk_ptechreversal_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_PTechReversal Class)

The URL for the PaymenTech NetConnect server.

Object Oriented Interface

public function getServer();
public function setServer($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 37 );
dpaymentssdk_ptechreversal_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

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_PTechReversal Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 38 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (DPaymentsSDK_PTechReversal Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 39 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (DPaymentsSDK_PTechReversal Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 40 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 41 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 42 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 43 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (DPaymentsSDK_PTechReversal Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 44 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (DPaymentsSDK_PTechReversal Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 45 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (DPaymentsSDK_PTechReversal Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 46 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (DPaymentsSDK_PTechReversal Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 47 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (DPaymentsSDK_PTechReversal Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 48 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (DPaymentsSDK_PTechReversal Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 49 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (DPaymentsSDK_PTechReversal Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 50 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (DPaymentsSDK_PTechReversal Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 51 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (DPaymentsSDK_PTechReversal Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 52 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (DPaymentsSDK_PTechReversal Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 53 );
dpaymentssdk_ptechreversal_set($res, 53, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (DPaymentsSDK_PTechReversal 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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 54 );
dpaymentssdk_ptechreversal_set($res, 54, $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

SSLAcceptServerCertStoreType Property (DPaymentsSDK_PTechReversal Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 55 );
dpaymentssdk_ptechreversal_set($res, 55, $value );

Possible Values

PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
PTECHREVERSAL_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_PTechReversal Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 56 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_PTechReversal Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 57 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (DPaymentsSDK_PTechReversal Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 58 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (DPaymentsSDK_PTechReversal Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 59 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (DPaymentsSDK_PTechReversal Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 60 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (DPaymentsSDK_PTechReversal Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 61 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (DPaymentsSDK_PTechReversal Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 62 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (DPaymentsSDK_PTechReversal Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 63 );
dpaymentssdk_ptechreversal_set($res, 63, $value );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_PTechReversal Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 64 );
dpaymentssdk_ptechreversal_set($res, 64, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (DPaymentsSDK_PTechReversal Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 65 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (DPaymentsSDK_PTechReversal Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 66 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (DPaymentsSDK_PTechReversal Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 67 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 68 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 69 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 70 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (DPaymentsSDK_PTechReversal Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 71 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (DPaymentsSDK_PTechReversal Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 72 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (DPaymentsSDK_PTechReversal Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 73 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (DPaymentsSDK_PTechReversal Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 74 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (DPaymentsSDK_PTechReversal Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 75 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (DPaymentsSDK_PTechReversal Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 76 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (DPaymentsSDK_PTechReversal Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 77 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (DPaymentsSDK_PTechReversal Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 78 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (DPaymentsSDK_PTechReversal Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 79 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (DPaymentsSDK_PTechReversal Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 80 );
dpaymentssdk_ptechreversal_set($res, 80, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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_PTechReversal 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_ptechreversal_get($res, 81 );
dpaymentssdk_ptechreversal_set($res, 81, $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_PTechReversal Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 82 );
dpaymentssdk_ptechreversal_set($res, 82, $value );

Possible Values

PTECHREVERSAL_SSLCERTSTORETYPE_USER(0), 
PTECHREVERSAL_SSLCERTSTORETYPE_MACHINE(1), 
PTECHREVERSAL_SSLCERTSTORETYPE_PFXFILE(2), 
PTECHREVERSAL_SSLCERTSTORETYPE_PFXBLOB(3), 
PTECHREVERSAL_SSLCERTSTORETYPE_JKSFILE(4), 
PTECHREVERSAL_SSLCERTSTORETYPE_JKSBLOB(5), 
PTECHREVERSAL_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
PTECHREVERSAL_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
PTECHREVERSAL_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
PTECHREVERSAL_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
PTECHREVERSAL_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
PTECHREVERSAL_SSLCERTSTORETYPE_P7BFILE(11), 
PTECHREVERSAL_SSLCERTSTORETYPE_P7BBLOB(12), 
PTECHREVERSAL_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
PTECHREVERSAL_SSLCERTSTORETYPE_PPKFILE(14), 
PTECHREVERSAL_SSLCERTSTORETYPE_PPKBLOB(15), 
PTECHREVERSAL_SSLCERTSTORETYPE_XMLFILE(16), 
PTECHREVERSAL_SSLCERTSTORETYPE_XMLBLOB(17), 
PTECHREVERSAL_SSLCERTSTORETYPE_JWKFILE(18), 
PTECHREVERSAL_SSLCERTSTORETYPE_JWKBLOB(19), 
PTECHREVERSAL_SSLCERTSTORETYPE_SECURITY_KEY(20), 
PTECHREVERSAL_SSLCERTSTORETYPE_BCFKSFILE(21), 
PTECHREVERSAL_SSLCERTSTORETYPE_BCFKSBLOB(22), 
PTECHREVERSAL_SSLCERTSTORETYPE_PKCS11(23), 
PTECHREVERSAL_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (DPaymentsSDK_PTechReversal Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 83 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_PTechReversal Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 84 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (DPaymentsSDK_PTechReversal Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 85 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (DPaymentsSDK_PTechReversal Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 86 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (DPaymentsSDK_PTechReversal Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 87 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (DPaymentsSDK_PTechReversal Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 88 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (DPaymentsSDK_PTechReversal Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 89 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (DPaymentsSDK_PTechReversal Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 90 );
dpaymentssdk_ptechreversal_set($res, 90, $value );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (DPaymentsSDK_PTechReversal Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 91 );
dpaymentssdk_ptechreversal_set($res, 91, $value );

Default Value

''

Remarks

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

SSLProvider Property (DPaymentsSDK_PTechReversal Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 92 );
dpaymentssdk_ptechreversal_set($res, 92, $value );

Possible Values

PTECHREVERSAL_SSLPROVIDER_AUTOMATIC(0), 
PTECHREVERSAL_SSLPROVIDER_PLATFORM(1), 
PTECHREVERSAL_SSLPROVIDER_INTERNAL(2)

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 as follows:

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

SSLServerCertEffectiveDate Property (DPaymentsSDK_PTechReversal Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 93 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (DPaymentsSDK_PTechReversal Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 94 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (DPaymentsSDK_PTechReversal Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 95 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 96 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 97 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (DPaymentsSDK_PTechReversal Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 98 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (DPaymentsSDK_PTechReversal Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 99 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (DPaymentsSDK_PTechReversal Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 100 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (DPaymentsSDK_PTechReversal Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 101 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (DPaymentsSDK_PTechReversal Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 102 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (DPaymentsSDK_PTechReversal Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 103 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (DPaymentsSDK_PTechReversal Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 104 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (DPaymentsSDK_PTechReversal Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 105 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (DPaymentsSDK_PTechReversal Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 106 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (DPaymentsSDK_PTechReversal Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 107 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (DPaymentsSDK_PTechReversal Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 108 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (DPaymentsSDK_PTechReversal 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 getSSLServerCertStorePassword();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 109 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (DPaymentsSDK_PTechReversal Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 110 );

Possible Values

PTECHREVERSAL_SSLSERVERCERTSTORETYPE_USER(0), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_MACHINE(1), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_PKCS11(23), 
PTECHREVERSAL_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (DPaymentsSDK_PTechReversal Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 111 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (DPaymentsSDK_PTechReversal Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 112 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (DPaymentsSDK_PTechReversal Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 113 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (DPaymentsSDK_PTechReversal Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 114 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (DPaymentsSDK_PTechReversal Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 115 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (DPaymentsSDK_PTechReversal Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 116 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (DPaymentsSDK_PTechReversal Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 117 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (DPaymentsSDK_PTechReversal Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 118 );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (DPaymentsSDK_PTechReversal Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 119 );

Default Value

''

Remarks

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_PTechReversal Class)

Terminal number assigned by Paymentech.

Object Oriented Interface

public function getTerminalNumber();
public function setTerminalNumber($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 120 );
dpaymentssdk_ptechreversal_set($res, 120, $value );

Default Value

''

Remarks

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

Data Type

String

Timeout Property (DPaymentsSDK_PTechReversal Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 121 );
dpaymentssdk_ptechreversal_set($res, 121, $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.

Note: By default, all timeouts are inactivity timeouts, that is, 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

UserId Property (DPaymentsSDK_PTechReversal Class)

UserId for authentication with the NetConnect Server .

Object Oriented Interface

public function getUserId();
public function setUserId($value);

Procedural Interface

dpaymentssdk_ptechreversal_get($res, 122 );
dpaymentssdk_ptechreversal_set($res, 122, $value );

Default Value

''

Remarks

The UserId will be supplied to you by PaymenTech.

Data Type

String

Config Method (DPaymentsSDK_PTechReversal Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Interrupt Method (DPaymentsSDK_PTechReversal Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_ptechreversal_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_PTechReversal Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_ptechreversal_do_reset($res);

Remarks

This method clears all properties to their default values.

Reverse Method (DPaymentsSDK_PTechReversal Class)

Reverses a previously authorized transaction.

Object Oriented Interface

public function doReverse();

Procedural Interface

dpaymentssdk_ptechreversal_do_reverse($res);

Remarks

A Reversal transaction is used to reverse (void) a previously authorized transaction. This transaction is NOT added to the current batch, and the original transaction must be removed from the batch upon receiving a successful response to a Reversal. This method (and this class) is applicable to authorizations sent in both Terminal Capture Mode as well as Host Capture Mode.

A reversal transaction immediately releases funds blocked in the cardholder's open-to-buy by the original authorization. To reverse an authorization, set the CardNumber, CardExpMonth, CardExpYear, IndustryType, and POSRetrievalNumber which were sent in the original transaction. Also indicate the type of the original authorization (Auth-only or Sale) in the OriginalTransactionType property. The OriginalTransactionAmount should be set to the amount originally sent in the TransactionAmount property of the class that authorized the transaction. It does not matter if the amount actually authorized was less, the originally submitted amount must be sent in the OriginalTransactionAmount property.

For example: class.IndustryType = itRetail class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.OriginalTransactionType = ttAuthOnly class.OriginalTransactionAmount = "1.00" class.POSRetrievalNumber = "1234567890" class.Reverse()

DataPacketIn Event (DPaymentsSDK_PTechReversal Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_ptechreversal_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_PTechReversal Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_ptechreversal_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_PTechReversal Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_ptechreversal_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_PTechReversal Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_ptechreversal_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_PTechReversal Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_ptechreversal_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 (PTechReversal Class)

PTechReversal Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (PTechReversal Class)

PTechReversal 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