PTechCharge Class

Properties   Methods   Events   Config Settings   Errors  

The PTechCharge class is used to authorize credit card transactions with the Paymentech NetConnect system on the Tampa platform. This class supports Direct Marketing, e-Commerce, and Retail environments, and allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Class Name

DPaymentsSDK_PTechCharge

Procedural Interface

 dpaymentssdk_ptechcharge_open();
 dpaymentssdk_ptechcharge_close($res);
 dpaymentssdk_ptechcharge_register_callback($res, $id, $function);
 dpaymentssdk_ptechcharge_get_last_error($res);
 dpaymentssdk_ptechcharge_get_last_error_code($res);
 dpaymentssdk_ptechcharge_set($res, $id, $index, $value);
 dpaymentssdk_ptechcharge_get($res, $id, $index);
 dpaymentssdk_ptechcharge_do_authonly($res);
 dpaymentssdk_ptechcharge_do_capture($res, $approvalcode);
 dpaymentssdk_ptechcharge_do_config($res, $configurationstring);
 dpaymentssdk_ptechcharge_do_credit($res);
 dpaymentssdk_ptechcharge_do_getdetailaggregate($res);
 dpaymentssdk_ptechcharge_do_interrupt($res);
 dpaymentssdk_ptechcharge_do_reset($res);
 dpaymentssdk_ptechcharge_do_sale($res);
 dpaymentssdk_ptechcharge_do_voidtransaction($res, $retrievalnumbertovoid, $lastretrievalnumber);

Remarks

Setting up the class and authorizing 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, you may enter transaction data. When the Credit Card's CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. For any other CardEntryDataSource , the CardMagneticStripe property should be filled. In addition, the TransactionAmount should be set with the total amount for the transaction, including any taxes.

Now simply call the Sale or AuthOnly method to send the authorization to the Paymentech Server.

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

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

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

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

CardType Property (DPaymentsSDK_PTechCharge Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 1 );


dpaymentssdk_ptechcharge_set($res, 1, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_PTechCharge Class)

Three digit security code on back of card (optional).

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 2 );


dpaymentssdk_ptechcharge_set($res, 2, $value );

Default Value

''

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_PTechCharge Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 3 );


dpaymentssdk_ptechcharge_set($res, 3, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_PTechCharge Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 4 );


dpaymentssdk_ptechcharge_set($res, 4, $value );

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_PTechCharge Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 5 );


dpaymentssdk_ptechcharge_set($res, 5, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_PTechCharge Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 6 );


dpaymentssdk_ptechcharge_set($res, 6, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_PTechCharge Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface

public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 7 );


dpaymentssdk_ptechcharge_set($res, 7, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 8 );


dpaymentssdk_ptechcharge_set($res, 8, $value );

Default Value

''

Remarks

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

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

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

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_PTechCharge Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 9 );


dpaymentssdk_ptechcharge_set($res, 9, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

ClientNumber Property (DPaymentsSDK_PTechCharge Class)

Merchant configuration property, assigned by Paymentech.

Object Oriented Interface

public function getClientNumber();


public function setClientNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 10 );


dpaymentssdk_ptechcharge_set($res, 10, $value );

Default Value

''

Remarks

The ClientNumber will be supplied to you by Paymentech.

Data Type

String

CustomerAddress Property (DPaymentsSDK_PTechCharge Class)

The customer's billing address.

Object Oriented Interface

public function getCustomerAddress();


public function setCustomerAddress($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 11 );


dpaymentssdk_ptechcharge_set($res, 11, $value );

Default Value

''

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

Data Type

String

CustomerZip Property (DPaymentsSDK_PTechCharge Class)

Customer's zip code (or postal code if outside of the USA).

Object Oriented Interface

public function getCustomerZip();


public function setCustomerZip($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 12 );


dpaymentssdk_ptechcharge_set($res, 12, $value );

Default Value

''

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

Data Type

String

DebitCashBack Property (DPaymentsSDK_PTechCharge Class)

