FDMSDetailRecord Component

Properties   Methods   Events   Config Settings   Errors  

The FDMSDetailRecord component is a tool used to create off-line Credit or Force transactions to be settled by the FDMSSETTLE component. The FDMSDetailRecord component may also be used to modify the XML aggregates returned by the FDMSRETAIL or FDMSECOMMERCE component's GetDetailAggregate method.

Syntax

TibcFDMSDetailRecord

Remarks

Credit and Force transactions are off-line transactions. This means that there is no authorization of funds using the FDMSECommerce, FDMSRetail components. Instead, you must manually add these transactions to the settlement batch. The FDMSDetailRecord component can be used to create these transactions, which can then be added to the FDMSSettle component's DetailRecord array property.

To create a Credit, first set the TransactionType to fttCredit, and then set the IndustryType. CardEntryDataSource, and DirectMarketingType 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:

FDMSDetailRecord.TransactionType = fttCredit FDMSDetailRecord.IndustryType = fitDirectMarketing FDMSDetailRecord.CardEntryDataSource = edsManualEntryNoCardReader FDMSDetailRecord.DirectMarketingType = dmECommerce

Next, set the CardNumber, CardExpMonth, CardExpYear, SettlementAmount, and the current TransactionDate and TransactionTime. Since this example is a Direct Marketing transaction, we're also adding the PurchaseIdentifier. Note that since this is an off-line transaction, the AuthorizedAmount MUST be either zero or empty string.

FDMSDetailRecord.CardNumber = "4444333322221111" FDMSDetailRecord.CardExpMonth = 3 FDMSDetailRecord.CardExpYear = 2019 FDMSDetailRecord.AuthorizedAmount = "0" FDMSDetailRecord.SettlementAmount = "5000" '$50.00 FDMSDetailRecord.TransTime = "123456" ' Current time (12:34:56) FDMSDetailRecord.TransDate = "040506" ' Current date (MMDDYY) FDMSDetailRecord.PurchaseIdentifier = "123456"

Finally, set the FDMSSettle component's DetailRecord array property with the value returned by the GetDetailAggregate method. You've just added a Credit to the settlement.

FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSDetailRecord.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.

FDMSDetailRecord.TransactionType = fttForce FDMSDetailRecord.IndustryType = fitRetail FDMSDetailRecord.CardEntryDataSource = edsTrack1 FDMSDetailRecord.CardNumber = "4444333322221111" FDMSDetailRecord.CardExpMonth = 3 FDMSDetailRecord.CardExpYear = 2019 FDMSDetailRecord.AuthorizedAmount = "0" FDMSDetailRecord.SettlementAmount = "500000" '$5000.00 FDMSDetailRecord.TransTime = "123456" ' Current time (12:34:56) FDMSDetailRecord.TransDate = "040506" ' Current date (MMDDYY) FDMSDetailRecord.ResponseApprovalCode = "123456" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecord(0) = FDMSDetailRecord.GetDetailAggregate()

In addition to creating Credit and Force transactions, the FDMSDetailRecord component can be used to adjust the Detail Records returned from the FDMSECommerce and FDMSRetail components. The most common reasons to modify these detail records are to add a Gratuity (tip) to a charge (fitResturant IndustryType), or to add a PurchaseIdentifier or Installment payment info (fitDirectMarketing IndustryType) to the detail record.

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord component to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AuthorizedAmount Property (FDMSDetailRecord Component)

Original amount authorized before any reversals.

Syntax

property AuthorizedAmount: String read get_AuthorizedAmount write set_AuthorizedAmount;

Default Value

'0'

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.

CardEntryDataSource Property (FDMSDetailRecord Component)

This property identifies the source of the customer data.

Syntax

property CardEntryDataSource: TibcEntryDataSources read get_CardEntryDataSource write set_CardEntryDataSource;

TibcEntryDataSources = (
  edsTrack1,
  edsTrack2,
  edsManualEntryTrack1Capable,
  edsManualEntryTrack2Capable,
  edsManualEntryNoCardReader,
  edsTrack1Contactless,
  edsTrack2Contactless,
  edsManualEntryContactlessCapable,
  edsIVR,
  edsKiosk
);

Default Value

edsTrack1

Remarks

Allowable values include: This property contains a 1-character code identifying the source of the customer data.

CardExpMonth Property (FDMSDetailRecord Component)

Expiration month of the credit card specified in CardNumber .

Syntax

property CardExpMonth: Integer read get_CardExpMonth write set_CardExpMonth;

Default Value

1

Remarks

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

CardExpYear Property (FDMSDetailRecord Component)

