FDMSDetailRecord Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

FDMSDetailRecord

Remarks

Credit and Force transactions are off-line transactions. This means that there is no authorization of funds using the FDMSECommerce, FDMSRetail controls. Instead, you must manually add these transactions to the settlement batch. The FDMSDetailRecord control can be used to create these transactions, which can then be added to the FDMSSettle control'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 control'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 control can be used to adjust the Detail Records returned from the FDMSECommerce and FDMSRetail controls. 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 control 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 control with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

AuthorizedAmount Property (FDMSDetailRecord Control)

Original amount authorized before any reversals.

Syntax

fdmsdetailrecordcontrol.AuthorizedAmount[=string]

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.

Data Type

String

CardEntryDataSource Property (FDMSDetailRecord Control)

This property identifies the source of the customer data.

Syntax

fdmsdetailrecordcontrol.CardEntryDataSource[=integer]

Possible Values

edsTrack1(0), 
edsTrack2(1), 
edsManualEntryTrack1Capable(2), 
edsManualEntryTrack2Capable(3), 
edsManualEntryNoCardReader(4), 
edsTrack1Contactless(5), 
edsTrack2Contactless(6), 
edsManualEntryContactlessCapable(7), 
edsIVR(8), 
edsKiosk(9)

Default Value

0

Remarks

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

Data Type

Integer

CardExpMonth Property (FDMSDetailRecord Control)

Expiration month of the credit card specified in CardNumber .

Syntax

fdmsdetailrecordcontrol.CardExpMonth[=integer]

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.

Data Type

Integer

CardExpYear Property (FDMSDetailRecord Control)

Expiration year of the credit card specified in CardNumber .

Syntax

fdmsdetailrecordcontrol.CardExpYear[=integer]

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.

Data Type

Integer

CardLevelResults Property (FDMSDetailRecord Control)

Card Level result code returned only for Visa transactions.

Syntax

fdmsdetailrecordcontrol.CardLevelResults[=string]

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.

Data Type

String

CardNumber Property (FDMSDetailRecord Control)

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

Syntax

fdmsdetailrecordcontrol.CardNumber[=string]

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

CashBack Property (FDMSDetailRecord Control)

Amount of cash that was returned to the customer.

Syntax

fdmsdetailrecordcontrol.CashBack[=string]

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.

Data Type

String

DebitReceipt Property (FDMSDetailRecord Control)

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

Syntax

fdmsdetailrecordcontrol.DebitReceipt[=string]

Default Value

""

Remarks

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

Data Type

String

DirectMarketingType Property (FDMSDetailRecord Control)

Specifies the type of transaction to process.

Syntax

fdmsdetailrecordcontrol.DirectMarketingType[=integer]

Possible Values

dmECommerce(0), 
dmMOTO(1), 
dmRecurring(2), 
dmInstallment(3)

Default Value

0

Remarks

The following types of transactions are supported by this control:

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

Data Type

Integer

ECI Property (FDMSDetailRecord Control)

Electronic Commerce Indicator from the original authorization request.

Syntax

fdmsdetailrecordcontrol.ECI[=string]

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

Gratuity Property (FDMSDetailRecord Control)

Gratuity amount for settling restaurant industry transactions.

Syntax

fdmsdetailrecordcontrol.Gratuity[=string]

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 control's IndustryType is set to "Restaurant".

Data Type

String

IndustryType Property (FDMSDetailRecord Control)

Code which indicates the industry the merchant is engaged in.

Syntax

fdmsdetailrecordcontrol.IndustryType[=integer]

Possible Values

fitUnknown(0), 
fitRetail(1), 
fitRestaurant(2), 
fitGroceryStore(3), 
fitDirectMarketing(4), 
fitHotel(5)

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

Data Type

Integer

InstallmentCount Property (FDMSDetailRecord Control)

Total number of installments (installment transactions only).

Syntax

fdmsdetailrecordcontrol.InstallmentCount[=integer]

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

To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord control 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()

Data Type

Integer

InstallmentNumber Property (FDMSDetailRecord Control)

Current installment number (installment transactions only).

Syntax

fdmsdetailrecordcontrol.InstallmentNumber[=integer]

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