Optional cash back amount for debit transactions.

Object Oriented Interface

public function getDebitCashBack();


public function setDebitCashBack($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 13 );


dpaymentssdk_ptechcharge_set($res, 13, $value );

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

DebitKSN Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getDebitKSN();


public function setDebitKSN($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 14 );


dpaymentssdk_ptechcharge_set($res, 14, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

DebitPIN Property (DPaymentsSDK_PTechCharge Class)

DUKPT DES encrypted PIN block, used for Debit transactions.

Object Oriented Interface

public function getDebitPIN();


public function setDebitPIN($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 15 );


dpaymentssdk_ptechcharge_set($res, 15, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

DuplicateChecking Property (DPaymentsSDK_PTechCharge Class)

Indicates whether duplicate checking is enabled.

Object Oriented Interface

public function getDuplicateChecking();


public function setDuplicateChecking($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 16 );


dpaymentssdk_ptechcharge_set($res, 16, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

ECI Property (DPaymentsSDK_PTechCharge Class)

Electronic Commerce Indicator.

Object Oriented Interface

public function getECI();


public function setECI($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 17 );


dpaymentssdk_ptechcharge_set($res, 17, $value );

Default Value

'7'

Remarks

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

Data Type

String

GoodsIndicator Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getGoodsIndicator();


public function setGoodsIndicator($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 18 );


dpaymentssdk_ptechcharge_set($res, 18, $value );

Default Value

0

Remarks

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

Data Type

Integer

GratuityAmount Property (DPaymentsSDK_PTechCharge Class)

Gratuity amount for restaurant industry transactions.

Object Oriented Interface

public function getGratuityAmount();


public function setGratuityAmount($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 19 );


dpaymentssdk_ptechcharge_set($res, 19, $value );

Default Value

''

Remarks

This property contains the gratuity (tip) amount of the transaction. This property may be set in the PTechCharge class if you know the amount of the tip before the authorization. Otherwise, you may update the GratuityAmount property of the PTechDetailRecord class after parsing the detail aggregate returned from this class's GetDetailAggregate method. This amount is only sent when the PTechManualSettle class's IndustryType is set to "itRestaurant". If a transaction includes a GratuityAmount, the SettlementAmount must reflect the total of the originally authorized amount, plus the GratuityAmount.

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

Data Type

String

IndustryType Property (DPaymentsSDK_PTechCharge Class)

Determines the merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 20 );


dpaymentssdk_ptechcharge_set($res, 20, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

InvoiceNumber Property (DPaymentsSDK_PTechCharge Class)

Merchant-generated invoice number.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 21 );


dpaymentssdk_ptechcharge_set($res, 21, $value );

Default Value

''

Remarks

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

Data Type

String

Level2PurchaseId Property (DPaymentsSDK_PTechCharge Class)

Purchase Identifier for use when sending Level II data.

Object Oriented Interface

public function getLevel2PurchaseId();


public function setLevel2PurchaseId($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 22 );


dpaymentssdk_ptechcharge_set($res, 22, $value );

Default Value

''

Remarks

Purchase Identifier for use when sending Level II data. This property contains a Purchase Identifier (Purchase Order Number or Order Number). The Level2PurchaseId, Level2SalesTax, and Level2ShipToZip properties are used to transmit Level II purchasing card data to the host. If any of these properties contain a value, Level II purchasing data will be sent with the authorization request. If they are all empty, Level II data will not be sent. The maximum length for this property is 17 characters.

Data Type

String

Level2SalesTax Property (DPaymentsSDK_PTechCharge Class)

Sales Tax for use when sending Level II data.

Object Oriented Interface

public function getLevel2SalesTax();


public function setLevel2SalesTax($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 23 );


dpaymentssdk_ptechcharge_set($res, 23, $value );

Default Value

''

Remarks

Sales Tax for use when sending Level II data. This property contains the portion of the TransactionAmount which is sales tax. This amount is presented in US Dollars with a decimal point in the proper position, and has a maximum length of 9 characters. Set this property to "EXEMPT" if the transaction is not taxable. Set it to "0.00" if there is no tax provided.

The Level2PurchaseId, Level2SalesTax, and Level2ShipToZip properties are used to transmit Level II purchasing card data to the host. If any of these properties contain a value, Level II purchasing data will be sent with the authorization request. If they are all empty, Level II data will not be sent.

Data Type

String

Level2ShipToZip Property (DPaymentsSDK_PTechCharge Class)

Destination ZipCode for use when sending Level II data.

Object Oriented Interface

public function getLevel2ShipToZip();


public function setLevel2ShipToZip($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 24 );


dpaymentssdk_ptechcharge_set($res, 24, $value );

Default Value

''

Remarks

Destination ZipCode for use when sending Level II data. This property contains the zip code where the purchased goods are to be shipped. If this is a face-to-face transaction in a retail environment where the customer immediately receives the goods, this property should be the Zip code of the merchant location where the item was purchased.

The Level2PurchaseId, Level2SalesTax, and Level2ShipToZip properties are used to transmit Level II purchasing card data to the host. If any of these properties contain a value, Level II purchasing data will be sent with the authorization request. If they are all empty, Level II data will not be sent.

Data Type

String

MerchantNumber Property (DPaymentsSDK_PTechCharge 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_ptechcharge_get($res, 25 );


dpaymentssdk_ptechcharge_set($res, 25, $value );

Default Value

''

Remarks

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

Data Type

String

Password Property (DPaymentsSDK_PTechCharge Class)

Password for authentication with the NetConnect Server .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 26 );


dpaymentssdk_ptechcharge_set($res, 26, $value );

Default Value

''

Remarks

The Password will be supplied to you by Paymentech.

Data Type

String

PINCapability Property (DPaymentsSDK_PTechCharge Class)

Indicates if the terminal device supports a PIN pad.

Object Oriented Interface

public function getPINCapability();


public function setPINCapability($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 27 );


dpaymentssdk_ptechcharge_set($res, 27, $value );

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

Merchant-generated reference number, used for reversals.

Object Oriented Interface

public function getPOSRetrievalNumber();


public function setPOSRetrievalNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 28 );


dpaymentssdk_ptechcharge_set($res, 28, $value );

Default Value

''

Remarks

This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the PTechReversal class to reverse an authorization or sale.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 29 );