Expiration year of the credit card specified in CardNumber .

Syntax

property CardExpYear: Integer read get_CardExpYear write set_CardExpYear;

Default Value

2000

Remarks

This field contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 cannot be specified.

CardLevelResults Property (FDMSDetailRecord Component)

Card Level result code returned only for Visa transactions.

Syntax

property CardLevelResults: String read get_CardLevelResults write set_CardLevelResults;

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 field must contain the value returned in the authorization response. If the transaction is a credit or was otherwise processed offline, this field should be defaulted to "" (empty string) or two spaces.

CardNumber Property (FDMSDetailRecord Component)

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

Syntax

property CardNumber: String read get_CardNumber write set_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.

CashBack Property (FDMSDetailRecord Component)

Amount of cash that was returned to the customer.

Syntax

property CashBack: String read get_CashBack write set_CashBack;

Default Value

''

Remarks

This property should reflect the cash back amount from the original debit or EBT card sale. The value sent in the settlement MUST be identical to the amount approved in the sale.

DebitReceipt Property (FDMSDetailRecord Component)

Merchant-generated number that identifies the debit or EBT transaction.

Syntax

property DebitReceipt: String read get_DebitReceipt write set_DebitReceipt;

Default Value

''

Remarks

A merchant must generate a ReceiptNumber for debit and EBT transactions made with the FDMSDebit and FDMSBenefit components. This receipt number must be passed to the settlement unmodified in this DebitReceipt property.

DirectMarketingType Property (FDMSDetailRecord Component)

Specifies the type of transaction to process.

Syntax

property DirectMarketingType: TibcFDMSDirectMarketingTypes read get_DirectMarketingType write set_DirectMarketingType;

TibcFDMSDirectMarketingTypes = (
  dmECommerce,
  dmMOTO,
  dmRecurring,
  dmInstallment
);

Default Value

dmECommerce

Remarks

The following types of transactions are supported by this component:

The value of this property will be ignored when the IndustryType is anything other than fitDirectMarketing.

ECI Property (FDMSDetailRecord Component)

Electronic Commerce Indicator from the original authorization request.

Syntax

property ECI: String read get_ECI write set_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.

Gratuity Property (FDMSDetailRecord Component)

Gratuity amount for settling restaurant industry transactions.

Syntax

property Gratuity: String read get_Gratuity write set_Gratuity;

Default Value

''

Remarks

This 5 character numeric field contains the gratuity (tip) amount of the transaction being settled. This amount is only sent when the CFDMSSettle component's IndustryType is set to "Restaurant".

IndustryType Property (FDMSDetailRecord Component)

Code which indicates the industry the merchant is engaged in.

Syntax

property IndustryType: TibcFDMSIndustryTypes read get_IndustryType write set_IndustryType;

TibcFDMSIndustryTypes = (
  fitUnknown,
  fitRetail,
  fitRestaurant,
  fitGroceryStore,
  fitDirectMarketing,
  fitHotel
);

Default Value

fitRetail

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

InstallmentCount Property (FDMSDetailRecord Component)

Total number of installments (installment transactions only).

Syntax

property InstallmentCount: Integer read get_InstallmentCount write set_InstallmentCount;

Default Value

0

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 FDMSECommerce component.

To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord component to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

InstallmentNumber Property (FDMSDetailRecord Component)

Current installment number (installment transactions only).

Syntax

property InstallmentNumber: Integer read get_InstallmentNumber write set_InstallmentNumber;

Default Value

0

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 FDMSECommerce component.

To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord component to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

PurchaseIdentifier Property (FDMSDetailRecord Component)

Optional purchase order number assigned by the merchant.

Syntax

property PurchaseIdentifier: String read get_PurchaseIdentifier write set_PurchaseIdentifier;

Default Value

''

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and has a maximum length of 25 characters. For American Express transactions, only use the first 9 spaces.

ResponseApprovalCode Property (FDMSDetailRecord Component)

Response Approval Code from the original authorization response.

Syntax

property ResponseApprovalCode: String read get_ResponseApprovalCode write set_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.

ResponseAVSResult Property (FDMSDetailRecord Component)

Address Verification Code from the original authorization response.

Syntax

property ResponseAVSResult: String read get_ResponseAVSResult write set_ResponseAVSResult;

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

ResponseReturnedACI Property (FDMSDetailRecord Component)

Authorization Characteristics Indicator from the original authorization response.

Syntax

property ResponseReturnedACI: String read get_ResponseReturnedACI write set_ResponseReturnedACI;

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.

ServerId Property (FDMSDetailRecord Component)

