TSYSDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSDetailRecord class is a tool used to create off-line Credit or Force transactions to be settled by the TSYSSETTLE class. The TSYSDetailRecord class may also be used to modify the XML aggregates returned by the TSYSRETAIL or TSYSECOMMERCE class's GetDetailAggregate method.

Syntax

TSYSDetailRecord

Remarks

Credit and Force transactions are off-line transactions. This means that there is no authorization of funds using the TSYSECommerce or TSYSRetail classs. Instead, you must manually add these transactions to the settlement batch. The TSYSDetailRecord class can be used to create these transactions, which can then be added to the TSYSSettle class's DetailRecord array property.

To create a Credit, first set the TransactionType to dttOffLineCredit, and then set the IndustryType. EntryDataSource, and CardholderId based on whether you have a card reader, and how your customer is authenticated. The following example shows how this should be set for Direct Marketing:

TSYSDetailRecord.TransactionType = dttOffLineCredit TSYSDetailRecord.IndustryType = itDirectMarketing TSYSDetailRecord.EntryDataSource = edsManualEntryNoCardReader 'for DirectMarketing TSYSDetailRecord.CardholderId = "N" 'AVS for direct marketing

Next, set the CardNumber, SettlementAmount, and the current TransactionDate and TransactionTime. Note that since this is an off-line transaction, the AuthorizedAmount MUST be either zero or empty string.

TSYSDetailRecord.CardNumber = "4444333322221111" 'Card to credit TSYSDetailRecord.SettlementAmount = "3476" 'Amount of the credit $34.76 TSYSDetailRecord.AuthorizedAmount = "0" 'MUST be zero for credits! TSYSDetailRecord.TransactionDate = "0605" 'Date of this credit in MMDD format TSYSDetailRecord.TransactionTime = "124555" 'Time of this credit in HHMMSS format

Since this is an off-line transaction, the TransactionNumber may be any value (except 0), and need not reflect the value from the original authorization. You may simply set this to the next sequence number used for authorizations, if you wish. However, the TransactionId must be set to "0" or empty string.

TSYSDetailRecord.TransactionNumber = "123" 'Transaction sequence number of the original authorization request TSYSDetailRecord.TransactionId = "" 'ResponseTransactionId from the original authorization response Finally, set the TSYSSettle class's DetailRecord array property with the value returned by the GetDetailAggregate method. You've just added a Credit to the settlement.

TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailRecordAggregate[0] = TSYSDetailRecord.GetDetailAggregate()

Forced transactions are similar to credits, with the exception that a Forced transaction 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 ResponseApprovalCode property. The following example shows a Force transaction in a Retail environment. TSYSDetailRecord.TransactionType = dttForceCardPresent TSYSDetailRecord.IndustryType = itRetail TSYSDetailRecord.ResponseApprovalCode = "123456" ' This is obtained from a voice authorization over the phone TSYSDetailRecord.EntryDataSource = edsTrack1 TSYSDetailRecord.CardholderId = "@" 'Signature TSYSDetailRecord.CardNumber = "4444333322221111" 'Card to credit TSYSDetailRecord.SettlementAmount = "5555" 'Amount of the credit $55.55 TSYSDetailRecord.AuthorizedAmount = 0 'MUST be zero for off-line transactions! TSYSDetailRecord.TransactionDate = "0605" 'Date of this credit in MMDD format TSYSDetailRecord.TransactionTime = "124555" 'Time of this credit in HHMMSS format TSYSDetailRecord.TransactionNumber = "124" 'Transaction sequence number of the original authorization request TSYSDetailRecord.TransactionId = "" 'ResponseTransactionId from the original authorization response TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailRecordAggregate[1] = TSYSDetailRecord.GetDetailAggregate()

In addition to creating Credit and Force transactions, the TSYSDetailRecord class can be used to adjust the Detail Records returned from the TSYSECommerce, TSYSRetail, TSYSDebit, and TSYSBenefit classs. The most common reasons to modify these detail records are to add a Gratuity (tip) to a charge (sitResturant, sitRetail and sitGroceryStore IndustryType), to add a PurchaseIdentifier or Installment payment info (itDirectMarketing IndustryType) to the detail record, or to add Hotel or Auto Rental or Passenger Transport specific information when dealing with those IndustryTypes.

For example, to add a gratuity to a charge:

DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) DetailRecord.Gratuity = "500" DetailRecord.SettlementAmount = DetailRecord.AuthorizedAmount + DetailRecord.Gratuity TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

To settle a Passenger Transport transaction authorized with the sitPassengerTransport IndustryType, you must use the TSYSDetailRecord class to add the number of this passenger and the total count of all passengers in the authorization code. For instance, if the authorization transaction included "Three passengers", and this is the first passenger, then the passenger number will be 1, and the passenger count 3. An example is included below:

TSYSRetail.IndustryType = sitPassengerTransport TSYSRetail.Authorize() DetailRecord.ParseAggregate TSYSRetail.GetDetailAggregate() DetailRecord.PassengerCount = 3 DetailRecord.PassengerNumber = 1 DetailRecord.Config("RestrictedTicketIndicator=True") DetailRecord.Config("TicketNumber=8382152100395") DetailRecord.Config("PassengerName=John Smith") DetailRecord.Config("DepartureDate=072117") DetailRecord.Config("Origin=JFK") DetailRecord.Config("Leg1=Carrier=DL;ServiceClass=C;StopOver=X;Destination=LAX") TSYSSettle1.IndustryType = sitPassengerTransport TSYSSettle1.Config("TravelAgencyCode=12345678") 'if ticket was issued by a travel agency TSYSSettle1.Config("TravelAgencyName=Travel and Tours") 'if ticket was issued by a travel agency TSYSSettle1.DetailAggregate[5] = DetailRecord.GetDetailAggregate()

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.

AuthorizedAmount Property (TSYSDetailRecord Class)

Original amount authorized before any reversals.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizedAmount();
int SetAuthorizedAmount(const char* lpszAuthorizedAmount);

Unicode (Windows)
LPWSTR GetAuthorizedAmount();
INT SetAuthorizedAmount(LPCWSTR lpszAuthorizedAmount);

