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

dpaymentssdk.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 DetailRecords 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.DetailRecords.Add(new TSYSRecordType(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 ApprovalCode 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.DetailRecords.Add(new TSYSRecordType(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

public String getAuthorizedAmount();


public void setAuthorizedAmount(String authorizedAmount);

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.

CardholderId Property (TSYSDetailRecord Class)

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

Syntax

public String getCardholderId();


public void setCardholderId(String cardholderId);

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.

CardNumber Property (TSYSDetailRecord Class)

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

Syntax

public String getCardNumber();


public void setCardNumber(String cardNumber);

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.

DebitCashBack Property (TSYSDetailRecord Class)

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

Syntax

public String getDebitCashBack();


public void setDebitCashBack(String debitCashBack);

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.

DebitNetworkId Property (TSYSDetailRecord Class)

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

Syntax

public String getDebitNetworkId();


public void setDebitNetworkId(String debitNetworkId);

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.

DebitReimbursementAttribute Property (TSYSDetailRecord Class)

Contains the ReimbursementAttribute from the original Debit or EBT request.

Syntax

public int getDebitReimbursementAttribute();


public void setDebitReimbursementAttribute(int debitReimbursementAttribute);


Enumerated values:
  public final static int raStandardRetail = 0;
  public final static int raQualifiedGrocery = 1;
  public final static int raPreExistingRetail = 2;
  public final static int raPreExistingGrocery = 3;
  public final static int raNonDebit = 4;
  public final static int raTaxExempt = 5;

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.

DebitRetrievalNumber Property (TSYSDetailRecord Class)

Contains the ResponseRetrievalNumber returned in original Debit or EBT response.

Syntax

public String getDebitRetrievalNumber();


public void setDebitRetrievalNumber(String debitRetrievalNumber);

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.

DebitSettleDate Property (TSYSDetailRecord Class)

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

Syntax

public String getDebitSettleDate();


public void setDebitSettleDate(String debitSettleDate);

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.

DebitTrace Property (TSYSDetailRecord Class)

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

Syntax

public String getDebitTrace();


public void setDebitTrace(String debitTrace);

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.

ECI Property (TSYSDetailRecord Class)

Electronic Commerce Indicator from the original authorization request.

Syntax

public String getECI();


public void setECI(String ECI);

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.

EntryDataSource Property (TSYSDetailRecord Class)

This property identifies the source of the customer data.

Syntax

public int getEntryDataSource();


public void setEntryDataSource(int entryDataSource);


Enumerated values:
  public final static int edsTrack1 = 0;
  public final static int edsTrack2 = 1;
  public final static int edsManualEntryTrack1Capable = 2;
  public final static int edsManualEntryTrack2Capable = 3;
  public final static int edsManualEntryNoCardReader = 4;
  public final static int edsTrack2ChipCapable = 6;
  public final static int edsManualEntryChipCapable = 7;

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.

GoodsIndicator Property (TSYSDetailRecord Class)

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

Syntax

public int getGoodsIndicator();


public void setGoodsIndicator(int goodsIndicator);


Enumerated values:
  public final static int tgiNotUsed = 0;
  public final static int tgiDigitalGoods = 1;
  public final static int tgiPhysicalGoods = 2;

Default Value

0

Remarks

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

Gratuity Property (TSYSDetailRecord Class)

Gratuity amount for settling restaurant/retail industry transactions.

Syntax

public String getGratuity();


public void setGratuity(String gratuity);

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.

Healthcare Property (TSYSDetailRecord Class)

Indicates whether this is a healthcare transaction.

Syntax

public boolean isHealthcare();


public void setHealthcare(boolean healthcare);

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.

HotelChargeType Property (TSYSDetailRecord Class)

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

Syntax

public int getHotelChargeType();


public void setHotelChargeType(int hotelChargeType);


Enumerated values:
  public final static int ctHotel = 0;
  public final static int ctRestaurant = 1;
  public final static int ctGiftShop = 2;

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

HotelRateAmount Property (TSYSDetailRecord Class)

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

Syntax

public String getHotelRateAmount();


public void setHotelRateAmount(String hotelRateAmount);

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.

IndustryType Property (TSYSDetailRecord Class)

Code which indicates the industry the merchant is engaged in.

Syntax

public int getIndustryType();


public void setIndustryType(int industryType);


Enumerated values:
  public final static int sitUnknown = 0;
  public final static int sitRetail = 1;
  public final static int sitRestaurant = 2;
  public final static int sitGroceryStore = 3;
  public final static int sitDirectMarketing = 4;
  public final static int sitHotel = 5;
  public final static int sitAutoRental = 6;
  public final static int sitPassengerTransport = 7;

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.

InstallmentCount Property (TSYSDetailRecord Class)

Total number of installments (installment transactions only).

Syntax

public String getInstallmentCount();


public void setInstallmentCount(String installmentCount);

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.

InstallmentNumber Property (TSYSDetailRecord Class)

Current installment number (installment transactions only).

Syntax

public String getInstallmentNumber();


public void setInstallmentNumber(String installmentNumber);

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.

LodgingRenterName Property (TSYSDetailRecord Class)

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

Syntax

public String getLodgingRenterName();


public void setLodgingRenterName(String lodgingRenterName);

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.

PartiallyReversed Property (TSYSDetailRecord Class)

Indicates whether this transaction has been partially reversed.

Syntax

public boolean isPartiallyReversed();


public void setPartiallyReversed(boolean partiallyReversed);

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.

PassengerCount Property (TSYSDetailRecord Class)

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

Syntax

public int getPassengerCount();


public void setPassengerCount(int passengerCount);

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

PassengerNumber Property (TSYSDetailRecord Class)

Current passenger number (multiple passenger transport transactions only).

Syntax

public int getPassengerNumber();


public void setPassengerNumber(int passengerNumber);

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

PurchaseIdentifier Property (TSYSDetailRecord Class)

Optional purchase order number assigned by the merchant.

Syntax

public String getPurchaseIdentifier();


public void setPurchaseIdentifier(String purchaseIdentifier);

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.

RentalCheckIn Property (TSYSDetailRecord Class)

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

Syntax

public String getRentalCheckIn();


public void setRentalCheckIn(String rentalCheckIn);

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.

RentalExtraCharges Property (TSYSDetailRecord Class)

List of extra charges for Hotel/Auto transactions.

Syntax

public String getRentalExtraCharges();


public void setRentalExtraCharges(String rentalExtraCharges);

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.

RentalNoShow Property (TSYSDetailRecord Class)

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

Syntax

public String getRentalNoShow();


public void setRentalNoShow(String rentalNoShow);

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.

RentalReturnCity Property (TSYSDetailRecord Class)

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

Syntax

public String getRentalReturnCity();


public void setRentalReturnCity(String rentalReturnCity);

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.

RentalReturnLocation Property (TSYSDetailRecord Class)

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

Syntax

public String getRentalReturnLocation();


public void setRentalReturnLocation(String rentalReturnLocation);

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.

RentalReturnState Property (TSYSDetailRecord Class)

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

Syntax

public String getRentalReturnState();


public void setRentalReturnState(String rentalReturnState);

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.

RenterName Property (TSYSDetailRecord Class)

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

Syntax

public String getRenterName();


public void setRenterName(String renterName);

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.

RequestedACI Property (TSYSDetailRecord Class)

Authorization Characteristics Indicator from the original authorization request.

Syntax

public String getRequestedACI();


public void setRequestedACI(String requestedACI);

Default Value

""

Remarks

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

ResponseACI Property (TSYSDetailRecord Class)

Authorization Characteristics Indicator from the original authorization response.

Syntax

public String getResponseACI();


public void setResponseACI(String responseACI);

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.

ResponseApprovalCode Property (TSYSDetailRecord Class)

Response Approval Code from the original authorization response.

Syntax

public String getResponseApprovalCode();


public void setResponseApprovalCode(String responseApprovalCode);

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.

ResponseAuthSource Property (TSYSDetailRecord Class)

Auth Source Code from the original authorization response.

Syntax

public String getResponseAuthSource();


public void setResponseAuthSource(String responseAuthSource);

Default Value

""

Remarks

This field contains a one character authorization source code used to provide information on the source or origin of the ApprovalCode 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.

ResponseAVS Property (TSYSDetailRecord Class)

Address Verification Code from the original authorization response.

Syntax

public String getResponseAVS();


public void setResponseAVS(String responseAVS);

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

ResponseCardLevel Property (TSYSDetailRecord Class)

Card Level results returned from the original authorization response.

Syntax

public String getResponseCardLevel();


public void setResponseCardLevel(String responseCardLevel);

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.

ResponseCode Property (TSYSDetailRecord Class)

Response code from the original authorization response.

Syntax

public String getResponseCode();


public void setResponseCode(String responseCode);

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.

SettlementAmount Property (TSYSDetailRecord Class)

The amount that the customer will be charged.

Syntax

public String getSettlementAmount();


public void setSettlementAmount(String settlementAmount);

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.

Substantiated Property (TSYSDetailRecord Class)

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

Syntax

public int getSubstantiated();


public void setSubstantiated(int substantiated);

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.

TotalAuthorizedAmount Property (TSYSDetailRecord Class)

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

Syntax

public String getTotalAuthorizedAmount();


public void setTotalAuthorizedAmount(String totalAuthorizedAmount);

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.

TransactionDate Property (TSYSDetailRecord Class)

Local Transaction Date from the original authorization response.

Syntax

public String getTransactionDate();


public void setTransactionDate(String transactionDate);

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.

TransactionId Property (TSYSDetailRecord Class)

Transaction Identifier from the original authorization response.

Syntax

public String getTransactionId();


public void setTransactionId(String transactionId);

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.

TransactionNumber Property (TSYSDetailRecord Class)

Transaction Number from the original authorization request.

Syntax

public int getTransactionNumber();


public void setTransactionNumber(int transactionNumber);

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.

TransactionTime Property (TSYSDetailRecord Class)

Local transaction time from the original authorization response.

Syntax

public String getTransactionTime();


public void setTransactionTime(String transactionTime);

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.

TransactionType Property (TSYSDetailRecord Class)

Indicates transaction type for this detail record.

Syntax

public int getTransactionType();


public void setTransactionType(int transactionType);


Enumerated values:
  public final static int dttCardNotPresent = 0;
  public final static int dttCardPresent = 1;
  public final static int dttOffLineCredit = 2;
  public final static int dttForceCardNotPresent = 3;
  public final static int dttForceCardPresent = 4;
  public final static int dttDebitPurchase = 5;
  public final static int dttDebitRefund = 6;
  public final static int dttFoodStampPurchase = 8;
  public final static int dttFoodStampReturn = 9;
  public final static int dttFoodStampVoucher = 10;
  public final static int dttCashBenefitWithdrawal = 12;
  public final static int dttCashBenefitPurchase = 13;
  public final static int dttACHPurchase = 30;
  public final static int dttACHReturn = 31;

Default Value

0

Remarks

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

ValidationCode Property (TSYSDetailRecord Class)

Validation Code from the original authorization response.

Syntax

public String getValidationCode();


public void setValidationCode(String validationCode);

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.

VoidTransaction Property (TSYSDetailRecord Class)

Indicates whether this transaction has been voided.

Syntax

public boolean isVoidTransaction();


public void setVoidTransaction(boolean voidTransaction);

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

Config Method (Tsysdetailrecord Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

GetDetailAggregate Method (Tsysdetailrecord Class)

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

Syntax

public String 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 throws an exception.

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

TSYSRetail.Authorize() TSYSSettle.DetailRecords.Add(new TSYSRecordType(TSYSRetail.GetDetailAggregate()));

ParseAggregate Method (Tsysdetailrecord Class)

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

Syntax

public void parseAggregate(String aggregate);

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

Reset Method (Tsysdetailrecord Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

Error Event (Tsysdetailrecord Class)

Information about errors during data delivery.

Syntax

public class DefaultTsysdetailrecordEventListener implements TsysdetailrecordEventListener {
  ...
  public void error(TsysdetailrecordErrorEvent e) {}
  ...
}

public class TsysdetailrecordErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (Tsysdetailrecord Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

DetailRecord Config Settings

Base Config Settings

Trappable Errors (Tsysdetailrecord Class)

TSYSDetailRecord Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	592   Invalid or unparseable aggregate.
	605   Invalid CardType.