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.

Syntax

PTechDetailRecord

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

Indicates whether SettlementAmount has been modified from the original authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAmountStatus();
int SetAmountStatus(int iAmountStatus);

Unicode (Windows)
INT GetAmountStatus();
INT SetAmountStatus(INT iAmountStatus);

AS_ACTUAL_AMOUNT(0), 
AS_AMOUNT_CHANGED(1)

int dpaymentssdk_ptechdetailrecord_getamountstatus(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setamountstatus(void* lpObj, int iAmountStatus);

int GetAmountStatus();
int SetAmountStatus(int iAmountStatus);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovalCode();
int SetApprovalCode(const char* lpszApprovalCode);

Unicode (Windows)
LPWSTR GetApprovalCode();
INT SetApprovalCode(LPCWSTR lpszApprovalCode);

char* dpaymentssdk_ptechdetailrecord_getapprovalcode(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setapprovalcode(void* lpObj, const char* lpszApprovalCode);

QString GetApprovalCode();
int SetApprovalCode(QString qsApprovalCode);

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

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthSource();
int SetAuthSource(const char* lpszAuthSource);

Unicode (Windows)
LPWSTR GetAuthSource();
INT SetAuthSource(LPCWSTR lpszAuthSource);

char* dpaymentssdk_ptechdetailrecord_getauthsource(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setauthsource(void* lpObj, const char* lpszAuthSource);

QString GetAuthSource();
int SetAuthSource(QString qsAuthSource);

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:

Data Type

String

CardExpMonth Property (PTechDetailRecord Class)

Expiration month of the credit card specified by CardNumber .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Unicode (Windows)
INT GetCardExpMonth();
INT SetCardExpMonth(INT iCardExpMonth);

int dpaymentssdk_ptechdetailrecord_getcardexpmonth(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setcardexpmonth(void* lpObj, int iCardExpMonth);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

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

Expiration year of the credit card specified by CardNumber .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Unicode (Windows)
INT GetCardExpYear();
INT SetCardExpYear(INT iCardExpYear);

int dpaymentssdk_ptechdetailrecord_getcardexpyear(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setcardexpyear(void* lpObj, int iCardExpYear);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardNumber();
int SetCardNumber(const char* lpszCardNumber);

Unicode (Windows)
LPWSTR GetCardNumber();
INT SetCardNumber(LPCWSTR lpszCardNumber);

char* dpaymentssdk_ptechdetailrecord_getcardnumber(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setcardnumber(void* lpObj, const char* lpszCardNumber);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

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

Type of the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardType();
int SetCardType(const char* lpszCardType);

Unicode (Windows)
LPWSTR GetCardType();
INT SetCardType(LPCWSTR lpszCardType);

char* dpaymentssdk_ptechdetailrecord_getcardtype(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setcardtype(void* lpObj, const char* lpszCardType);

QString GetCardType();
int SetCardType(QString qsCardType);

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

Contains the returned CVV result code if it was requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCVVResult();
int SetCVVResult(const char* lpszCVVResult);

Unicode (Windows)
LPWSTR GetCVVResult();
INT SetCVVResult(LPCWSTR lpszCVVResult);

char* dpaymentssdk_ptechdetailrecord_getcvvresult(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setcvvresult(void* lpObj, const char* lpszCVVResult);

QString GetCVVResult();
int SetCVVResult(QString qsCVVResult);

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

Electronic Commerce Indicator from the original authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetECI();
int SetECI(const char* lpszECI);

Unicode (Windows)
LPWSTR GetECI();
INT SetECI(LPCWSTR lpszECI);

char* dpaymentssdk_ptechdetailrecord_geteci(void* lpObj);
int dpaymentssdk_ptechdetailrecord_seteci(void* lpObj, const char* lpszECI);

QString GetECI();
int SetECI(QString qsECI);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryDataSource();
int SetEntryDataSource(int iEntryDataSource);

Unicode (Windows)
INT GetEntryDataSource();
INT SetEntryDataSource(INT iEntryDataSource);

EDS_TRACK_1(0), 
EDS_TRACK_2(1), 
EDS_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
EDS_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
EDS_MANUAL_ENTRY_NO_CARD_READER(4), 
EDS_TRACK_1CONTACTLESS(5), 
EDS_TRACK_2CONTACTLESS(6), 
EDS_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
EDS_IVR(8), 
EDS_KIOSK(9)

int dpaymentssdk_ptechdetailrecord_getentrydatasource(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setentrydatasource(void* lpObj, int iEntryDataSource);

int GetEntryDataSource();
int SetEntryDataSource(int iEntryDataSource);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGoodsIndicator();
int SetGoodsIndicator(int iGoodsIndicator);

Unicode (Windows)
INT GetGoodsIndicator();
INT SetGoodsIndicator(INT iGoodsIndicator);

GI_PHYSICAL_GOODS(0), 
GI_DIGITAL_GOODS(1)

int dpaymentssdk_ptechdetailrecord_getgoodsindicator(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setgoodsindicator(void* lpObj, int iGoodsIndicator);

int GetGoodsIndicator();
int SetGoodsIndicator(int iGoodsIndicator);

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

Gratuity amount for settling restaurant industry transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGratuityAmount();
int SetGratuityAmount(const char* lpszGratuityAmount);

Unicode (Windows)
LPWSTR GetGratuityAmount();
INT SetGratuityAmount(LPCWSTR lpszGratuityAmount);

char* dpaymentssdk_ptechdetailrecord_getgratuityamount(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setgratuityamount(void* lpObj, const char* lpszGratuityAmount);

QString GetGratuityAmount();
int SetGratuityAmount(QString qsGratuityAmount);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHotelArrivalDate();
int SetHotelArrivalDate(const char* lpszHotelArrivalDate);

Unicode (Windows)
LPWSTR GetHotelArrivalDate();
INT SetHotelArrivalDate(LPCWSTR lpszHotelArrivalDate);

char* dpaymentssdk_ptechdetailrecord_gethotelarrivaldate(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelarrivaldate(void* lpObj, const char* lpszHotelArrivalDate);

QString GetHotelArrivalDate();
int SetHotelArrivalDate(QString qsHotelArrivalDate);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHotelChargeDescriptor();
int SetHotelChargeDescriptor(int iHotelChargeDescriptor);

Unicode (Windows)
INT GetHotelChargeDescriptor();
INT SetHotelChargeDescriptor(INT iHotelChargeDescriptor);

CD_HEALTH_CLUB(0), 
CD_LODGING(1), 
CD_RESTAURANT(2), 
CD_GIFT_SHOP(3), 
CD_HAIR_SALON(4), 
CD_CONVENTION_FEES(5), 
CD_TENNIS_CLUB(6), 
CD_GOLF_SHOP(7)

int dpaymentssdk_ptechdetailrecord_gethotelchargedescriptor(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelchargedescriptor(void* lpObj, int iHotelChargeDescriptor);

int GetHotelChargeDescriptor();
int SetHotelChargeDescriptor(int iHotelChargeDescriptor);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHotelDepartureDate();
int SetHotelDepartureDate(const char* lpszHotelDepartureDate);

Unicode (Windows)
LPWSTR GetHotelDepartureDate();
INT SetHotelDepartureDate(LPCWSTR lpszHotelDepartureDate);

char* dpaymentssdk_ptechdetailrecord_gethoteldeparturedate(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethoteldeparturedate(void* lpObj, const char* lpszHotelDepartureDate);

QString GetHotelDepartureDate();
int SetHotelDepartureDate(QString qsHotelDepartureDate);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHotelDuration();
int SetHotelDuration(int iHotelDuration);

Unicode (Windows)
INT GetHotelDuration();
INT SetHotelDuration(INT iHotelDuration);

int dpaymentssdk_ptechdetailrecord_gethotelduration(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelduration(void* lpObj, int iHotelDuration);

int GetHotelDuration();
int SetHotelDuration(int iHotelDuration);

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

Total amount of extra charges incurred by the customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHotelExtraChargeAmount();
int SetHotelExtraChargeAmount(const char* lpszHotelExtraChargeAmount);

Unicode (Windows)
LPWSTR GetHotelExtraChargeAmount();
INT SetHotelExtraChargeAmount(LPCWSTR lpszHotelExtraChargeAmount);

char* dpaymentssdk_ptechdetailrecord_gethotelextrachargeamount(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelextrachargeamount(void* lpObj, const char* lpszHotelExtraChargeAmount);

QString GetHotelExtraChargeAmount();
int SetHotelExtraChargeAmount(QString qsHotelExtraChargeAmount);

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

List of extra charges added to the cost of lodging.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHotelExtraChargesCode();
int SetHotelExtraChargesCode(const char* lpszHotelExtraChargesCode);

Unicode (Windows)
LPWSTR GetHotelExtraChargesCode();
INT SetHotelExtraChargesCode(LPCWSTR lpszHotelExtraChargesCode);

char* dpaymentssdk_ptechdetailrecord_gethotelextrachargescode(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelextrachargescode(void* lpObj, const char* lpszHotelExtraChargesCode);

QString GetHotelExtraChargesCode();
int SetHotelExtraChargesCode(QString qsHotelExtraChargesCode);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHotelPreferredCustomer();
int SetHotelPreferredCustomer(int bHotelPreferredCustomer);

Unicode (Windows)
BOOL GetHotelPreferredCustomer();
INT SetHotelPreferredCustomer(BOOL bHotelPreferredCustomer);

int dpaymentssdk_ptechdetailrecord_gethotelpreferredcustomer(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelpreferredcustomer(void* lpObj, int bHotelPreferredCustomer);

bool GetHotelPreferredCustomer();
int SetHotelPreferredCustomer(bool bHotelPreferredCustomer);

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

Provides additional details about the type of this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHotelSaleCode();
int SetHotelSaleCode(int iHotelSaleCode);

Unicode (Windows)
INT GetHotelSaleCode();
INT SetHotelSaleCode(INT iHotelSaleCode);

SC_NOT_SET(0), 
SC_SALE(1), 
SC_NO_SHOW(2), 
SC_DEPOSIT(3), 
SC_DELAYED_CHARGE(4), 
SC_EXPRESS_SERVICE(5), 
SC_ASSURED_RESERVATION(6)

int dpaymentssdk_ptechdetailrecord_gethotelsalecode(void* lpObj);
int dpaymentssdk_ptechdetailrecord_sethotelsalecode(void* lpObj, int iHotelSaleCode);

int GetHotelSaleCode();
int SetHotelSaleCode(int iHotelSaleCode);

Default Value

1

Remarks

Provides additional details about the type of this transaction.

Data Type

Integer

IndustryType Property (PTechDetailRecord Class)

Determines the merchant's industry type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

PIT_RETAIL(0), 
PIT_DIRECT_MARKETING(1), 
PIT_ECOMMERCE(2), 
PIT_RESTAURANT(3), 
PIT_HOTEL(4)

int dpaymentssdk_ptechdetailrecord_getindustrytype(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

0

Remarks

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

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

Data Type

Integer

InvoiceNumber Property (PTechDetailRecord Class)

Invoice Number from the original authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber);

Unicode (Windows)
LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);

char* dpaymentssdk_ptechdetailrecord_getinvoicenumber(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);

Default Value

""

Remarks

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

Data Type

String

Level2PurchaseId Property (PTechDetailRecord Class)

Purchase Identifier for use when sending Level II data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2PurchaseId();
int SetLevel2PurchaseId(const char* lpszLevel2PurchaseId);

Unicode (Windows)
LPWSTR GetLevel2PurchaseId();
INT SetLevel2PurchaseId(LPCWSTR lpszLevel2PurchaseId);

char* dpaymentssdk_ptechdetailrecord_getlevel2purchaseid(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setlevel2purchaseid(void* lpObj, const char* lpszLevel2PurchaseId);

QString GetLevel2PurchaseId();
int SetLevel2PurchaseId(QString qsLevel2PurchaseId);

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

Sales Tax for use when sending Level II data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2SalesTax();
int SetLevel2SalesTax(const char* lpszLevel2SalesTax);

Unicode (Windows)
LPWSTR GetLevel2SalesTax();
INT SetLevel2SalesTax(LPCWSTR lpszLevel2SalesTax);

char* dpaymentssdk_ptechdetailrecord_getlevel2salestax(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setlevel2salestax(void* lpObj, const char* lpszLevel2SalesTax);

QString GetLevel2SalesTax();
int SetLevel2SalesTax(QString qsLevel2SalesTax);

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

Destination ZipCode for use when sending Level II data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2ShipToZip();
int SetLevel2ShipToZip(const char* lpszLevel2ShipToZip);

Unicode (Windows)
LPWSTR GetLevel2ShipToZip();
INT SetLevel2ShipToZip(LPCWSTR lpszLevel2ShipToZip);

char* dpaymentssdk_ptechdetailrecord_getlevel2shiptozip(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setlevel2shiptozip(void* lpObj, const char* lpszLevel2ShipToZip);

QString GetLevel2ShipToZip();
int SetLevel2ShipToZip(QString qsLevel2ShipToZip);

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

The Authorizing network Id from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNetworkId();
int SetNetworkId(const char* lpszNetworkId);

Unicode (Windows)
LPWSTR GetNetworkId();
INT SetNetworkId(LPCWSTR lpszNetworkId);

char* dpaymentssdk_ptechdetailrecord_getnetworkid(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setnetworkid(void* lpObj, const char* lpszNetworkId);

QString GetNetworkId();
int SetNetworkId(QString qsNetworkId);

Default Value

""

Remarks

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

Data Type

String

SequenceNumber Property (PTechDetailRecord Class)

Sequence number of the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSequenceNumber();
int SetSequenceNumber(int iSequenceNumber);

Unicode (Windows)
INT GetSequenceNumber();
INT SetSequenceNumber(INT iSequenceNumber);

int dpaymentssdk_ptechdetailrecord_getsequencenumber(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setsequencenumber(void* lpObj, int iSequenceNumber);

int GetSequenceNumber();
int SetSequenceNumber(int iSequenceNumber);

Default Value

1

Remarks

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

Data Type

Integer

ServerNumber Property (PTechDetailRecord Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerNumber();
int SetServerNumber(const char* lpszServerNumber);

Unicode (Windows)
LPWSTR GetServerNumber();
INT SetServerNumber(LPCWSTR lpszServerNumber);

char* dpaymentssdk_ptechdetailrecord_getservernumber(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setservernumber(void* lpObj, const char* lpszServerNumber);

QString GetServerNumber();
int SetServerNumber(QString qsServerNumber);

Default Value

""

Remarks

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

Data Type

String

SettlementAmount Property (PTechDetailRecord Class)

The amount that the customer will be charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSettlementAmount();
int SetSettlementAmount(const char* lpszSettlementAmount);

Unicode (Windows)
LPWSTR GetSettlementAmount();
INT SetSettlementAmount(LPCWSTR lpszSettlementAmount);

char* dpaymentssdk_ptechdetailrecord_getsettlementamount(void* lpObj);
int dpaymentssdk_ptechdetailrecord_setsettlementamount(void* lpObj, const char* lpszSettlementAmount);

QString GetSettlementAmount();
int SetSettlementAmount(QString qsSettlementAmount);

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

Local Transaction Date from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionDate();
int SetTransactionDate(const char* lpszTransactionDate);

Unicode (Windows)
LPWSTR GetTransactionDate();
INT SetTransactionDate(LPCWSTR lpszTransactionDate);

char* dpaymentssdk_ptechdetailrecord_gettransactiondate(void* lpObj);
int dpaymentssdk_ptechdetailrecord_settransactiondate(void* lpObj, const char* lpszTransactionDate);

QString GetTransactionDate();
int SetTransactionDate(QString qsTransactionDate);

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

Local transaction time from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionTime();
int SetTransactionTime(const char* lpszTransactionTime);

Unicode (Windows)
LPWSTR GetTransactionTime();
INT SetTransactionTime(LPCWSTR lpszTransactionTime);

char* dpaymentssdk_ptechdetailrecord_gettransactiontime(void* lpObj);
int dpaymentssdk_ptechdetailrecord_settransactiontime(void* lpObj, const char* lpszTransactionTime);

QString GetTransactionTime();
int SetTransactionTime(QString qsTransactionTime);

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

Indicates transaction type for this detail record.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionType();
int SetTransactionType(int iTransactionType);

Unicode (Windows)
INT GetTransactionType();
INT SetTransactionType(INT iTransactionType);

DTT_SALE(1), 
DTT_CAPTURE(3), 
DTT_HOTEL_NO_SHOW(4), 
DTT_CREDIT(6)

int dpaymentssdk_ptechdetailrecord_gettransactiontype(void* lpObj);
int dpaymentssdk_ptechdetailrecord_settransactiontype(void* lpObj, int iTransactionType);

int GetTransactionType();
int SetTransactionType(int iTransactionType);

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_ptechdetailrecord_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetDetailAggregate Method (PTechDetailRecord Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDetailAggregate();

Unicode (Windows)
LPWSTR GetDetailAggregate();

char* dpaymentssdk_ptechdetailrecord_getdetailaggregate(void* lpObj);

QString GetDetailAggregate();

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ParseAggregate Method (PTechDetailRecord Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseAggregate(const char* lpszAggregate);

Unicode (Windows)
INT ParseAggregate(LPCWSTR lpszAggregate);

int dpaymentssdk_ptechdetailrecord_parseaggregate(void* lpObj, const char* lpszAggregate);

int ParseAggregate(const QString& qsAggregate);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (PTechDetailRecord Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_ptechdetailrecord_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (PTechDetailRecord Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PTechDetailRecordErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PTechDetailRecordErrorEventParams;


Unicode (Windows)
virtual INT FireError(PTechDetailRecordErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PTechDetailRecordErrorEventParams;

#define EID_PTECHDETAILRECORD_ERROR 1

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PTechDetailRecordErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PTechDetailRecordErrorEventParams *e);

// Or, subclass PTechDetailRecord and override this emitter function.
virtual int FireError(PTechDetailRecordErrorEventParams *e) {...}

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)

PTechDetailRecord Config Settings

Base Config Settings

Trappable Errors (PTechDetailRecord Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PTechDetailRecord 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