PTechBenefit Class

Properties   Methods   Events   Config Settings   Errors  

The PTechBenefit class is used to authorize Electronic Benefits Transfer (EBT) transactions with the Paymentech NetConnect system on the Tampa platform. An EBT transaction is similar to a Debit transaction, using a PIN and Trace number, but is used for Food Stamp or Cash Benefit programs. This class allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection.

Class Name

DPaymentsSDK_PTechBenefit

Procedural Interface

 dpaymentssdk_ptechbenefit_open();
 dpaymentssdk_ptechbenefit_close($res);
 dpaymentssdk_ptechbenefit_register_callback($res, $id, $function);
 dpaymentssdk_ptechbenefit_get_last_error($res);
 dpaymentssdk_ptechbenefit_get_last_error_code($res);
 dpaymentssdk_ptechbenefit_set($res, $id, $index, $value);
 dpaymentssdk_ptechbenefit_get($res, $id, $index);
 dpaymentssdk_ptechbenefit_do_balanceinquiry($res);
 dpaymentssdk_ptechbenefit_do_config($res, $configurationstring);
 dpaymentssdk_ptechbenefit_do_credit($res);
 dpaymentssdk_ptechbenefit_do_force($res, $voiceauthcode, $vouchernum);
 dpaymentssdk_ptechbenefit_do_interrupt($res);
 dpaymentssdk_ptechbenefit_do_reset($res);
 dpaymentssdk_ptechbenefit_do_sale($res);

Remarks

An EBT Card (also known as Cash Benefit Card or Food Stamps) works similar to a bank debit card. EBT is a special application of electronic funds transfer (EFT), or debit card technology, which takes money directly from one account and transfers it to another (credit cards, by comparison, simply record a sale for payment later).

There are just a few steps to setting up the class and sending transactions. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service.

After the merchant information is setup, you may enter transaction data. Under normal circumstances, Track2 data should be read from the credit card and placed in the CardMagneticStripe. The CardEntryDataSource should be set to dsTrack2, and the CardPIN and CardKSN should be filled with the encrypted PIN and key sequence number returned by your PIN pad. If the card reader is unable to read the magnetic stripe, card info may be manually added in the CardNumber, CardExpMonth, and CardExpYear properties. In this case, the CardEntryDataSource must be set to dsManuallyKeyed. These are the only two CardEntryDataSources supported for EBT cards.

Now simply set the TransactionAmount and call the Sale method to charge the card. You may also Credit funds back to the card (Food Stamp BenefitType only), as well as send a BalanceInquiry. Voice authorizations may be sent using the Force method.

The status of any of the above transactions will be stored in the ResponseCode property, with human-readable text appearing in ResponseText. Like the PTechCharge class, there are several other Response properties which will contain data that should be logged.

EBT regulations require that all customer receipts include the last 4 digits of the CardNumber and the ResponseTrace number, as well as the available balance for the account accessed. Balances are returned in the ResponseAvailableBalance and ResponseCashAvailableBalance properties. Additional Response balance properties contain extra information which the merchant may optionally include.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

BenefitType Property (DPaymentsSDK_PTechBenefit Class)

Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.

Object Oriented Interface

public function getBenefitType();


public function setBenefitType($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 1 );


dpaymentssdk_ptechbenefit_set($res, 1, $value );

Default Value

0

Remarks

Available Benefit Types include:

Data Type

Integer

CardType Property (DPaymentsSDK_PTechBenefit Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 2 );


dpaymentssdk_ptechbenefit_set($res, 2, $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_PTechBenefit Class)

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

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 3 );


dpaymentssdk_ptechbenefit_set($res, 3, $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_PTechBenefit Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 4 );


dpaymentssdk_ptechbenefit_set($res, 4, $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_PTechBenefit 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_ptechbenefit_get($res, 5 );


dpaymentssdk_ptechbenefit_set($res, 5, $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_PTechBenefit Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 6 );


dpaymentssdk_ptechbenefit_set($res, 6, $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_PTechBenefit Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 7 );


dpaymentssdk_ptechbenefit_set($res, 7, $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_PTechBenefit 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_ptechbenefit_get($res, 8 );


dpaymentssdk_ptechbenefit_set($res, 8, $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_PTechBenefit Class)

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

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 9 );


dpaymentssdk_ptechbenefit_set($res, 9, $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_PTechBenefit Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 10 );


dpaymentssdk_ptechbenefit_set($res, 10, $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

CardKSN Property (DPaymentsSDK_PTechBenefit Class)

Clear-text Key Sequence Number that is associated with the CardPIN .

Object Oriented Interface

public function getCardKSN();


public function setCardKSN($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 11 );


dpaymentssdk_ptechbenefit_set($res, 11, $value );

Default Value

''

Remarks

The value of this property must be retrieved from a certified PIN pad device. This property is mandatory for all EBT transactions. The maximum length is 16 characters.

Sample usage: class.CardEntryDataSource = dsTrack2 class.CardMagneticStripe = "9999999800002773=28121015432112345678" class.CardPIN = "623F36B53CC18393" class.CardKSN = "000000008F000021" class.BenefitType = btCashBenefits class.TransactionAmount = "25.00" '$20 purchase with $5 cash back class.CashBack = "5.00" class.Sale()

Data Type

String

CardPIN Property (DPaymentsSDK_PTechBenefit Class)

DUKPT DES encrypted PIN block.

Object Oriented Interface

public function getCardPIN();


public function setCardPIN($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 12 );


dpaymentssdk_ptechbenefit_set($res, 12, $value );

Default Value

''

Remarks

The value of this property must be retrieved from a certified PIN pad device. This property is mandatory for all EBT transactions. The maximum length is 16 characters.

Sample usage: class.CardEntryDataSource = dsTrack2 class.CardMagneticStripe = "9999999800002773=28121015432112345678" class.CardPIN = "623F36B53CC18393" class.CardKSN = "000000008F000021" class.BenefitType = btCashBenefits class.TransactionAmount = "25.00" '$20 purchase with $5 cash back class.CashBack = "5.00" class.Sale()

Data Type

String

CashBack Property (DPaymentsSDK_PTechBenefit Class)

Optional cash back amount for debit transactions.

Object Oriented Interface

public function getCashBack();


public function setCashBack($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 13 );


dpaymentssdk_ptechbenefit_set($res, 13, $value );

Default Value

''

Remarks

This property may contain an optional cash back amount when authorizing an EBT card that is of BenefitType btCashBenefits. CashBack may NOT be set for Food Stamp cards. When CashBack is requested, the value of the TransactionAmount must reflect the cost of the goods or service purchased plus this CashBack 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".

For example: class.CardEntryDataSource = dsTrack2 class.CardMagneticStripe = "9999999800002773=28121015432112345678" class.CardPIN = "623F36B53CC18393" class.CardKSN = "000000008F000021" class.BenefitType = btCashBenefits class.TransactionAmount = "25.00" '$20 purchase with $5 cash back class.CashBack = "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

ClientNumber Property (DPaymentsSDK_PTechBenefit Class)

Merchant configuration property, assigned by Paymentech.

Object Oriented Interface

public function getClientNumber();


public function setClientNumber($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 14 );


dpaymentssdk_ptechbenefit_set($res, 14, $value );

Default Value

''

Remarks

The ClientNumber will be supplied to you by Paymentech.

Data Type

String

DuplicateChecking Property (DPaymentsSDK_PTechBenefit Class)

Indicates whether duplicate checking is enabled.

Object Oriented Interface

public function getDuplicateChecking();


public function setDuplicateChecking($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 15 );


dpaymentssdk_ptechbenefit_set($res, 15, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

IndustryType Property (DPaymentsSDK_PTechBenefit Class)

Determines the merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 16 );


dpaymentssdk_ptechbenefit_set($res, 16, $value );

Default Value

0

Remarks

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

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

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

Data Type

Integer

MerchantNumber Property (DPaymentsSDK_PTechBenefit 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_ptechbenefit_get($res, 17 );


dpaymentssdk_ptechbenefit_set($res, 17, $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_PTechBenefit Class)

Password for authentication with the NetConnect Server .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 18 );


dpaymentssdk_ptechbenefit_set($res, 18, $value );

Default Value

''

Remarks

The Password will be supplied to you by Paymentech.

Data Type

String

POSRetrievalNumber Property (DPaymentsSDK_PTechBenefit Class)

Merchant-generated reference number, used for reversals.

Object Oriented Interface

public function getPOSRetrievalNumber();


public function setPOSRetrievalNumber($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 19 );


dpaymentssdk_ptechbenefit_set($res, 19, $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_PTechBenefit 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_ptechbenefit_get($res, 20 );


dpaymentssdk_ptechbenefit_set($res, 20, $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_PTechBenefit 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_ptechbenefit_get($res, 21 );


dpaymentssdk_ptechbenefit_set($res, 21, $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_PTechBenefit 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_ptechbenefit_get($res, 22 );


dpaymentssdk_ptechbenefit_set($res, 22, $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_PTechBenefit 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_ptechbenefit_get($res, 23 );


dpaymentssdk_ptechbenefit_set($res, 23, $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_PTechBenefit 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_ptechbenefit_get($res, 24 );


dpaymentssdk_ptechbenefit_set($res, 24, $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_PTechBenefit 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_ptechbenefit_get($res, 25 );


dpaymentssdk_ptechbenefit_set($res, 25, $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_PTechBenefit Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 26 );


dpaymentssdk_ptechbenefit_set($res, 26, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_PTechBenefit Class)

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

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 27 );

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

ResponseAvailableBalance Property (DPaymentsSDK_PTechBenefit Class)

Current card balance, including all pending transactions.

Object Oriented Interface

public function getResponseAvailableBalance();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 28 );

Default Value

''

Remarks

Current card balance, including all pending transactions. The available balance is the current Ledger balance, less any holds (due to authorizations), plus any credits or deposits and minus withdrawals, that are all part of the day's activity. If present, this value must be printed on the customer's receipt. If not present, the ResponseLedgerBalance should be printed instead (print "Balance Unavailable" if neither are returned in the response).

This property is read-only.

Data Type

String

ResponseBatchNumber Property (DPaymentsSDK_PTechBenefit 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_ptechbenefit_get($res, 29 );

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

ResponseBeginningBalance Property (DPaymentsSDK_PTechBenefit Class)

Beginning balance of the EBT account.

Object Oriented Interface

public function getResponseBeginningBalance();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 30 );

Default Value

''

Remarks

Beginning balance of the EBT account. This field indicates what the beginning balance that was deposited into the EBT account for the current period.

This property is read-only.

Data Type

String

ResponseCashAvailableBalance Property (DPaymentsSDK_PTechBenefit Class)

Available cash balance on the EBT card.

Object Oriented Interface

public function getResponseCashAvailableBalance();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 31 );

Default Value

''

Remarks

Available cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the ResponseAvailableBalance indicates the available balance in the Food Stamp account, and this property indicates the available balance in the Cash Benefit account.

This property is read-only.

Data Type

String

ResponseCashBeginningBalance Property (DPaymentsSDK_PTechBenefit Class)

Beginning cash balance on the EBT card.

Object Oriented Interface

public function getResponseCashBeginningBalance();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 32 );

Default Value

''

Remarks

Beginning cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the ResponseBeginningBalance indicates the beginning balance in the Food Stamp account, and this field indicates the beginning balance in the Cash Benefit account.

This property is read-only.

Data Type

String

ResponseCashLedgerBalance Property (DPaymentsSDK_PTechBenefit Class)

Ledger (Current) cash balance on the EBT card.

Object Oriented Interface

public function getResponseCashLedgerBalance();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 33 );

Default Value

''

Remarks

Ledger (Current) cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the ResponseLedgerBalance indicates the current balance in the Food Stamp account, and this field indicates the available balance in the Cash Benefit account.

This property is read-only.

Data Type

String

ResponseCode Property (DPaymentsSDK_PTechBenefit Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 34 );

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

ResponseLedgerBalance Property (DPaymentsSDK_PTechBenefit Class)

Current balance of the EBT card, not including pending authorizations.

Object Oriented Interface

public function getResponseLedgerBalance();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 35 );

Default Value

''

Remarks

Current balance of the EBT card, not including pending authorizations. The Ledger, or Current balance indicates the actual balance of the EBT card on a specific day, and does not reflect any holds or pending transactions that have not yet been settled. If no ResponseAvailableBalance was returned in the response, this ResponseLedgerBalance should be printed on the receipt instead (if neither are returned, print "Balance Unavailable").

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (DPaymentsSDK_PTechBenefit Class)

Reference number returned from the Paymentech host.

Object Oriented Interface

public function getResponseRetrievalNumber();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 36 );

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

SequenceNumber echoed from the authorization.

Object Oriented Interface

public function getResponseSequenceNumber();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 37 );

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_PTechBenefit 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_ptechbenefit_get($res, 38 );

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

ResponseTrace Property (DPaymentsSDK_PTechBenefit Class)

Trace number returned for EBT transactions.

Object Oriented Interface

public function getResponseTrace();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 39 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SequenceNumber Property (DPaymentsSDK_PTechBenefit Class)

Sequence number of the transaction.

Object Oriented Interface

public function getSequenceNumber();


public function setSequenceNumber($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 40 );


dpaymentssdk_ptechbenefit_set($res, 40, $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_PTechBenefit Class)

The URL for the PaymenTech NetConnect server.

Object Oriented Interface

public function getServer();


public function setServer($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 41 );


dpaymentssdk_ptechbenefit_set($res, 41, $value );

Default Value

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

Remarks

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_PTechBenefit Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 43 );


dpaymentssdk_ptechbenefit_set($res, 43, $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_PTechBenefit Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 71 );


dpaymentssdk_ptechbenefit_set($res, 71, $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_PTechBenefit 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_ptechbenefit_get($res, 87 );


dpaymentssdk_ptechbenefit_set($res, 87, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_PTechBenefit 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_ptechbenefit_get($res, 88 );


dpaymentssdk_ptechbenefit_set($res, 88, $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_PTechBenefit Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 89 );


dpaymentssdk_ptechbenefit_set($res, 89, $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_PTechBenefit 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_ptechbenefit_get($res, 90 );


dpaymentssdk_ptechbenefit_set($res, 90, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DPaymentsSDK_PTechBenefit Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 98 );


dpaymentssdk_ptechbenefit_set($res, 98, $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_PTechBenefit Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 100 );

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

Terminal number assigned by Paymentech.

Object Oriented Interface

public function getTerminalNumber();


public function setTerminalNumber($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 127 );


dpaymentssdk_ptechbenefit_set($res, 127, $value );

Default Value

''

Remarks

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

Data Type

String

Timeout Property (DPaymentsSDK_PTechBenefit Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 128 );


dpaymentssdk_ptechbenefit_set($res, 128, $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_PTechBenefit Class)

Purchase amount for an authorization.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 129 );


dpaymentssdk_ptechbenefit_set($res, 129, $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_PTechBenefit Class)

UserId for authentication with the NetConnect Server .

Object Oriented Interface

public function getUserId();


public function setUserId($value);

Procedural Interface

dpaymentssdk_ptechbenefit_get($res, 130 );


dpaymentssdk_ptechbenefit_set($res, 130, $value );

Default Value

''

Remarks

The UserId will be supplied to you by PaymenTech.

Data Type

String

BalanceInquiry Method (DPaymentsSDK_PTechBenefit Class)

Retrieves the balance remaining on an EBT card.

Object Oriented Interface

public function doBalanceInquiry();

Procedural Interface

dpaymentssdk_ptechbenefit_do_balanceinquiry($res);

Remarks

A BalanceInquiry transaction requests that the host return the quantity of funds remaining in the customer's EBT Card. This transaction is not added to the batch and cannot be settled by the PTechHostSettle class. No charge is made to the customer's EBT card.

The EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful.

The ResponseAvailableBalance and/or ResponseLedgerBalance, properties will contain the card's current balance. Additional balance information may be returned in the ResponseBeginningBalance. If the BenefitType is "Cash Benefits" the ResponseCashAvailableBalance, ResponseCashBeginningBalance, and ResponseCashLedgerBalance may also contain information (these properties are not filled for the "Food Stamp" BenefitType).

Config Method (DPaymentsSDK_PTechBenefit Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_ptechbenefit_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_PTechBenefit Class)

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

Object Oriented Interface

public function doCredit();

Procedural Interface

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

Note: Credits are not supported for EBT cards that are of the "Cash Benefits" BenefitType.

The EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful.

Force Method (DPaymentsSDK_PTechBenefit Class)

Sends a Force (Prior) transaction to the PaymenTech server.

Object Oriented Interface

public function doForce($voiceauthcode, $vouchernum);

Procedural Interface

dpaymentssdk_ptechbenefit_do_force($res, $voiceauthcode, $vouchernum);

Remarks

Force (Prior) transactions are typically used when a customer's EBT card was declined or referred, and the merchant has called the call center to receive an authorization code and voucher number. A Force 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 EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful.

Manually keyed force: class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.Force("123456", "543210987654321") 'values received from the call center

Interrupt Method (DPaymentsSDK_PTechBenefit Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_ptechbenefit_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_PTechBenefit Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_ptechbenefit_do_reset($res);

Remarks

This method clears all properties to their default values.

Sale Method (DPaymentsSDK_PTechBenefit Class)

Sends a Sale transaction to the host.

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_ptechbenefit_do_sale($res);

Remarks

A basic EBT sale transaction is similar to a Debit transaction, in that a CardPIN and CardKSN are required in addition to swiped or manually entered Card data. A Sale transaction removes funds from the EBT cardholder's account for the TransactionAmount indicated. This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the PTechHostSettle class.

The EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful. For example:

Manually-keyed Cash Benefits transaction with cash back: class.CardEntryDataSource = dsManuallyEntered class.CardNumber = "9999999800002773" class.CardExpMonth = 12 class.CardExpYear = 2028 class.CardPIN = "623F36B53CC18393" class.CardKSN = "000000008F000021" class.BenefitType = btCashBenefits class.TransactionAmount = "25.00" '$20 purchase with $5 cash back class.CashBack = "5.00" class.Sale()

Swiped Food Stamp transaction: class.CardEntryDataSource = dsTrack2 class.CardMagneticStripe = "9999999800002773=28121015432112345678" class.CardPIN = "623F36B53CC18393" class.CardKSN = "000000008F000021" class.BenefitType = btFoodStamps class.TransactionAmount = "25.00" 'Cash back not supported for food stamps! class.Sale()

DataPacketIn Event (DPaymentsSDK_PTechBenefit Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_ptechbenefit_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_PTechBenefit Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_ptechbenefit_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_PTechBenefit Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_ptechbenefit_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_PTechBenefit Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_ptechbenefit_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_PTechBenefit Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_ptechbenefit_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 (PTechBenefit Class)

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

PTechBenefit 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