Specifies the employee that served the customer. Used for restaurants only.

Syntax

property ServerId: String read get_ServerId write set_ServerId;

Default Value

''

Remarks

This property pertains to restaurant transactions, and should be set with a merchant-assigned server Id code. This code identifies the employee which served the customer at the restaurant. This property is required for restaurant transactions, and is ignored for all other industry types. The maximum length for this property is 3.

SettlementAmount Property (FDMSDetailRecord Component)

The amount that the customer will be charged.

Syntax

property SettlementAmount: String read get_SettlementAmount write set_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). If using the Restaurant IndustryType, you may also increase the SettlementAmount by adding any Gratuity (if present).

This field must always be greater than zero.

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.

TicketNumber Property (FDMSDetailRecord Component)

Ticket (receipt) number for this transaction.

Syntax

property TicketNumber: String read get_TicketNumber write set_TicketNumber;

Default Value

''

Remarks

This property contains the Ticket number or Receipt of Charge (ROC) for this transaction. This may be optionally sent for any IndustryType, but it is required for Restaurant transactions that include a Gratuity.

The maximum length of this property is 10 digits.

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

TransactionDate Property (FDMSDetailRecord Component)

Local Transaction Date (in MMDDYY format) from the original authorization response.

Syntax

property TransactionDate: String read get_TransactionDate write set_TransactionDate;

Default Value

'010100'

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.

TransactionId Property (FDMSDetailRecord Component)

Transaction Identifier from the original authorization response.

Syntax

property TransactionId: String read get_TransactionId write set_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.

TransactionTime Property (FDMSDetailRecord Component)

Local transaction time from the original authorization response.

Syntax

property TransactionTime: String read get_TransactionTime write set_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 generated by the FDMSECommerce or FDMSRetail component at the time of the sale. 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.

NOTE: This property is only applicable when settling a debit or EBT transaction, or a credit card transaction that includes Level 2 data, and may be ignored if such data is not being sent.

TransactionType Property (FDMSDetailRecord Component)

Indicates transaction type for this detail record.

Syntax

property TransactionType: TibcFDMSDetailTransactionTypes read get_TransactionType write set_TransactionType;

TibcFDMSDetailTransactionTypes = (
  fttSale,
  fttForce,
  fttVoid,
  fttCredit,
  fttVoidCredit,
  fttDebitSale,
  fttDebitRefund,
  fttFoodStampSale,
  fttFoodStampRefund,
  fttCashBenefitSale,
  fttCashBenefitWithdrawal
);

Default Value

fttSale

Remarks

This property indicates the type of transaction that is being settled. The following table explains the Transaction Types in detail:

Note: The fttSale and fttVoid TransactionTypes require a previous authorization to work on. fttForce and fttCredit, however, are offline transactions. This means there is no original authorization to work from. The transaction is created solely with this component's properties and is settled without ever having been authorized. Just fill out the properties and sent the FDMSSettle component's DetailAggregate array property with the results from the FDMSDetailRecord's GetDetailAggregate method. The remaining debit, food stamp, and cash benefit transactions may not be edited, voided, or otherwise modified before settlement. The detail aggregates should be set directly to the FDMSSettle component's DetailAggregate array property, and should never be manipulated with the FDMSDetailRecord component.

ValidationCode Property (FDMSDetailRecord Component)

Validation Code from the original authorization response.

Syntax

property ValidationCode: String read get_ValidationCode write set_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.

Config Method (FDMSDetailRecord Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (FDMSDetailRecord Component)

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

Syntax

function GetDetailAggregate(): String;

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 FDMSSettle component'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 FDMSDetailRecord component to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the CaptureFlag is false) the method raises an exception.

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

FDMSRetail.AuthorizeTrack1() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1 FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate() End If

ParseAggregate Method (FDMSDetailRecord Component)

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

Syntax

procedure ParseAggregate(Aggregate: String);

Remarks

This method takes the XML aggregate returned from the FDMSRetail or FDMSECommerce component, parses it, and then fills all the properties of the FDMSDetailRecord component. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSSettle component, sometimes it is necessary to adjust the contents of the XML aggregate first.

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

Reset Method (FDMSDetailRecord Component)

Clears all properties to their default values.

Syntax

procedure Reset();

Remarks

This method clears all properties to their default values.

Error Event (FDMSDetailRecord Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter 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 (FDMSDetailRecord Component)

The component 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 component, access to these internal properties is provided through the Config method.

FDMSDetailRecord Config Settings

Base Config Settings

Trappable Errors (FDMSDetailRecord Component)

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