To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord control 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()

Data Type

Integer

PurchaseIdentifier Property (FDMSDetailRecord Control)

Optional purchase order number assigned by the merchant.

Syntax

fdmsdetailrecordcontrol.PurchaseIdentifier[=string]

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.

Data Type

String

ResponseApprovalCode Property (FDMSDetailRecord Control)

Response Approval Code from the original authorization response.

Syntax

fdmsdetailrecordcontrol.ResponseApprovalCode[=string]

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

ResponseAVSResult Property (FDMSDetailRecord Control)

Address Verification Code from the original authorization response.

Syntax

fdmsdetailrecordcontrol.ResponseAVSResult[=string]

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

ResponseReturnedACI Property (FDMSDetailRecord Control)

Authorization Characteristics Indicator from the original authorization response.

Syntax

fdmsdetailrecordcontrol.ResponseReturnedACI[=string]

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

ServerId Property (FDMSDetailRecord Control)

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

Syntax

fdmsdetailrecordcontrol.ServerId[=string]

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.

Data Type

String

SettlementAmount Property (FDMSDetailRecord Control)

The amount that the customer will be charged.

Syntax

fdmsdetailrecordcontrol.SettlementAmount[=string]

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.

Data Type

String

TicketNumber Property (FDMSDetailRecord Control)

Ticket (receipt) number for this transaction.

Syntax

fdmsdetailrecordcontrol.TicketNumber[=string]

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

Data Type

String

TransactionDate Property (FDMSDetailRecord Control)

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

Syntax

fdmsdetailrecordcontrol.TransactionDate[=string]

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.

Data Type

String

TransactionId Property (FDMSDetailRecord Control)

Transaction Identifier from the original authorization response.

Syntax

fdmsdetailrecordcontrol.TransactionId[=string]

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

TransactionTime Property (FDMSDetailRecord Control)

Local transaction time from the original authorization response.

Syntax

fdmsdetailrecordcontrol.TransactionTime[=string]

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

Data Type

String

TransactionType Property (FDMSDetailRecord Control)

Indicates transaction type for this detail record.

Syntax

fdmsdetailrecordcontrol.TransactionType[=integer]

Possible Values

fttSale(0), 
fttForce(1), 
fttVoid(2), 
fttCredit(3), 
fttVoidCredit(4), 
fttDebitSale(5), 
fttDebitRefund(6), 
fttFoodStampSale(8), 
fttFoodStampRefund(9), 
fttCashBenefitSale(10), 
fttCashBenefitWithdrawal(11)

Default Value

0

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 control's properties and is settled without ever having been authorized. Just fill out the properties and sent the FDMSSettle control'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 control's DetailAggregate array property, and should never be manipulated with the FDMSDetailRecord control.

Data Type

Integer

ValidationCode Property (FDMSDetailRecord Control)

Validation Code from the original authorization response.

Syntax

fdmsdetailrecordcontrol.ValidationCode[=string]

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

Config Method (FDMSDetailRecord Control)

Sets or retrieves a configuration setting.

Syntax

fdmsdetailrecordcontrol.Config ConfigurationString

Remarks

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

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

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

Syntax

fdmsdetailrecordcontrol.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 FDMSSettle control'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 control to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseCaptureFlag is false) the method fails with an error.

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

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

Syntax

fdmsdetailrecordcontrol.ParseAggregate Aggregate

Remarks

This method takes the XML aggregate returned from the FDMSRetail or FDMSECommerce control, parses it, and then fills all the properties of the FDMSDetailRecord control. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSSettle control, 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 Control)

Clears all properties to their default values.

Syntax

fdmsdetailrecordcontrol.Reset 

Remarks

This method clears all properties to their default values.

Error Event (FDMSDetailRecord Control)

Fired when information is available about errors during data delivery.

Syntax

Sub fdmsdetailrecordcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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

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

FDMSDetailRecord Config Settings

Base Config Settings

Trappable Errors (FDMSDetailRecord Control)

FDMSDetailRecord Errors

	20502    Data field invalid length.
	20503    Data field invalid format.
	20504    Data field out of range.
	20593    Invalid or unparseable aggregate.
	20606    Invalid CardType.