char* dpaymentssdk_tsysdetailrecord_getauthorizedamount(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setauthorizedamount(void* lpObj, const char* lpszAuthorizedAmount);

QString GetAuthorizedAmount();
int SetAuthorizedAmount(QString qsAuthorizedAmount);

Default Value

"000000000000"

Remarks

This field contains the transaction amount from the original authorization request message. If any additional authorizations have been made, or the SettlementAmount is different than the originally authorized amount (due to items out of stock or adding a Gratuity) this property should still reflect the original unchanged amount from the initial authorization request.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

CardholderId Property (TSYSDetailRecord Class)

Specifies the method used to verify the identity of the cardholder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardholderId();
int SetCardholderId(const char* lpszCardholderId);

Unicode (Windows)
LPWSTR GetCardholderId();
INT SetCardholderId(LPCWSTR lpszCardholderId);

char* dpaymentssdk_tsysdetailrecord_getcardholderid(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setcardholderid(void* lpObj, const char* lpszCardholderId);

QString GetCardholderId();
int SetCardholderId(QString qsCardholderId);

Default Value

"N"

Remarks

This 1-character property contains a code that specifies the method used to verify the identity of the cardholder. The value may be used in conjunction with AVS and ACI indicators. The following table lists all of the supported cardholder identification codes, but please note that some codes are Direct Marketing-specific and some are Retail-specific.

Data Type

String

CardNumber Property (TSYSDetailRecord 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_tsysdetailrecord_getcardnumber(void* lpObj);
int dpaymentssdk_tsysdetailrecord_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

DebitCashBack Property (TSYSDetailRecord Class)

Contains the ResponseCashBack amount from the original Debit or EBT transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitCashBack();
int SetDebitCashBack(const char* lpszDebitCashBack);

Unicode (Windows)
LPWSTR GetDebitCashBack();
INT SetDebitCashBack(LPCWSTR lpszDebitCashBack);

char* dpaymentssdk_tsysdetailrecord_getdebitcashback(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setdebitcashback(void* lpObj, const char* lpszDebitCashBack);

QString GetDebitCashBack();
int SetDebitCashBack(QString qsDebitCashBack);

Default Value

""

Remarks

This property contains the cash back amount contained in the original authorization request message. If there was no cash back returned, this property must remain empty.

Note that for EBT Withdrawals DebitCashBack must be identical to the SettlementAmount.

Note: DebitCashBack must be empty for Restaurant IndustryType as this is not supported by TSYS.

Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

This property is valid for Debit card and EBT card transactions only. It will be ignored for all other transactions.

Data Type

String

DebitNetworkId Property (TSYSDetailRecord Class)

Contains the ResponseNetworkId returned in the original Debit or EBT response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitNetworkId();
int SetDebitNetworkId(const char* lpszDebitNetworkId);

Unicode (Windows)
LPWSTR GetDebitNetworkId();
INT SetDebitNetworkId(LPCWSTR lpszDebitNetworkId);

char* dpaymentssdk_tsysdetailrecord_getdebitnetworkid(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setdebitnetworkid(void* lpObj, const char* lpszDebitNetworkId);

QString GetDebitNetworkId();
int SetDebitNetworkId(QString qsDebitNetworkId);

Default Value

""

Remarks

This property indicates the network through which the transaction was authorized. If this property contains a "V" or a "5", this indicates the transaction was processed as a credit card purchase transaction even though it was originally submitted as a debit transaction. When these values ("V" or "5") are returned, the transaction must be settled as a credit card (non-debit) transaction.

This property is valid for Debit card and EBT card transactions only. It will be ignored for all other TransactionTypes.

Data Type

String

DebitReimbursementAttribute Property (TSYSDetailRecord Class)

Contains the ReimbursementAttribute from the original Debit or EBT request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDebitReimbursementAttribute();
int SetDebitReimbursementAttribute(int iDebitReimbursementAttribute);

Unicode (Windows)
INT GetDebitReimbursementAttribute();
INT SetDebitReimbursementAttribute(INT iDebitReimbursementAttribute);

RA_STANDARD_RETAIL(0), 
RA_QUALIFIED_GROCERY(1), 
RA_PRE_EXISTING_RETAIL(2), 
RA_PRE_EXISTING_GROCERY(3), 
RA_NON_DEBIT(4), 
RA_TAX_EXEMPT(5)

int dpaymentssdk_tsysdetailrecord_getdebitreimbursementattribute(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setdebitreimbursementattribute(void* lpObj, int iDebitReimbursementAttribute);

int GetDebitReimbursementAttribute();
int SetDebitReimbursementAttribute(int iDebitReimbursementAttribute);

Default Value

0

Remarks

The following values are valid for Debit and EBT:

This property is valid for Debit card transactions only. It must be set to raNonDebit for EBT card transactions, and it will be ignored for all other TransactionTypes.

Data Type

Integer

DebitRetrievalNumber Property (TSYSDetailRecord Class)

Contains the ResponseRetrievalNumber returned in original Debit or EBT response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitRetrievalNumber();
int SetDebitRetrievalNumber(const char* lpszDebitRetrievalNumber);

Unicode (Windows)
LPWSTR GetDebitRetrievalNumber();
INT SetDebitRetrievalNumber(LPCWSTR lpszDebitRetrievalNumber);

char* dpaymentssdk_tsysdetailrecord_getdebitretrievalnumber(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setdebitretrievalnumber(void* lpObj, const char* lpszDebitRetrievalNumber);

QString GetDebitRetrievalNumber();
int SetDebitRetrievalNumber(QString qsDebitRetrievalNumber);

Default Value

""

Remarks

This property contains the ResponseRetrievalNumber returned in the original debit authorization response message. It is utilized for transaction tracking purposes.

This property is valid for Debit card and EBT card transactions only. It will be ignored for all other TransactionTypes.

Data Type

String

DebitSettleDate Property (TSYSDetailRecord Class)

Contains the ResponseSettleDate returned in the original Debit or EBT response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitSettleDate();
int SetDebitSettleDate(const char* lpszDebitSettleDate);

Unicode (Windows)
LPWSTR GetDebitSettleDate();
INT SetDebitSettleDate(LPCWSTR lpszDebitSettleDate);

char* dpaymentssdk_tsysdetailrecord_getdebitsettledate(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setdebitsettledate(void* lpObj, const char* lpszDebitSettleDate);

QString GetDebitSettleDate();
int SetDebitSettleDate(QString qsDebitSettleDate);

Default Value

""

Remarks

This property contains the settlement date returned in the original debit authorization response message. the settlement date must be provided in MMDD format, and is utilized for transaction tracking purposes.

This property is valid for Debit card and EBT card transactions only. It will be ignored for all other TransactionTypes.

Data Type

String

DebitTrace Property (TSYSDetailRecord Class)

Contains the ResponseTrace returned from the original debit or EBT response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitTrace();
int SetDebitTrace(const char* lpszDebitTrace);

Unicode (Windows)
LPWSTR GetDebitTrace();
INT SetDebitTrace(LPCWSTR lpszDebitTrace);

char* dpaymentssdk_tsysdetailrecord_getdebittrace(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setdebittrace(void* lpObj, const char* lpszDebitTrace);

QString GetDebitTrace();
int SetDebitTrace(QString qsDebitTrace);

Default Value

""

Remarks

This property contains the system trace audit number returned in the original debit authorization response message. This property is utilized for transaction tracking purposes, and is only valid for Debit card and EBT card transactions. It will be ignored for all other TransactionTypes.

Data Type

String

ECI Property (TSYSDetailRecord 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_tsysdetailrecord_geteci(void* lpObj);
int dpaymentssdk_tsysdetailrecord_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 (TSYSDetailRecord Class)

This property identifies the source of the customer data.

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_2CHIP_CAPABLE(6), 
EDS_MANUAL_ENTRY_CHIP_CAPABLE(7)

int dpaymentssdk_tsysdetailrecord_getentrydatasource(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setentrydatasource(void* lpObj, int iEntryDataSource);

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

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.

Data Type

Integer

GoodsIndicator Property (TSYSDetailRecord Class)

Used to identify the type of goods purchased over the Internet.

Syntax

• C++
• C
• Qt

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

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

TGI_NOT_USED(0), 
TGI_DIGITAL_GOODS(1), 
TGI_PHYSICAL_GOODS(2)

int dpaymentssdk_tsysdetailrecord_getgoodsindicator(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setgoodsindicator(void* lpObj, int iGoodsIndicator);

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

Default Value

0

Remarks

This property is used to identify the type of goods purchased over the Internet. Supported types are shown below.

Data Type

Integer

Gratuity Property (TSYSDetailRecord Class)

Gratuity amount for settling restaurant/retail industry transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGratuity();
int SetGratuity(const char* lpszGratuity);

Unicode (Windows)
LPWSTR GetGratuity();
INT SetGratuity(LPCWSTR lpszGratuity);

char* dpaymentssdk_tsysdetailrecord_getgratuity(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setgratuity(void* lpObj, const char* lpszGratuity);

QString GetGratuity();
int SetGratuity(QString qsGratuity);

Default Value

""

Remarks

This field contains the gratuity (tip) amount of the transaction being settled. This amount is only sent when the TSYSSettle class's IndustryType is set to "sitRestaurant", "sitRetail " or "sitGroceryStore".

For transactions with Tip at the time of sale, the value of TransactionAmount in the original authorization request must reflect the cost of the goods/service purchased plus this Gratuity amount.

For example, to add a gratuity at the time of sale:

//Cost of goods/services purchased is $10 and Gratuity/Tip amount is $2 TSYSRetail.TransactionAmount = "1200" //$12 TSYSRetail.Authorize() DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) //SettlementAmount in the Detail Record equals the original authorized amount $12 DetailRecord.Gratuity = "200" //Indicates the Gratuity/Tip included at the time of sale $2 TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

For Tip Adjusts (transactions where Gratuity/Tip is included after the time of sale), the SettlementAmount must reflect the total of the AuthorizedAmount plus the Gratuity.

For example, to perform a Tip Adjust/adding the gratuity after the time of sale:

//Cost of goods/services purchased is $10; TSYSRetail.TransactionAmount = "1000" TSYSRetail.Authorize() DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) DetailRecord.Gratuity = "200" //Indicates the Gratuity/Tip added after the time of Sale $2 //SettlementAmount must include the tip, therefore it is higher than the original AuthorizedAmount DetailRecord.SettlementAmount = DetailRecord.AuthorizedAmount + DetailRecord.Gratuity TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

NOTE: TSYS does not support Credit/Debit transactions containing both CashOver/CashBack and Gratuity/Tip amounts.

Data Type

String

Healthcare Property (TSYSDetailRecord Class)

Indicates whether this is a healthcare transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHealthcare();
int SetHealthcare(int bHealthcare);

Unicode (Windows)
BOOL GetHealthcare();
INT SetHealthcare(BOOL bHealthcare);

int dpaymentssdk_tsysdetailrecord_gethealthcare(void* lpObj);
int dpaymentssdk_tsysdetailrecord_sethealthcare(void* lpObj, int bHealthcare);

bool GetHealthcare();
int SetHealthcare(bool bHealthcare);

Default Value

FALSE

Remarks

When settling IIAS auto-substantiated healthcare transactions, this property should be set to true. It is only necessary to modify this setting when sending off-line transactions or when not using the ParseAggregate method. XML Aggregates passed from the TSYSHealthCare class to the ParseAggregate method of this class will already be marked as healthcare transactions.

Data Type

Boolean

HotelChargeType Property (TSYSDetailRecord Class)

Type of charge made at a hotel (American Express cards only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHotelChargeType();
int SetHotelChargeType(int iHotelChargeType);

Unicode (Windows)
INT GetHotelChargeType();
INT SetHotelChargeType(INT iHotelChargeType);

CT_HOTEL(0), 
CT_RESTAURANT(1), 
CT_GIFT_SHOP(2)

int dpaymentssdk_tsysdetailrecord_gethotelchargetype(void* lpObj);
int dpaymentssdk_tsysdetailrecord_sethotelchargetype(void* lpObj, int iHotelChargeType);

int GetHotelChargeType();
int SetHotelChargeType(int iHotelChargeType);

Default Value

0

Remarks

This property contains an indicator used to identify a hotel charge type. It must contain one of the values defined below:

• ctHotel (0)
• ctRestaurant (1)
• ctGiftShop (2)

Note, this property is only applicable when using the Hotel IndustryType for American Express transactions.

If this property is set to ctHotel, RentalNoShow must equal " ", "2", or "3". For any other value, RentalNoShow must equal "1".

Data Type

Integer

HotelRateAmount Property (TSYSDetailRecord Class)

The nightly rate for this hotel room (American Express cards only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHotelRateAmount();
int SetHotelRateAmount(const char* lpszHotelRateAmount);

Unicode (Windows)
LPWSTR GetHotelRateAmount();
INT SetHotelRateAmount(LPCWSTR lpszHotelRateAmount);

char* dpaymentssdk_tsysdetailrecord_gethotelrateamount(void* lpObj);
int dpaymentssdk_tsysdetailrecord_sethotelrateamount(void* lpObj, const char* lpszHotelRateAmount);

QString GetHotelRateAmount();
int SetHotelRateAmount(QString qsHotelRateAmount);

Default Value

"0"

Remarks

This property contains the nightly rate for one room at the lodging property. This property is optional on all card types except Amex and may be set to zero. For Amex cards, this field must be greater than zero and less than or equal to $999.99 if ctHotel HotelChargeType and sitHotel IndustryType.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

IndustryType Property (TSYSDetailRecord Class)

Code which indicates the industry the merchant is engaged in.

Syntax

• C++
• C
• Qt

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

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

SIT_UNKNOWN(0), 
SIT_RETAIL(1), 
SIT_RESTAURANT(2), 
SIT_GROCERY_STORE(3), 
SIT_DIRECT_MARKETING(4), 
SIT_HOTEL(5), 
SIT_AUTO_RENTAL(6), 
SIT_PASSENGER_TRANSPORT(7)

int dpaymentssdk_tsysdetailrecord_getindustrytype(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setindustrytype(void* lpObj, int iIndustryType);

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

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Data Type

Integer

InstallmentCount Property (TSYSDetailRecord Class)

Total number of installments (installment transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInstallmentCount();
int SetInstallmentCount(const char* lpszInstallmentCount);

Unicode (Windows)
LPWSTR GetInstallmentCount();
INT SetInstallmentCount(LPCWSTR lpszInstallmentCount);

char* dpaymentssdk_tsysdetailrecord_getinstallmentcount(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setinstallmentcount(void* lpObj, const char* lpszInstallmentCount);

QString GetInstallmentCount();
int SetInstallmentCount(QString qsInstallmentCount);

Default Value

""

Remarks

This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the TSYSECommerce class.

Data Type

String

InstallmentNumber Property (TSYSDetailRecord Class)

Current installment number (installment transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInstallmentNumber();
int SetInstallmentNumber(const char* lpszInstallmentNumber);

Unicode (Windows)
LPWSTR GetInstallmentNumber();
INT SetInstallmentNumber(LPCWSTR lpszInstallmentNumber);

char* dpaymentssdk_tsysdetailrecord_getinstallmentnumber(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setinstallmentnumber(void* lpObj, const char* lpszInstallmentNumber);

QString GetInstallmentNumber();
int SetInstallmentNumber(QString qsInstallmentNumber);

Default Value

""

Remarks

This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the TSYSECommerce class.

Data Type

String

LodgingRenterName Property (TSYSDetailRecord Class)

Name of the person or business entity charged for the reservation and/or lodging stay (hotel transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLodgingRenterName();
int SetLodgingRenterName(const char* lpszLodgingRenterName);

Unicode (Windows)
LPWSTR GetLodgingRenterName();
INT SetLodgingRenterName(LPCWSTR lpszLodgingRenterName);

char* dpaymentssdk_tsysdetailrecord_getlodgingrentername(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setlodgingrentername(void* lpObj, const char* lpszLodgingRenterName);

QString GetLodgingRenterName();
int SetLodgingRenterName(QString qsLodgingRenterName);

Default Value

""

Remarks

In the Hotel IndustryType, this property must contain the name of the individual or business entity charged for the reservation and/or lodging stay. The maximum length of this property is 26 characters (upper-case). This property is ignored for all other IndustryTypes.

Data Type

String

PartiallyReversed Property (TSYSDetailRecord Class)

Indicates whether this transaction has been partially reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPartiallyReversed();
int SetPartiallyReversed(int bPartiallyReversed);

Unicode (Windows)
BOOL GetPartiallyReversed();
INT SetPartiallyReversed(BOOL bPartiallyReversed);

int dpaymentssdk_tsysdetailrecord_getpartiallyreversed(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setpartiallyreversed(void* lpObj, int bPartiallyReversed);

bool GetPartiallyReversed();
int SetPartiallyReversed(bool bPartiallyReversed);

Default Value

FALSE

Remarks

After partially reversing a transaction using the TSYSReversal class, the TotalAuthorizedAmount should indicate the sum total of all authorized amounts, the SettlementAmount should indicate the new settlement amount, and the PartiallyReversed property should be set to True to indicate to the host that this transaction has been partially reversed.

Data Type

Boolean

PassengerCount Property (TSYSDetailRecord Class)

Total number of passengers (multiple passenger transport transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPassengerCount();
int SetPassengerCount(int iPassengerCount);

Unicode (Windows)
INT GetPassengerCount();
INT SetPassengerCount(INT iPassengerCount);

int dpaymentssdk_tsysdetailrecord_getpassengercount(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setpassengercount(void* lpObj, int iPassengerCount);

int GetPassengerCount();
int SetPassengerCount(int iPassengerCount);

Default Value

1

Remarks

This property is used when there are multiple passengers on the same authorization. The PassengerCount indicates the total number of passengers for a specific authorization code, and the PassengerNumber indicates the current passenger. Only Visa card transactions can be captured for Passenger Transport industry type. You need to set additional required Passenger Transport related information using the respective configuration settings.

NOTE: PassengerNumber cannot be greater than PassengerCount

To settle a Passenger Transport transaction authorized with the sitPassengerTransport IndustryType, you must use the TSYSDetailRecord class to add the number of this passenger and the total count of all passengers in the authorization code. For instance, if the authorization transaction included "Three passengers", and this is the first passenger, then the passenger number will be 1, and the passenger count 3. An example is included below:

TSYSRetail.IndustryType = sitPassengerTransport TSYSRetail.Authorize() DetailRecord.ParseAggregate TSYSRetail.GetDetailAggregate() DetailRecord.PassengerCount = 3 DetailRecord.PassengerNumber = 1 DetailRecord.Config("RestrictedTicketIndicator=True") DetailRecord.Config("TicketNumber=8382152100395") DetailRecord.Config("PassengerName=John Smith") DetailRecord.Config("DepartureDate=072117") DetailRecord.Config("Origin=JFK") DetailRecord.Config("Leg1=Carrier=DL;ServiceClass=C;StopOver=X;Destination=LAX") TSYSSettle1.IndustryType = sitPassengerTransport TSYSSettle1.Config("TravelAgencyCode=12345678") 'if ticket was issued by a travel agency TSYSSettle1.Config("TravelAgencyName=Travel and Tours") 'if ticket was issued by a travel agency TSYSSettle1.DetailAggregate[5] = DetailRecord.GetDetailAggregate()

Data Type

Integer

PassengerNumber Property (TSYSDetailRecord Class)

Current passenger number (multiple passenger transport transactions only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPassengerNumber();
int SetPassengerNumber(int iPassengerNumber);

Unicode (Windows)
INT GetPassengerNumber();
INT SetPassengerNumber(INT iPassengerNumber);

int dpaymentssdk_tsysdetailrecord_getpassengernumber(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setpassengernumber(void* lpObj, int iPassengerNumber);

int GetPassengerNumber();
int SetPassengerNumber(int iPassengerNumber);

Default Value

1

Remarks

This property is used to identify a specific passenger when there are multiple passengers on the same authorization. The PassengerCount indicates the total number of passengers for a specific authorization code, and the PassengerNumber indicates the current passenger. Only Visa card transactions can be captured for Passenger Transport industry type. You need to set additional required Passenger Transport related information using the respective configuration settings.

NOTE: Passenger Number cannot be greater than PassengerCount

To settle a Passenger Transport transaction authorized with the sitPassengerTransport IndustryType, you must use the TSYSDetailRecord class to add the number of this passenger and the total count of all passengers in the authorization code. For instance, if the authorization transaction included "Three passengers", and this is the first passenger, then the passenger number will be 1, and the passenger count 3. An example is included below:

TSYSRetail.IndustryType = sitPassengerTransport TSYSRetail.Authorize() DetailRecord.ParseAggregate TSYSRetail.GetDetailAggregate() DetailRecord.PassengerCount = 3 DetailRecord.PassengerNumber = 1 DetailRecord.Config("RestrictedTicketIndicator=True") DetailRecord.Config("TicketNumber=8382152100395") DetailRecord.Config("PassengerName=John Smith") DetailRecord.Config("DepartureDate=072117") DetailRecord.Config("Origin=JFK") DetailRecord.Config("Leg1=Carrier=DL;ServiceClass=C;StopOver=X;Destination=LAX") TSYSSettle1.IndustryType = sitPassengerTransport TSYSSettle1.Config("TravelAgencyCode=12345678") 'if ticket was issued by a travel agency TSYSSettle1.Config("TravelAgencyName=Travel and Tours") 'if ticket was issued by a travel agency TSYSSettle1.DetailAggregate[5] = DetailRecord.GetDetailAggregate()

Data Type

Integer

PurchaseIdentifier Property (TSYSDetailRecord Class)

Optional purchase order number assigned by the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPurchaseIdentifier();
int SetPurchaseIdentifier(const char* lpszPurchaseIdentifier);

Unicode (Windows)
LPWSTR GetPurchaseIdentifier();
INT SetPurchaseIdentifier(LPCWSTR lpszPurchaseIdentifier);

char* dpaymentssdk_tsysdetailrecord_getpurchaseidentifier(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setpurchaseidentifier(void* lpObj, const char* lpszPurchaseIdentifier);

QString GetPurchaseIdentifier();
int SetPurchaseIdentifier(QString qsPurchaseIdentifier);

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and will be automatically left-justified, space-filled to 25 spaces.

This field is applicable to E-Commerce, Hotel, and Auto Rental transactions.

Note: For the Hotel IndustryType, this property will contain the Hotel Folio Number. For the Auto Rental IndustryType, it should indicate the Rental Agreement Number.

Failure to set a PurchaseIdentifier for the e-commerce IndustryType may result in a CPS downgrade when the transaction is settled. This can result in higher interchange rates.

Data Type

String

RentalCheckIn Property (TSYSDetailRecord Class)

Date the cardholder checked into the hotel or first drove away a rented vehicle.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRentalCheckIn();
int SetRentalCheckIn(const char* lpszRentalCheckIn);

Unicode (Windows)
LPWSTR GetRentalCheckIn();
INT SetRentalCheckIn(LPCWSTR lpszRentalCheckIn);

char* dpaymentssdk_tsysdetailrecord_getrentalcheckin(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentalcheckin(void* lpObj, const char* lpszRentalCheckIn);

QString GetRentalCheckIn();
int SetRentalCheckIn(QString qsRentalCheckIn);

Default Value

"010101"

Remarks

For the Hotel IndustryType, this property contains the date (in MMDDYY format) reflecting when the cardholder checked into the hotel. If the transaction is an advance check-in, this field should contain the date on which the reservation was made. If the transaction is a No Show, this field must contain the anticipated hotel arrival date.

For the Auto Rental IndustryType, this property contains the date (in MMDDYY format) when the cardholder first drove away the rented vehicle.

Data Type

String

RentalExtraCharges Property (TSYSDetailRecord Class)

List of extra charges for Hotel/Auto transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRentalExtraCharges();
int SetRentalExtraCharges(const char* lpszRentalExtraCharges);

Unicode (Windows)
LPWSTR GetRentalExtraCharges();
INT SetRentalExtraCharges(LPCWSTR lpszRentalExtraCharges);

char* dpaymentssdk_tsysdetailrecord_getrentalextracharges(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentalextracharges(void* lpObj, const char* lpszRentalExtraCharges);

QString GetRentalExtraCharges();
int SetRentalExtraCharges(QString qsRentalExtraCharges);

Default Value

"0"

Remarks

This property contains a six-character numeric value used to identify any additional ancillary charges that are booked to the cardholder's card after the transaction was completed. The merchant may enter one or more codes on each transaction being settled. If extra charges are being submitted, this field must contain value(s) as defined below.

For example, in the Hotel industry to indicate charges in both the gift shop and mini bar, RentalExtraCharges should equal "34".

Note that this property is only applicable for the Hotel and Auto Rental IndustryTypes, and will not be sent for any other IndustryType.

Data Type

String

RentalNoShow Property (TSYSDetailRecord Class)

Indicates whether the cardholder is a no-show (auto rental and hotel industries only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRentalNoShow();
int SetRentalNoShow(const char* lpszRentalNoShow);

Unicode (Windows)
LPWSTR GetRentalNoShow();
INT SetRentalNoShow(LPCWSTR lpszRentalNoShow);

char* dpaymentssdk_tsysdetailrecord_getrentalnoshow(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentalnoshow(void* lpObj, const char* lpszRentalNoShow);

QString GetRentalNoShow();
int SetRentalNoShow(QString qsRentalNoShow);

Default Value

"0"

Remarks

This property contains a one-character identifier used to indicate whether the cardholder is being billed for a hotel room or rental vehicle that was reserved, but not actually rented. The following values are valid for any card except American Express cards:

For American Express cards, this property is used to indicate whether the cardholder is participating in a special program. Allowable values include:

This property is only applicable for the Auto Rental and Hotel IndustryTypes.

Data Type

String

RentalReturnCity Property (TSYSDetailRecord Class)

City where the rental car was returned (MasterCard only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRentalReturnCity();
int SetRentalReturnCity(const char* lpszRentalReturnCity);

Unicode (Windows)
LPWSTR GetRentalReturnCity();
INT SetRentalReturnCity(LPCWSTR lpszRentalReturnCity);

char* dpaymentssdk_tsysdetailrecord_getrentalreturncity(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentalreturncity(void* lpObj, const char* lpszRentalReturnCity);

QString GetRentalReturnCity();
int SetRentalReturnCity(QString qsRentalReturnCity);

Default Value

""

Remarks

For MasterCard transactions in the Auto Rental IndustryType, this property must contain the city where the rented vehicle was returned. The maximum length of this property is 18 characters, and it may not remain all spaces. This property is ignored for all other IndustryTypes and all other card types.

Data Type

String

RentalReturnLocation Property (TSYSDetailRecord Class)

Id of the location where the rental vehicle was returned (MasterCard only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRentalReturnLocation();
int SetRentalReturnLocation(const char* lpszRentalReturnLocation);

Unicode (Windows)
LPWSTR GetRentalReturnLocation();
INT SetRentalReturnLocation(LPCWSTR lpszRentalReturnLocation);

char* dpaymentssdk_tsysdetailrecord_getrentalreturnlocation(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentalreturnlocation(void* lpObj, const char* lpszRentalReturnLocation);

QString GetRentalReturnLocation();
int SetRentalReturnLocation(QString qsRentalReturnLocation);

Default Value

""

Remarks

For MasterCard transactions in the Auto Rental IndustryType, this property must contain an identifier indicating the location where the rented vehicle was returned. The maximum length of this property is 10 characters, and it may not remain all spaces. This property is ignored for all other IndustryTypes and all other card types.

Data Type

String

RentalReturnState Property (TSYSDetailRecord Class)

State or country where the rental car was returned (MasterCard only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRentalReturnState();
int SetRentalReturnState(const char* lpszRentalReturnState);

Unicode (Windows)
LPWSTR GetRentalReturnState();
INT SetRentalReturnState(LPCWSTR lpszRentalReturnState);

char* dpaymentssdk_tsysdetailrecord_getrentalreturnstate(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentalreturnstate(void* lpObj, const char* lpszRentalReturnState);

QString GetRentalReturnState();
int SetRentalReturnState(QString qsRentalReturnState);

Default Value

""

Remarks

For MasterCard transactions in the Auto Rental IndustryType, this property must contain a code indicating the name of the state, province, or country where the rented vehicle was returned. The maximum length of this property is 3 characters, and it may not remain all spaces. This property is ignored for all other IndustryTypes and all other card types.

Data Type

String

RenterName Property (TSYSDetailRecord Class)

Name of the person renting the vehicle (MasterCard only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRenterName();
int SetRenterName(const char* lpszRenterName);

Unicode (Windows)
LPWSTR GetRenterName();
INT SetRenterName(LPCWSTR lpszRenterName);

char* dpaymentssdk_tsysdetailrecord_getrentername(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrentername(void* lpObj, const char* lpszRenterName);

QString GetRenterName();
int SetRenterName(QString qsRenterName);

Default Value

""

Remarks

For MasterCard transactions in the Auto Rental IndustryType, this property must contain the name of the individual renting the vehicle. The maximum length of this property is 20 characters, and it may not remain all spaces. This property is ignored for all other IndustryTypes and all other card types.

Data Type

String

RequestedACI Property (TSYSDetailRecord Class)

Authorization Characteristics Indicator from the original authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRequestedACI();
int SetRequestedACI(const char* lpszRequestedACI);

Unicode (Windows)
LPWSTR GetRequestedACI();
INT SetRequestedACI(LPCWSTR lpszRequestedACI);

char* dpaymentssdk_tsysdetailrecord_getrequestedaci(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setrequestedaci(void* lpObj, const char* lpszRequestedACI);

QString GetRequestedACI();
int SetRequestedACI(QString qsRequestedACI);

Default Value

""

Remarks

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

Data Type

String

ResponseACI Property (TSYSDetailRecord Class)

Authorization Characteristics Indicator from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseACI();
int SetResponseACI(const char* lpszResponseACI);

Unicode (Windows)
LPWSTR GetResponseACI();
INT SetResponseACI(LPCWSTR lpszResponseACI);

char* dpaymentssdk_tsysdetailrecord_getresponseaci(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setresponseaci(void* lpObj, const char* lpszResponseACI);

QString GetResponseACI();
int SetResponseACI(QString qsResponseACI);

Default Value

""

Remarks

This field contains a one character returned Authorization Characteristics Indicator. This indicator provides information on conditions or characteristics of the authorization code. If the transaction being settled was authorized on-line, this field must contain the value returned in that authorization response. If the transaction is a credit or was otherwise processed off-line, this field should be defaulted to SPACE.

Data Type

String

ResponseApprovalCode Property (TSYSDetailRecord Class)

Response Approval Code from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();
int SetResponseApprovalCode(const char* lpszResponseApprovalCode);

Unicode (Windows)
LPWSTR GetResponseApprovalCode();
INT SetResponseApprovalCode(LPCWSTR lpszResponseApprovalCode);

char* dpaymentssdk_tsysdetailrecord_getresponseapprovalcode(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setresponseapprovalcode(void* lpObj, const char* lpszResponseApprovalCode);

QString GetResponseApprovalCode();
int SetResponseApprovalCode(QString qsResponseApprovalCode);

Default Value

""

Remarks

This field contains the authorization code obtained from the original authorization response. If the transaction is a credit or other non-approved transaction type, this property must be empty.

Data Type

String

ResponseAuthSource Property (TSYSDetailRecord Class)

Auth Source Code from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthSource();
int SetResponseAuthSource(const char* lpszResponseAuthSource);

Unicode (Windows)
LPWSTR GetResponseAuthSource();
INT SetResponseAuthSource(LPCWSTR lpszResponseAuthSource);

char* dpaymentssdk_tsysdetailrecord_getresponseauthsource(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setresponseauthsource(void* lpObj, const char* lpszResponseAuthSource);

QString GetResponseAuthSource();
int SetResponseAuthSource(QString qsResponseAuthSource);

Default Value

""

Remarks

This field contains a one character authorization source code used to provide information on the source or origin of the ResponseApprovalCode being settled. If the transaction being settled was network authorized, this field must contain the value returned in the authorization response. If the transaction is a credit, or otherwise processed off-line, this field must contain one of the values below.

Data Type

String

ResponseAVS Property (TSYSDetailRecord Class)

Address Verification Code from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVS();
int SetResponseAVS(const char* lpszResponseAVS);

Unicode (Windows)
LPWSTR GetResponseAVS();
INT SetResponseAVS(LPCWSTR lpszResponseAVS);

char* dpaymentssdk_tsysdetailrecord_getresponseavs(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setresponseavs(void* lpObj, const char* lpszResponseAVS);

QString GetResponseAVS();
int SetResponseAVS(QString qsResponseAVS);

Default Value

"0"

Remarks

This field contains a one character Address Verification (result) Code. This field contains the value returned in the original authorization response message. If the transaction is a credit or was otherwise processed off-line, this field should be defaulted to "0".

Data Type

String

ResponseCardLevel Property (TSYSDetailRecord Class)

Card Level results returned from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCardLevel();
int SetResponseCardLevel(const char* lpszResponseCardLevel);

Unicode (Windows)
LPWSTR GetResponseCardLevel();
INT SetResponseCardLevel(LPCWSTR lpszResponseCardLevel);

char* dpaymentssdk_tsysdetailrecord_getresponsecardlevel(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setresponsecardlevel(void* lpObj, const char* lpszResponseCardLevel);

QString GetResponseCardLevel();
int SetResponseCardLevel(QString qsResponseCardLevel);

Default Value

""

Remarks

This property contains a two-character code created by Visa during the authorization process. If the transaction being settled was authorized online, this property must contain the value returned in the authorization response. If the transaction is a credit or a force, this property should be left empty. Note that Card Level Results are only applicable to Visa cards.

Data Type

String

ResponseCode Property (TSYSDetailRecord Class)

Response code from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();
int SetResponseCode(const char* lpszResponseCode);

Unicode (Windows)
LPWSTR GetResponseCode();
INT SetResponseCode(LPCWSTR lpszResponseCode);

char* dpaymentssdk_tsysdetailrecord_getresponsecode(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setresponsecode(void* lpObj, const char* lpszResponseCode);

QString GetResponseCode();
int SetResponseCode(QString qsResponseCode);

Default Value

""

Remarks

This field contains a two character Response Code associated with the Authorization Code being settled. If the transaction being settled was authorized on-line, this field must contain the value returned in that authorization response. If the transaction is a credit or off-line approval, this field must be defaulted to spaces.

Data Type

String

SettlementAmount Property (TSYSDetailRecord 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_tsysdetailrecord_getsettlementamount(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setsettlementamount(void* lpObj, const char* lpszSettlementAmount);

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

Default Value

"0"

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 Gratuity amount, the SettlementAmount must reflect the total of the AuthorizedAmount plus the Gratuity (this is only applicable to the itResturant IndustryType).

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

Substantiated Property (TSYSDetailRecord Class)

Used for HealthCare transactions. Identifies if the merchant verified the purchased items against an Inventory Information Approval System (IIAS).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSubstantiated();
int SetSubstantiated(int iSubstantiated);

Unicode (Windows)
INT GetSubstantiated();
INT SetSubstantiated(INT iSubstantiated);

int dpaymentssdk_tsysdetailrecord_getsubstantiated(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setsubstantiated(void* lpObj, int iSubstantiated);

int GetSubstantiated();
int SetSubstantiated(int iSubstantiated);

Default Value

1

Remarks

This field should be identical to the value of the Substantiated property sent in the authorization via the TSYSHealthCare class. This field is only sent for MasterCard transactions.

Data Type

Integer

TotalAuthorizedAmount Property (TSYSDetailRecord Class)

Sum total of all the original authorization and all subsequent incremental authorizations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalAuthorizedAmount();
int SetTotalAuthorizedAmount(const char* lpszTotalAuthorizedAmount);

Unicode (Windows)
LPWSTR GetTotalAuthorizedAmount();
INT SetTotalAuthorizedAmount(LPCWSTR lpszTotalAuthorizedAmount);

char* dpaymentssdk_tsysdetailrecord_gettotalauthorizedamount(void* lpObj);
int dpaymentssdk_tsysdetailrecord_settotalauthorizedamount(void* lpObj, const char* lpszTotalAuthorizedAmount);

QString GetTotalAuthorizedAmount();
int SetTotalAuthorizedAmount(QString qsTotalAuthorizedAmount);

Default Value

""

Remarks

When supporting incremental authorizations, you must manually keep track of the sum of all authorizations made for a single transaction (all based on the same transaction id). This total must be added to the TotalAuthorizedAmount property of the detail record associated with the first authorization. Only one detail record should be submitted no matter how many incremental authorizations are attached to the transaction.

Data Type

String

TransactionDate Property (TSYSDetailRecord 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_tsysdetailrecord_gettransactiondate(void* lpObj);
int dpaymentssdk_tsysdetailrecord_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.

For the Hotel IndustryType, this property must contain the date the customer checked out of the hotel. For the Auto Rental IndustryType it should contain the date that the vehicle was returned.

Data Type

String

TransactionId Property (TSYSDetailRecord Class)

Transaction Identifier from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionId();
int SetTransactionId(const char* lpszTransactionId);

Unicode (Windows)
LPWSTR GetTransactionId();
INT SetTransactionId(LPCWSTR lpszTransactionId);

char* dpaymentssdk_tsysdetailrecord_gettransactionid(void* lpObj);
int dpaymentssdk_tsysdetailrecord_settransactionid(void* lpObj, const char* lpszTransactionId);

QString GetTransactionId();
int SetTransactionId(QString qsTransactionId);

Default Value

"000000000000000"

Remarks

This 15-character field contains a Transaction Identifier associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value (if returned) from the original authorization response message. If a value was not returned in the authorization response or the transaction was processed off-line, this field must be defaulted to zeros.

Data Type

String

TransactionNumber Property (TSYSDetailRecord Class)

Transaction Number from the original authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Unicode (Windows)
INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);

int dpaymentssdk_tsysdetailrecord_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsysdetailrecord_settransactionnumber(void* lpObj, int iTransactionNumber);

int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

0

Remarks

This field should contain the TransactionNumber from the original authorization request. This value must be in the range "0001" to "9999". "0000" is an invalid transaction number.

Data Type

Integer

TransactionTime Property (TSYSDetailRecord 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_tsysdetailrecord_gettransactiontime(void* lpObj);
int dpaymentssdk_tsysdetailrecord_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 (TSYSDetailRecord 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_CARD_NOT_PRESENT(0), 
DTT_CARD_PRESENT(1), 
DTT_OFF_LINE_CREDIT(2), 
DTT_FORCE_CARD_NOT_PRESENT(3), 
DTT_FORCE_CARD_PRESENT(4), 
DTT_DEBIT_PURCHASE(5), 
DTT_DEBIT_REFUND(6), 
DTT_FOOD_STAMP_PURCHASE(8), 
DTT_FOOD_STAMP_RETURN(9), 
DTT_FOOD_STAMP_VOUCHER(10), 
DTT_CASH_BENEFIT_WITHDRAWAL(12), 
DTT_CASH_BENEFIT_PURCHASE(13), 
DTT_ACHPURCHASE(30), 
DTT_ACHRETURN(31)

int dpaymentssdk_tsysdetailrecord_gettransactiontype(void* lpObj);
int dpaymentssdk_tsysdetailrecord_settransactiontype(void* lpObj, int iTransactionType);

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

Default Value

0

Remarks

This property indicates the type of transaction that was originally authorized. The following table explains the Transaction Types in detail:

Data Type

Integer

ValidationCode Property (TSYSDetailRecord Class)

Validation Code from the original authorization response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetValidationCode();
int SetValidationCode(const char* lpszValidationCode);

Unicode (Windows)
LPWSTR GetValidationCode();
INT SetValidationCode(LPCWSTR lpszValidationCode);

char* dpaymentssdk_tsysdetailrecord_getvalidationcode(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setvalidationcode(void* lpObj, const char* lpszValidationCode);

QString GetValidationCode();
int SetValidationCode(QString qsValidationCode);

Default Value

""

Remarks

This field contains a four character Transaction Identifier associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value (if returned) from the original authorization response message. If a value was not returned in the authorization response or the transaction was processed off-line, this field must be empty.

Data Type

String

VoidTransaction Property (TSYSDetailRecord Class)

Indicates whether this transaction has been voided.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVoidTransaction();
int SetVoidTransaction(int bVoidTransaction);

Unicode (Windows)
BOOL GetVoidTransaction();
INT SetVoidTransaction(BOOL bVoidTransaction);

int dpaymentssdk_tsysdetailrecord_getvoidtransaction(void* lpObj);
int dpaymentssdk_tsysdetailrecord_setvoidtransaction(void* lpObj, int bVoidTransaction);

bool GetVoidTransaction();
int SetVoidTransaction(bool bVoidTransaction);

Default Value

FALSE

Remarks

If you wish to void a previously authorized transaction, Vital/TSYS recommends that you should exclude it from the settlement. However, you may also send the detail record with the VoidTransaction indicator set to True. For example:

DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) DetailRecord.VoidTransaction = True TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

Data Type

Boolean

Config Method (TSYSDetailRecord 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_tsysdetailrecord_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 (TSYSDetailRecord 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_tsysdetailrecord_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 TSYSSettle 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 TSYSDetailRecord 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:

TSYSRetail.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSRetail.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 (TSYSDetailRecord 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_tsysdetailrecord_parseaggregate(void* lpObj, const char* lpszAggregate);

int ParseAggregate(const QString& qsAggregate);

Remarks

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

For example, to add a gratuity to a charge:

DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) DetailRecord.Gratuity = "500" DetailRecord.SettlementAmount = DetailRecord.AuthorizedAmount + DetailRecord.Gratuity TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

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

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsysdetailrecord_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 (TSYSDetailRecord Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TSYSDETAILRECORD_ERROR 1

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

class TSYSDetailRecordErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass TSYSDetailRecord and override this emitter function.
virtual int FireError(TSYSDetailRecordErrorEventParams *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 (TSYSDetailRecord Class)

DetailRecord Config Settings

Base Config Settings

Trappable Errors (TSYSDetailRecord 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.

TSYSDetailRecord Errors