dpaymentssdk_ptechcharge_set($res, 29, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

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

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

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

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

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

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 30 );


dpaymentssdk_ptechcharge_set($res, 30, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 31 );


dpaymentssdk_ptechcharge_set($res, 31, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 32 );


dpaymentssdk_ptechcharge_set($res, 32, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_PTechCharge 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_ptechcharge_get($res, 33 );


dpaymentssdk_ptechcharge_set($res, 33, $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_PTechCharge Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 34 );


dpaymentssdk_ptechcharge_set($res, 34, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (DPaymentsSDK_PTechCharge Class)

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 35 );


dpaymentssdk_ptechcharge_set($res, 35, $value );

Default Value

''

Remarks

This property contains a user name, if authentication is to be used for the proxy.

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

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

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

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 36 );

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

Used for partial authorizations.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 37 );

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

Indicates the source of the authorization code stored in ApprovalCode .

Object Oriented Interface

public function getResponseAuthSource();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 38 );

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

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 39 );

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_PTechCharge 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_ptechcharge_get($res, 40 );

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

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

Object Oriented Interface

public function getResponseCardLevel();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 41 );

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

Type of the credit card.

Object Oriented Interface

public function getResponseCardType();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 42 );

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

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 43 );

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

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 44 );

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

Additional fee charged for debit transactions.

Object Oriented Interface

public function getResponseDebitSurcharge();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 45 );

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

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

Object Oriented Interface

public function getResponseDebitTrace();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 46 );

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

Authorizing network Identifier which indicates which network approved this transaction.

