PTechDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

The PTechDetailRecord class is a tool used to create off-line Credit or Force transactions to be settled by the PTECHMANUALSETTLE class. The PTDetailRecord class may also be used to modify the XML aggregates returned by the PTECHCHARGE class's GetDetailAggregate method.

Class Name

DPaymentsSDK_PTechDetailRecord

Procedural Interface

 dpaymentssdk_ptechdetailrecord_open();
 dpaymentssdk_ptechdetailrecord_close($res);
 dpaymentssdk_ptechdetailrecord_register_callback($res, $id, $function);
 dpaymentssdk_ptechdetailrecord_get_last_error($res);
 dpaymentssdk_ptechdetailrecord_get_last_error_code($res);
 dpaymentssdk_ptechdetailrecord_set($res, $id, $index, $value);
 dpaymentssdk_ptechdetailrecord_get($res, $id, $index);
 dpaymentssdk_ptechdetailrecord_do_config($res, $configurationstring);
 dpaymentssdk_ptechdetailrecord_do_getdetailaggregate($res);
 dpaymentssdk_ptechdetailrecord_do_parseaggregate($res, $aggregate);
 dpaymentssdk_ptechdetailrecord_do_reset($res);

Remarks

Credit and voice-authorization Capture transactions are off-line transactions. This means that there is no authorization of funds using the PTechCharge class. Instead, you must manually add these transactions to the settlement batch. The PTDetailRecord class can be used to create these transactions, which can then be added to the PTechManualSettle class's DetailRecords property.

To create a Credit, first set the TransactionType to dttCredit, and then set the IndustryType and EntryDataSource Next, set the Card, SettlementAmount, and the current TransactionDate and TransactionTime.

Since this is an off-line transaction, the SequenceNumber may be any value (except 0), and need not reflect the next available sequence number used for authorizations. Finally, set the PTechManualSettle class's DetailRecords array property with the value returned by the GetDetailAggregate method. You've just added a Credit to the settlement.

Voice authorization Capture transactions are similar to credits, with the exception that it requires a Voice Authorization code obtained from your acquiring bank's call center. Generally, the purchase of large high-dollar items (cars, appliances, etc) will require the merchant to call and receive a voice authorization. Once this code is received, it should be set to the ApprovalCode property. The following example shows a Force transaction in a Retail environment.

In addition to creating Credit and Force transactions, the PTechDetailRecord class can be used to adjust the Detail Records returned from the PTechCharge class to reflect changes in the SettlementAmount. The most common reasons to modify these detail records are to add a GratuityAmount (tip) to a charge (itResturant IndustryType), or to add additional charges for the itHotel IndustryType. Note that when the SettlementAmount differs from the original authorized amount, the AmountStatus must be updated to asAmountChanged.

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.

AmountStatus Property (DPaymentsSDK_PTechDetailRecord Class)

Indicates whether SettlementAmount has been modified from the original authorization.

Object Oriented Interface

public function getAmountStatus();


public function setAmountStatus($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 1 );


dpaymentssdk_ptechdetailrecord_set($res, 1, $value );

Default Value

0

Remarks

Notes for the Hotel IndustryType:

To obtain the best interchange rate for Visa transactions in the Hotel IndustryType, the check out amount (SettlementAmount) must be within 15% of the original authorization amount. If the SettlementAmount is less than the original authorized amount by more than 15%, you must perform an authorization reversal using the PTechReversal class. This will immediately release funds from the cardholder's open to buy amount. The original transaction must then be settled for the new amount as usual. However, if the SettlementAmount exceeds the original authorized amount by more than 15%, you must submit an incremental authorization to make up the remaining amount. In this case even though there are two separate transactions, they are tied together with the same authorization code. Therefore, only the original authorization (with the newly updated SettlementAmount) is to be sent in the settlement.

Non-Visa transactions do not allow for Incrementals to tie transactions together, nor Reversals to release funds from the cardholder's open to buy amount. There are no restrictions on the difference between the SettlementAmount and the original authorization amount. However, if the merchant suspects that the final transaction amount will be substantially higher than the original authorization amount, the merchant should perform an additional authorization for the difference. This subsequent authorization must be sent to the host as a standard authorization-only transaction, and will not be tied in any way to the original transaction. Both transactions must be present in the settlement.

Notes for the Restaurant IndustryType:

For Visa transactions, to obtain the best interchange rate the SettlementAmount must be within 20% of the authorized amount. The initial authorization must be submitted for the actual transaction amount. It must not be altered to include an additional percentage that accounts for a tip being added before settlement.

The same rule applies to MasterCard transactions, with the exception that MasterCard allows the SettlementAmount to be within 25% of the authorized amount.

There are no rules concerning authorization and settlement amounts for other card types.

This information was accurate at the time this document was written. Please see the Processing and Interchange Guidelines (provided by Paymentech) for updates as well as additional information on interchange rate qualification.

Data Type

Integer

ApprovalCode Property (DPaymentsSDK_PTechDetailRecord Class)

The Approval code returned in the response to the authorization linked to this transaction.

Object Oriented Interface

public function getApprovalCode();


public function setApprovalCode($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 2 );


dpaymentssdk_ptechdetailrecord_set($res, 2, $value );

Default Value

''

Remarks

If this is a Forced transaction, ApprovalCode should contain the voice auth code received from the call center. If this is a Credit (Refund) transaction it should remain empty or be space filled.

Data Type

String

AuthSource Property (DPaymentsSDK_PTechDetailRecord Class)

Indicates the source of the authorization code stored in ApprovalCode .

Object Oriented Interface

public function getAuthSource();


public function setAuthSource($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 3 );


dpaymentssdk_ptechdetailrecord_set($res, 3, $value );

Default Value

''

Remarks

This field contains a one character code indicating the source of the ApprovalCode. The received code must be stored and submitted in the batch settlement.

Valid source codes:

* Currently in use by Japan Acquirer Services (JAS).

Data Type

String

CardExpMonth Property (DPaymentsSDK_PTechDetailRecord Class)

Expiration month of the credit card specified by CardNumber .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 4 );


dpaymentssdk_ptechdetailrecord_set($res, 4, $value );

Default Value

1

Remarks

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

Data Type

Integer

CardExpYear Property (DPaymentsSDK_PTechDetailRecord Class)

Expiration year of the credit card specified by CardNumber .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 5 );


dpaymentssdk_ptechdetailrecord_set($res, 5, $value );

Default Value

1

Remarks

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

Data Type

Integer

CardNumber Property (DPaymentsSDK_PTechDetailRecord Class)

Customer's credit card number from the original authorization request.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 6 );


dpaymentssdk_ptechdetailrecord_set($res, 6, $value );

Default Value

''

Remarks

This field contains the customer's credit card number used in the original authorization request. This alphanumeric field can be a maximum of 22 characters long, excluding whitespace and dashes which are stripped out when the property is set.

Data Type

String

CardType Property (DPaymentsSDK_PTechDetailRecord Class)

Type of the credit card.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 7 );


dpaymentssdk_ptechdetailrecord_set($res, 7, $value );

Default Value

''

Remarks

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.

Data Type

String

CVVResult Property (DPaymentsSDK_PTechDetailRecord Class)

Contains the returned CVV result code if it was requested.

Object Oriented Interface

public function getCVVResult();


public function setCVVResult($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 8 );


dpaymentssdk_ptechdetailrecord_set($res, 8, $value );

Default Value

''

Remarks

If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code.

Data Type

String

ECI Property (DPaymentsSDK_PTechDetailRecord Class)

Electronic Commerce Indicator from the original authorization request.

Object Oriented Interface

public function getECI();


public function setECI($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 9 );


dpaymentssdk_ptechdetailrecord_set($res, 9, $value );

Default Value

''

Remarks

This field should be identical to the ECI property from the original authorization request. This property is used only for eCommerce and Direct Marketing (card not present) transactions, and is ignored for all Card Present (Retail) transactions.

Data Type

String

EntryDataSource Property (DPaymentsSDK_PTechDetailRecord Class)

Should reflect the Entry Data Source sent in the original authorization request.

Object Oriented Interface

public function getEntryDataSource();


public function setEntryDataSource($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 10 );


dpaymentssdk_ptechdetailrecord_set($res, 10, $value );

Default Value

0

Remarks

If sending an off-line credit or capture this property should reflect the way in which the card was presented for the credit or capture.

The following data sources are supported - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

This property is not available at design time.

Data Type

Integer

GoodsIndicator Property (DPaymentsSDK_PTechDetailRecord 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_ptechdetailrecord_get($res, 11 );


dpaymentssdk_ptechdetailrecord_set($res, 11, $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_PTechDetailRecord Class)

Gratuity amount for settling restaurant industry transactions.

Object Oriented Interface

public function getGratuityAmount();


public function setGratuityAmount($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 12 );


dpaymentssdk_ptechdetailrecord_set($res, 12, $value );

Default Value

''

Remarks

This field contains the gratuity (tip) amount of the transaction being settled. This amount is only sent when the PTechCharge class's IndustryType is set to "itRestaurant". If a transaction includes a GratuityAmount amount, the SettlementAmount must reflect the total of the original 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

HotelArrivalDate Property (DPaymentsSDK_PTechDetailRecord Class)

Date the customer checked in, or the expected arrival date when authorizing a reservation.

Object Oriented Interface

public function getHotelArrivalDate();


public function setHotelArrivalDate($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 13 );


dpaymentssdk_ptechdetailrecord_set($res, 13, $value );

Default Value

'010101'

Remarks

Date the customer checked in, or the expected arrival date when authorizing a reservation. This property must contain an actual valid date.

Data Type

String

HotelChargeDescriptor Property (DPaymentsSDK_PTechDetailRecord Class)

Provides additional information about what this transaction was used for at the hotel.

Object Oriented Interface

public function getHotelChargeDescriptor();


public function setHotelChargeDescriptor($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 14 );


dpaymentssdk_ptechdetailrecord_set($res, 14, $value );

Default Value

1

Remarks

Provides additional information about what this transaction was used for at the hotel. If used to pay for actual hotel accommodations, this should be set to cdLodging. If this transaction was used for any hotel-provided services, it should be set to the corresponding description listed below. Available descriptors include:

• cdHealthClub (0)
• cdLodging (1)
• cdRestaurant (2)
• cdGiftShop (3)
• cdHairSalon (4)
• cdConventionFees (5)
• cdTennisClub (6)
• cdGolfShop (7)

Data Type

Integer

HotelDepartureDate Property (DPaymentsSDK_PTechDetailRecord Class)

Date the customer checked out, or the expected check-out date when authorizing a reservation.

Object Oriented Interface

public function getHotelDepartureDate();


public function setHotelDepartureDate($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 15 );


dpaymentssdk_ptechdetailrecord_set($res, 15, $value );

Default Value

'010101'

Remarks

Date the customer checked out, or the expected check-out date when authorizing a reservation. This property must contain an actual valid date.

Data Type

String

HotelDuration Property (DPaymentsSDK_PTechDetailRecord Class)

The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation.

Object Oriented Interface

public function getHotelDuration();


public function setHotelDuration($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 16 );


dpaymentssdk_ptechdetailrecord_set($res, 16, $value );

Default Value

1

Remarks

The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation. This property must be between 1 and 99 days.

Data Type

Integer

HotelExtraChargeAmount Property (DPaymentsSDK_PTechDetailRecord Class)

Total amount of extra charges incurred by the customer.

Object Oriented Interface

public function getHotelExtraChargeAmount();


public function setHotelExtraChargeAmount($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 17 );


dpaymentssdk_ptechdetailrecord_set($res, 17, $value );

Default Value

'0.00'

Remarks

Total amount of extra charges incurred by the customer. Use the HotelExtraChargesCode to indicate the types of charges that have been added on to this transaction.

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

Data Type

String

HotelExtraChargesCode Property (DPaymentsSDK_PTechDetailRecord Class)

List of extra charges added to the cost of lodging.

Object Oriented Interface

public function getHotelExtraChargesCode();


public function setHotelExtraChargesCode($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 18 );


dpaymentssdk_ptechdetailrecord_set($res, 18, $value );

Default Value

'000000'

Remarks

List of extra charges added to the cost of lodging. You may include a list of extra charges for hotel transactions. Simply add the code below to this property. Multiple codes may be specified by concatenating them together. Only six extra charges may be added. For instance "240000" indicates the customer dined at the hotel restaurant and drank from the mini bar in his room. Available codes include:

Data Type

String

HotelPreferredCustomer Property (DPaymentsSDK_PTechDetailRecord Class)

Set this property to True to process a hotel transaction as card-not-present.

Object Oriented Interface

public function getHotelPreferredCustomer();


public function setHotelPreferredCustomer($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 19 );


dpaymentssdk_ptechdetailrecord_set($res, 19, $value );

Default Value

false

Remarks

Set this property to True to process a hotel transaction as card-not-present. This can be used for phoned-in reservations, no-show charges, or any transaction that takes place without the customer's physical card present. This property is only applicable for Visa and MasterCard transactions. Other card types must use the PTechECommerce class for phone or internet reservations.

Data Type

Boolean

HotelSaleCode Property (DPaymentsSDK_PTechDetailRecord Class)

Provides additional details about the type of this transaction.

Object Oriented Interface

public function getHotelSaleCode();


public function setHotelSaleCode($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 20 );


dpaymentssdk_ptechdetailrecord_set($res, 20, $value );

Default Value

1

Remarks

Provides additional details about the type of this transaction.

Data Type

Integer

IndustryType Property (DPaymentsSDK_PTechDetailRecord Class)

Determines the merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 21 );


dpaymentssdk_ptechdetailrecord_set($res, 21, $value );

Default Value

0

Remarks

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

Note: Setting the IndustryType has the side effect of changing the CardEntryDataSource to the default value for the selected industry type. In addition, setting the IndustryType to itDirectMarketing or itECommerce will also reset the PINCapability to ppNoPIN.

* 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_PTechDetailRecord Class)

Invoice Number from the original authorization request.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 22 );


dpaymentssdk_ptechdetailrecord_set($res, 22, $value );

Default Value

''

Remarks

This property should be identical to the InvoiceNumber from the original authorization request.

Data Type

String

Level2PurchaseId Property (DPaymentsSDK_PTechDetailRecord Class)

Purchase Identifier for use when sending Level II data.

Object Oriented Interface

public function getLevel2PurchaseId();


public function setLevel2PurchaseId($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 23 );


dpaymentssdk_ptechdetailrecord_set($res, 23, $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_PTechDetailRecord Class)

Sales Tax for use when sending Level II data.

Object Oriented Interface

public function getLevel2SalesTax();


public function setLevel2SalesTax($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 24 );


dpaymentssdk_ptechdetailrecord_set($res, 24, $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_PTechDetailRecord Class)

Destination ZipCode for use when sending Level II data.

Object Oriented Interface

public function getLevel2ShipToZip();


public function setLevel2ShipToZip($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 25 );


dpaymentssdk_ptechdetailrecord_set($res, 25, $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

NetworkId Property (DPaymentsSDK_PTechDetailRecord Class)

The Authorizing network Id from the original authorization response.

Object Oriented Interface

public function getNetworkId();


public function setNetworkId($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 26 );


dpaymentssdk_ptechdetailrecord_set($res, 26, $value );

Default Value

''

Remarks

This property should be identical to the NetworkId returned from Paymentech in the authorization response.

Data Type

String

SequenceNumber Property (DPaymentsSDK_PTechDetailRecord Class)

Sequence number of the transaction.

Object Oriented Interface

public function getSequenceNumber();


public function setSequenceNumber($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 27 );


dpaymentssdk_ptechdetailrecord_set($res, 27, $value );

Default Value

1

Remarks

This should be identical to the sequence number sent in the original authorization.

Data Type

Integer

ServerNumber Property (DPaymentsSDK_PTechDetailRecord 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_ptechdetailrecord_get($res, 28 );


dpaymentssdk_ptechdetailrecord_set($res, 28, $value );

Default Value

''

Remarks

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

Data Type

String

SettlementAmount Property (DPaymentsSDK_PTechDetailRecord Class)

The amount that the customer will be charged.

Object Oriented Interface

public function getSettlementAmount();


public function setSettlementAmount($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 29 );


dpaymentssdk_ptechdetailrecord_set($res, 29, $value );

Default Value

'0.00'

Remarks

This field contains the final settlement amount of the transaction. In most cases, this is the TransactionAmount from the original authorization request. However, you may settle a lesser amount (ie: Partial shipment or backordered stock). This field must always be greater than zero.

Note: If a transaction includes a GratuityAmount amount, the SettlementAmount must reflect the total of the original authorized amount plus the GratuityAmount (this is only applicable to the itResturant IndustryType).

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

Notes for the Hotel IndustryType:

To obtain the best interchange rate for Visa transactions in the Hotel IndustryType, the check out amount (SettlementAmount) must be within 15% of the original authorization amount. If the SettlementAmount is less than the original authorized amount by more than 15%, you must perform an authorization reversal using the PTechReversal class. This will immediately release funds from the cardholder's open to buy amount. The original transaction must then be settled for the new amount as usual. However, if the SettlementAmount exceeds the original authorized amount by more than 15%, you must submit an incremental authorization to make up the remaining amount. In this case even though there are two separate transactions, they are tied together with the same authorization code. Therefore, only the original authorization (with the newly updated SettlementAmount) is to be sent in the settlement.

Non-Visa transactions do not allow for Incrementals to tie transactions together, nor Reversals to release funds from the cardholder's open to buy amount. There are no restrictions on the difference between the SettlementAmount and the original authorization amount. However, if the merchant suspects that the final transaction amount will be substantially higher than the original authorization amount, the merchant should perform an additional authorization for the difference. This subsequent authorization must be sent to the host as a standard authorization-only transaction, and will not be tied in any way to the original transaction. Both transactions must be present in the settlement.

Notes for the Restaurant IndustryType:

For Visa transactions, to obtain the best interchange rate the SettlementAmount must be within 20% of the authorized amount. The initial authorization must be submitted for the actual transaction amount. It must not be altered to include an additional percentage that accounts for a tip being added before settlement.

The same rule applies to MasterCard transactions, with the exception that MasterCard allows the SettlementAmount to be within 25% of the authorized amount.

There are no rules concerning authorization and settlement amounts for other card types.

This information was accurate at the time this document was written. Please see the Processing and Interchange Guidelines (provided by Paymentech) for updates as well as additional information on interchange rate qualification.

Data Type

String

TransactionDate Property (DPaymentsSDK_PTechDetailRecord Class)

Local Transaction Date from the original authorization response.

Object Oriented Interface

public function getTransactionDate();


public function setTransactionDate($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 30 );


dpaymentssdk_ptechdetailrecord_set($res, 30, $value );

Default Value

'010101'

Remarks

This six digit field contains a local transaction date associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value returned in the original authorization response message. If the transaction was processed off-line, this field must contain a Point of Sale (POS) device generated date. This field must appear in MMDDYY format.

Data Type

String

TransactionTime Property (DPaymentsSDK_PTechDetailRecord Class)

Local transaction time from the original authorization response.

Object Oriented Interface

public function getTransactionTime();


public function setTransactionTime($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 31 );


dpaymentssdk_ptechdetailrecord_set($res, 31, $value );

Default Value

'000000'

Remarks

This six digit field contains a local transaction time associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value returned in the original authorization response message. If the transaction was processed off-line, this field must contain a Point of Sale (POS) device generated time. This field must appear in HHMMSS format.

Data Type

String

TransactionType Property (DPaymentsSDK_PTechDetailRecord Class)

Indicates transaction type for this detail record.

Object Oriented Interface

public function getTransactionType();


public function setTransactionType($value);

Procedural Interface

dpaymentssdk_ptechdetailrecord_get($res, 32 );


dpaymentssdk_ptechdetailrecord_set($res, 32, $value );

Default Value

1

Remarks

This property indicates the type of transaction that is being settled.

Note that only credit card transactions are supported here. EBT, Stored Value, Debit, and Canadian Debit cards must be processed with the Host Capture System, and cannot be manually settled.

Note that transactions Voided with the PTechCharge class must be removed from the batch. Voided transactions must not be settled.

Data Type

Integer

Config Method (DPaymentsSDK_PTechDetailRecord Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetDetailAggregate Method (DPaymentsSDK_PTechDetailRecord Class)

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

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_ptechdetailrecord_do_getdetailaggregate($res);

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the PTechManualSettle class's DetailAggregate 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 additional info for an Installment payment), 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.DetailRecord[0] = PTechCharge.GetDetailAggregate();

ParseAggregate Method (DPaymentsSDK_PTechDetailRecord Class)

Parses the aggregate returned from another class's GetDetailAggregate method.

Object Oriented Interface

public function doParseAggregate($aggregate);

Procedural Interface

dpaymentssdk_ptechdetailrecord_do_parseaggregate($res, $aggregate);

Remarks

This method takes the XML aggregate returned from the PTechCharge class, parses it, and then fills all the properties of the PTechDetailRecord class. While normally you can pass the results of the GetDetailAggregate method call directly to the PTechManualSettle class, sometimes it is necessary to adjust the contents of the XML aggregate first.

Reset Method (DPaymentsSDK_PTechDetailRecord Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_ptechdetailrecord_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_PTechDetailRecord Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_ptechdetailrecord_register_callback($res, 1, 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.

Config Settings (PTechDetailRecord Class)

The class accepts one or more of the following configuration settings. Configuration 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.

PTechDetailRecord Config Settings

Base Config Settings

Trappable Errors (PTechDetailRecord Class)

PTechDetailRecord Errors

	501   Property length is invalid
	502   Property is set with invalid data.
	504   Luhn digit check failed.
	505   Card date invalid.
	506   Card expired.
	517   Response length mismatch.
	546   Missing property for current method call.

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

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).