Object Oriented Interface

public function getResponseNetworkId();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 47 );

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

Reference number returned from the Paymentech host.

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 48 );

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

SequenceNumber echoed from the authorization.

Object Oriented Interface

public function getResponseSequenceNumber();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 49 );

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_PTechCharge 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_ptechcharge_get($res, 50 );

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_PTechCharge 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_ptechcharge_get($res, 51 );

Default Value

''

Remarks

This 15-character property contains the Transaction Identifier assigned by the card issuer or network. Transaction Identifier is used to link subsequent MIT transactions to an original CIT transaction.

Note: Merchants are responsible for retaining the response TransactionId from the original transaction and submitting the TransactionId in subsequent MIT transactions.

This property is read-only.

Data Type

String

SequenceNumber Property (DPaymentsSDK_PTechCharge Class)

Sequence number of the transaction.

Object Oriented Interface

public function getSequenceNumber();


public function setSequenceNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 52 );


dpaymentssdk_ptechcharge_set($res, 52, $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_PTechCharge Class)

The URL for the PaymenTech NetConnect server.

Object Oriented Interface

public function getServer();


public function setServer($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 53 );


dpaymentssdk_ptechcharge_set($res, 53, $value );

Default Value

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

Remarks

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

Data Type

String

ServerNumber Property (DPaymentsSDK_PTechCharge Class)

Used for restaurant transactions: Id number of the server (waiter/waitress) making the transaction.

Object Oriented Interface

public function getServerNumber();


public function setServerNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 54 );


dpaymentssdk_ptechcharge_set($res, 54, $value );

Default Value

''

Remarks

Each server should have his or her own unique Id number.

Data Type

String

SettlementMode Property (DPaymentsSDK_PTechCharge Class)

Indicates whether the class uses Paymentech's Host Capture (0) or Terminal Capture (1) system.

Object Oriented Interface

public function getSettlementMode();


public function setSettlementMode($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 55 );


dpaymentssdk_ptechcharge_set($res, 55, $value );

Default Value

0

Remarks

Host-Capture means that you authorize your transactions using the AuthOnly or Sale methods, and you process refunds and capture outstanding authorizations with the Credit and Capture methods. Paymentech handles all batch management. All you need to do is use the PTechHostSettle class to release the batch for settlement (you may even set your account up for Host Auto-Close, which will automatically release the batch for settlement at the end of the business day).

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging and Restaurant IndustryTypes, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a restaurant authorization may have a GratuityAmount added to the original charge before the transaction is settled. Likewise, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types supported by PTechCharge may be processed in smTerminalCapture mode. However, Restaurant and Hotel transactions MUST be authorized and settled in smTerminalCapture mode. Attempting to authorize a Restaurant or Hotel/Lodging transaction with the SettlementMode set to smHostCapture will cause the class fails with an error.

When processing transactions in smTerminalCapture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle classs. Attempting to call the VoidTransaction or Capture methods will cause the class fails with an error.

Data Type

Integer

SSLAcceptServerCertEncoded Property (DPaymentsSDK_PTechCharge Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 57 );


dpaymentssdk_ptechcharge_set($res, 57, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_PTechCharge Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 85 );


dpaymentssdk_ptechcharge_set($res, 85, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 101 );


dpaymentssdk_ptechcharge_set($res, 101, $value );

Default Value

'MY'

Remarks

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

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

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_PTechCharge 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_ptechcharge_get($res, 102 );


dpaymentssdk_ptechcharge_set($res, 102, $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_PTechCharge Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 103 );


dpaymentssdk_ptechcharge_set($res, 103, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_PTechCharge Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 104 );


dpaymentssdk_ptechcharge_set($res, 104, $value );

Default Value

''

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

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

Data Type

String

SSLProvider Property (DPaymentsSDK_PTechCharge Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 112 );


dpaymentssdk_ptechcharge_set($res, 112, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_PTechCharge Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 114 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

TerminalNumber Property (DPaymentsSDK_PTechCharge Class)

Terminal number assigned by Paymentech.

Object Oriented Interface

public function getTerminalNumber();


public function setTerminalNumber($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 141 );


dpaymentssdk_ptechcharge_set($res, 141, $value );

Default Value

''

Remarks

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

Data Type

String

Timeout Property (DPaymentsSDK_PTechCharge Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 142 );


dpaymentssdk_ptechcharge_set($res, 142, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransactionAmount Property (DPaymentsSDK_PTechCharge Class)

Purchase amount for an authorization.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 143 );


dpaymentssdk_ptechcharge_set($res, 143, $value );

Default Value

''

Remarks

This field contains the transaction amount to be authorized. The transaction amount is presented in US Dollars with a decimal point in the proper position. If sending a Debit transaction and the customer requests cash back, the TransactionAmount must include the total cost of the purchase, PLUS the DebitCashBack amount.

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

Data Type

String

UserId Property (DPaymentsSDK_PTechCharge Class)

UserId for authentication with the NetConnect Server .

Object Oriented Interface

public function getUserId();


public function setUserId($value);

Procedural Interface

dpaymentssdk_ptechcharge_get($res, 144 );


dpaymentssdk_ptechcharge_set($res, 144, $value );

Default Value

''

Remarks

The UserId will be supplied to you by PaymenTech.

Data Type

String

AuthOnly Method (DPaymentsSDK_PTechCharge Class)

Sends an AuthOnly transaction to the host.

Object Oriented Interface

public function doAuthOnly();

Procedural Interface

dpaymentssdk_ptechcharge_do_authonly($res);

Remarks

An Auth Only transaction is used to verify and reserve the cardholder's open-to-buy funds available at that time. This transaction is NOT added to the open batch. In order to settle (be paid) for this transaction, the merchant must run a Capture transaction using the original ResponseApprovalCode obtained during this Auth Only transaction. This will add the transaction to the batch. The funds may then be captured by settling the batch with the BatchRelease method. Typically any funds blocked with a Sale or Auth Only transaction are reserved for approximately seven (7) to ten (10) days. This may vary from issuer to issuer. Sample transactions follow.

E-Commerce AuthOnly transaction: class.IndustryType = itECommerce class.CardEntryDataSource = dsManuallyEntered class.GoodsIndicator = giPhysicalGoods class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.CustomerAddress = "123 Nowhere Ln." ' optional AVS data class.CustomerZip = "90210" ' optional AVS data class.TransactionAmount = "1.00" class.InvoiceNumber = "1234" class.AuthOnly()

Retail AuthOnly transaction: class.IndustryType = itRetail class.CardEntryDataSource = dsTrack1 class.CardMagneticStripe = "B4788250000028291^PAYMENTECH^05121015432112345678" class.TransactionAmount = "1.00" class.AuthOnly()

Retail manually keyed AuthOnly transaction: class.IndustryType = itRetail class.CardEntryDataSource = dsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.AuthOnly()

Capture Method (DPaymentsSDK_PTechCharge Class)

Sends a capture transaction to the PaymenTech Server.

Object Oriented Interface

public function doCapture($approvalcode);

Procedural Interface

dpaymentssdk_ptechcharge_do_capture($res, $approvalcode);

Remarks

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

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

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

Config Method (DPaymentsSDK_PTechCharge Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_ptechcharge_do_config($res, $configurationstring);

Remarks

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

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

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

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

Credit Method (DPaymentsSDK_PTechCharge Class)

Credits a cardholder's account or obtains a Return Authorization.

Object Oriented Interface

public function doCredit();

Procedural Interface

dpaymentssdk_ptechcharge_do_credit($res);

Remarks

Also known as a Return, this transaction refunds the cardholder's account. It can be used in both Host Capture and Terminal Capture SettlementModes.

If you are using the Host Capture SettlementMode, the Credit method will send a Return request to Paymentech. Paymentech will treat the request as an online purchase return authorization if the online return functionality is available for the given card brand and merchant. In this case an authorization request is sent to the card brand and if the authorization is successful the transaction is automatically included in the current batch for settlement. If that functionality is not available the request will be handled as an off-line credit request and will be included in the batch for settlement without requesting an authorization first.

If you are using the Terminal Capture SettlementMode, the Credit method can only be used for online purchase return authorization requests when such functionality is available for the given card and merchant. It cannot be used for off-line credit transactions. When using the Credit method in Terminal Capture mode you will need to get the authorization response and include the transaction in the batch to be settled using the PTechManualSettle class.

Manually keyed credit: class.CardNumber = "4444333322221111" class.CardExpMonth = 12 class.CardExpYear = 2025 class.CardEntryDataSource = dsManuallyEntered class.TransactionAmount = "1.00" 'credits $1.00 class.Credit()

GetDetailAggregate Method (DPaymentsSDK_PTechCharge Class)

Returns an aggregate containing details of this transaction, which is then used for manual settlement.

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_ptechcharge_do_getdetailaggregate($res);

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This is only used when processing on the Terminal Capture System (TCS) and using the PTechManualSettle class Generally, you will only use detail aggregates and manual settlements for the Hotel and Restaurant IndustryTypes.

This aggregate must be passed to the PTechManualSettle class's DetailRecords array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or extra hotel charges for instance), you may use the PTechDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

PTechCharge.Sale(); PTechManualSettle.DetailRecords[0] = PTechCharge.GetDetailAggregate();

Interrupt Method (DPaymentsSDK_PTechCharge Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_ptechcharge_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_PTechCharge Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_ptechcharge_do_reset($res);

Remarks

This method clears all properties to their default values.

Sale Method (DPaymentsSDK_PTechCharge Class)

Sends a Sale transaction to the host.

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_ptechcharge_do_sale($res);

Remarks

A basic sale transaction. This transaction decrements the cardholder's open-to-buy funds for the sale amount. This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the PTechHostSettle class. Sample transactions follow.

E-Commerce Sale transaction: class.IndustryType = itECommerce class.GoodsIndicator = giPhysicalGoods class.CardEntryDataSource = dsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.CustomerAddress = "123 Nowhere Ln." ' optional AVS data class.CustomerZip = "90210" ' optional AVS data class.TransactionAmount = "1.00" class.Sale()

Retail Sale transaction: class.IndustryType = itRetail class.CardEntryDataSource = dsTrack1 class.CardMagneticStripe = "B4788250000028291^PAYMENTECH^05121015432112345678" class.TransactionAmount = "1.00" class.Sale()

Retail manually keyed Sale transaction: class.IndustryType = itRetail class.CardEntryDataSource = dsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.Sale()

VoidTransaction Method (DPaymentsSDK_PTechCharge Class)

Voids a transaction in the current batch.

Object Oriented Interface

public function doVoidTransaction($retrievalnumbertovoid, $lastretrievalnumber);

Procedural Interface

dpaymentssdk_ptechcharge_do_voidtransaction($res, $retrievalnumbertovoid, $lastretrievalnumber);

Remarks

This method voids a previously authorized transaction. A transaction can only be voided if it exists in the current open batch. If the batch that contained the target transaction has already been released (settled), you must use the Credit method instead.

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

Before sending a void, you must make sure that the CardNumber property contains the card number from the original transaction. Also note that since AuthOnly transactions are not added to the current batch, they cannot be voided. Examples follow.

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

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

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

DataPacketIn Event (DPaymentsSDK_PTechCharge Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_ptechcharge_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_PTechCharge Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_ptechcharge_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_PTechCharge Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_ptechcharge_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_PTechCharge Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (PTechCharge Class)

PTechCharge Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (PTechCharge Class)

PTechCharge Errors

Paymentech Server Errors:

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

Paymentech Issuer Errors

Paymentech Format Errors

Paymentech Host / Setup Errors

Paymentech Debit / EBT Specific Errors

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

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors