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 component. The FDMSDetailRecord component may also be used to modify the XML aggregates returned by the or component's method.

Syntax

DPayments.DPaymentsSDK.Fdmsdetailrecord

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.DetailRecords.Add(New FDMSRecordType(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.DetailRecords.Add(New FDMSRecordType(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.DetailRecords.Add(New FDMSRecordType(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.DetailRecords.Add(new FDMSRecordType(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.

AuthorizedAmountOriginal amount authorized before any reversals.
CardEntryDataSourceThis property identifies the source of the customer data.
CardExpMonthExpiration month of the credit card specified in CardNumber .
CardExpYearExpiration year of the credit card specified in CardNumber .
CardLevelResultsCard Level result code returned only for Visa transactions.
CardNumberCustomer's credit card number from the original authorization request.
CashBackAmount of cash that was returned to the customer
DebitReceiptMerchant-generated number that identifies the debit or EBT transaction.
DirectMarketingTypeSpecifies the type of transaction to process.
ECIElectronic Commerce Indicator from the original authorization request.
GratuityGratuity amount for settling restaurant industry transactions.
IndustryTypeCode which indicates the industry the merchant is engaged in.
InstallmentCountTotal number of installments (installment transactions only).
InstallmentNumberCurrent installment number (installment transactions only).
PurchaseIdentifierOptional purchase order number assigned by the merchant.
ResponseApprovalCodeResponse Approval Code from the original authorization response.
ResponseAVSResultAddress Verification Code from the original authorization response.
ResponseReturnedACIAuthorization Characteristics Indicator from the original authorization response.
ServerIdSpecifies the employee that served the customer. Used for restaurants only.
SettlementAmountThe amount that the customer will be charged.
TicketNumberTicket (receipt) number for this transaction.
TransactionDateLocal Transaction Date (in MMDDYY format) from the original authorization response.
TransactionIdTransaction Identifier from the original authorization response.
TransactionTimeLocal transaction time from the original authorization response.
TransactionTypeIndicates transaction type for this detail record
ValidationCodeValidation Code from the original authorization response.

Method List

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

ConfigSets or retrieves a configuration setting.
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for settlement.
ParseAggregateParses the aggregate returned from another component's GetDetailAggregate method.
ResetClears all properties to their default values.

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.

ErrorInformation about errors during data delivery.

Config Settings

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

CurrencyCodeCurrency Code for this transaction.
DCCConversionRateThe DCC Conversion rate.
DCCIndicatorStatus of the Dynamic Currency Conversion.
DCCTimeZoneThe time zone of the merchant where the DCC transaction is taking place.
DCCUSAmountThe US Dollar Amount for a DCC transaction.
MSDIMarket Specific Data Indicator.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

AuthorizedAmount Property (FDMSDetailRecord Component)

Original amount authorized before any reversals.

Syntax

public string AuthorizedAmount { get; set; }

Public Property AuthorizedAmount As 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.

CardEntryDataSource Property (FDMSDetailRecord Component)

This property identifies the source of the customer data.

Syntax

public FdmsdetailrecordCardEntryDataSources CardEntryDataSource { get; set; }

enum FdmsdetailrecordCardEntryDataSources {
  edsTrack1,
  edsTrack2,
  edsManualEntryTrack1Capable,
  edsManualEntryTrack2Capable,
  edsManualEntryNoCardReader,
  edsTrack1Contactless,
  edsTrack2Contactless,
  edsManualEntryContactlessCapable,
  edsIVR,
  edsKiosk
}

Public Property CardEntryDataSource As FdmsdetailrecordCardEntryDataSources

Enum FdmsdetailrecordCardEntryDataSources
  edsTrack1
  edsTrack2
  edsManualEntryTrack1Capable
  edsManualEntryTrack2Capable
  edsManualEntryNoCardReader
  edsTrack1Contactless
  edsTrack2Contactless
  edsManualEntryContactlessCapable
  edsIVR
  edsKiosk
End Enum

Default Value

0

Remarks

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

edsTrack1 (0) Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1) Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2) Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).

CardExpMonth Property (FDMSDetailRecord Component)

Expiration month of the credit card specified in CardNumber .

Syntax

public int CardExpMonth { get; set; }

Public Property CardExpMonth As 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.

CardExpYear Property (FDMSDetailRecord Component)

Expiration year of the credit card specified in CardNumber .

Syntax

public int CardExpYear { get; set; }

Public Property CardExpYear As 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.

CardLevelResults Property (FDMSDetailRecord Component)

Card Level result code returned only for Visa transactions.

Syntax

public string CardLevelResults { get; set; }

Public Property CardLevelResults As String

Default Value

""

Remarks

This field 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

public string CardNumber { get; set; }

Public Property CardNumber As 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.

CashBack Property (FDMSDetailRecord Component)

Amount of cash that was returned to the customer

Syntax

public string CashBack { get; set; }

Public Property CashBack As String

Default Value

""

Remarks

This field 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

public string DebitReceipt { get; set; }

Public Property DebitReceipt As String

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

public FdmsdetailrecordDirectMarketingTypes DirectMarketingType { get; set; }

enum FdmsdetailrecordDirectMarketingTypes {
  dmECommerce,
  dmMOTO,
  dmRecurring,
  dmInstallment
}

Public Property DirectMarketingType As FdmsdetailrecordDirectMarketingTypes

Enum FdmsdetailrecordDirectMarketingTypes
  dmECommerce
  dmMOTO
  dmRecurring
  dmInstallment
End Enum

Default Value

0

Remarks

The following types of transactions are supported by this component:

dmECommerce (0)This is an E-Commerce transaction, and consists of goods or services sold online over the Internet.
dmMOTO (1)This is a Mail Order or Telephone Order transaction, and consists of goods sold through the mail or over the phone.
dmRecurring (2)This is a recurring payment, such as a magazine subscription or health club membership.
dmInstallment (3)This is an installment payment. For example, "Three easy payments of $19.95".

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

public string ECI { get; set; }

Public Property ECI As 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.

Gratuity Property (FDMSDetailRecord Component)

Gratuity amount for settling restaurant industry transactions.

Syntax

public string Gratuity { get; set; }

Public Property Gratuity As 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 component's IndustryType is set to "Restaurant".

IndustryType Property (FDMSDetailRecord Component)

Code which indicates the industry the merchant is engaged in.

Syntax

public FdmsdetailrecordIndustryTypes IndustryType { get; set; }

enum FdmsdetailrecordIndustryTypes {
  fitUnknown,
  fitRetail,
  fitRestaurant,
  fitGroceryStore,
  fitDirectMarketing,
  fitHotel
}

Public Property IndustryType As FdmsdetailrecordIndustryTypes

Enum FdmsdetailrecordIndustryTypes
  fitUnknown
  fitRetail
  fitRestaurant
  fitGroceryStore
  fitDirectMarketing
  fitHotel
End Enum

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

fitUnknown (0)Unknown or unsure.
fitRetail (1)Retail store.
fitRestaurant (2)Food / Restaurant.
fitGroceryStore (3)Grocery store or supermarket.
fitDirectMarketing (4)eCommerce or Direct Marketing
fitHotel (5)Hotel / Lodging.

InstallmentCount Property (FDMSDetailRecord Component)

Total number of installments (installment transactions only).

Syntax

public int InstallmentCount { get; set; }

Public Property InstallmentCount As 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 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.DetailRecords.Add(new FDMSRecordType(FDMSDetailRecord.GetDetailAggregate()))

InstallmentNumber Property (FDMSDetailRecord Component)

Current installment number (installment transactions only).

Syntax

public int InstallmentNumber { get; set; }

Public Property InstallmentNumber As 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 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.DetailRecords.Add(new FDMSRecordType(FDMSDetailRecord.GetDetailAggregate()))

PurchaseIdentifier Property (FDMSDetailRecord Component)

Optional purchase order number assigned by the merchant.

Syntax

public string PurchaseIdentifier { get; set; }

Public Property PurchaseIdentifier As 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.

ResponseApprovalCode Property (FDMSDetailRecord Component)

Response Approval Code from the original authorization response.

Syntax

public string ResponseApprovalCode { get; set; }

Public Property ResponseApprovalCode As 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.

ResponseAVSResult Property (FDMSDetailRecord Component)

Address Verification Code from the original authorization response.

Syntax

public string ResponseAVSResult { get; set; }

Public Property ResponseAVSResult As 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".

ResponseReturnedACI Property (FDMSDetailRecord Component)

Authorization Characteristics Indicator from the original authorization response.

Syntax

public string ResponseReturnedACI { get; set; }

Public Property ResponseReturnedACI As 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.

ServerId Property (FDMSDetailRecord Component)

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

Syntax

public string ServerId { get; set; }

Public Property ServerId As String

Default Value

""

Remarks

This field 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 field is required for restaurant transactions, and is ignored for all other industry types. The maximum length for this field is 3.

SettlementAmount Property (FDMSDetailRecord Component)

The amount that the customer will be charged.

Syntax

public string SettlementAmount { get; set; }

Public Property SettlementAmount As 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.

TicketNumber Property (FDMSDetailRecord Component)

Ticket (receipt) number for this transaction.

Syntax

public string TicketNumber { get; set; }

Public Property TicketNumber As 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.DetailRecords.Add(New FDMSRecordType(FDMSDetailRecord.GetDetailAggregate()))

TransactionDate Property (FDMSDetailRecord Component)

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

Syntax

public string TransactionDate { get; set; }

Public Property TransactionDate As 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.

TransactionId Property (FDMSDetailRecord Component)

Transaction Identifier from the original authorization response.

Syntax

public string TransactionId { get; set; }

Public Property TransactionId As 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.

TransactionTime Property (FDMSDetailRecord Component)

Local transaction time from the original authorization response.

Syntax

public string TransactionTime { get; set; }

Public Property TransactionTime As 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 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

public FdmsdetailrecordTransactionTypes TransactionType { get; set; }

enum FdmsdetailrecordTransactionTypes {
  fttSale,
  fttForce,
  fttVoid,
  fttCredit,
  fttVoidCredit,
  fttDebitSale,
  fttDebitRefund,
  fttFoodStampSale,
  fttFoodStampRefund,
  fttCashBenefitSale,
  fttCashBenefitWithdrawal
}

Public Property TransactionType As FdmsdetailrecordTransactionTypes

Enum FdmsdetailrecordTransactionTypes
  fttSale
  fttForce
  fttVoid
  fttCredit
  fttVoidCredit
  fttDebitSale
  fttDebitRefund
  fttFoodStampSale
  fttFoodStampRefund
  fttCashBenefitSale
  fttCashBenefitWithdrawal
End Enum

Default Value

0

Remarks

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

fttSale (0)The transaction to be settled was a normal authorization and passed into the FDMSDetailRecord component via the ParseAggregate method.
fttForce (1)This transaction was not authorized using either the FDMSECommerce or FDMSRetail components. Instead it is created manually with the FDMSDetailRecord's properties. In order to successfully settle a Forced transaction, you must obtain an authorization code from a call center, and place it in the ResponseApprovalCode property.
fttVoid (2)When you wish to void a transaction that has been previously authorized, pass the details of the original transaction to the ParseAggregate method, and then change this TransactionType property to fttVoid.
fttCredit (3)This transaction type is used to credit money back to a cardholder's account. An (offline) credit is not based on a previous transaction, and you may credit any card for any amount without restriction. Simply set the CardNumber to the customer's card number, and then the AuthorizedAmount to "0" and the SettlementAmount to the amount you wish to refund. No track data or AVS data is sent in an offline credit transaction.
fttVoidCredit (4)This transaction voids a previous credit.
fttDebitSale (5)Settles an on-line Debit Sale transaction made using the FDMSDebit component. This transaction must not be edited before being settled. (It cannot be voided off-line)
fttDebitRefund (6)Settles an on-line Debit Credit transaction made using the FDMSDebit component.
fttFoodStampSale (8)Settles an on-line Food Stamp Sale or Voucher Clear made using the FDMSBenefit component.
fttFoodStampRefund (9)Settles an on-line Food Stamp Credit or Voucher Clear made using the FDMSBenefit component.
fttCashBenefitSale (10)Settles an on-line Cash Benefit sale made using the FDMSBenefit component.
fttCashBenefitWithdrawal (11)Settles an on-line Cash Withdrawl (Cash Only) transaction made using the FDMSBenefit component.

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

public string ValidationCode { get; set; }

Public Property ValidationCode As 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.

Config Method (FDMSDetailRecord Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As 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

public string GetDetailAggregate();

Public Function GetDetailAggregate() As 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 throws an exception.

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

FDMSRetail.AuthorizeTrack1() if (FDMSRetail.ResponseCaptureFlag) { FDMSSettle.DetailRecords.Add(new FDMSRecordType(FDMSRetail.GetDetailAggregate())); }

ParseAggregate Method (FDMSDetailRecord Component)

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

Syntax

public void ParseAggregate(string aggregate);

Public Sub ParseAggregate(ByVal Aggregate As 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.DetailRecords.Add(New FDMSRecordType(FDMSDetailRecord.GetDetailAggregate()))

Reset Method (FDMSDetailRecord Component)

Clears all properties to their default values.

Syntax

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Error Event (FDMSDetailRecord Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, FdmsdetailrecordErrorEventArgs e);

public class FdmsdetailrecordErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As FdmsdetailrecordErrorEventArgs)

Public Class FdmsdetailrecordErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

CurrencyCode:   Currency Code for this transaction.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

DCCConversionRate:   The DCC Conversion rate.

The conversion rate used to convert the TransactionAmount into the Dynamic Currency Conversion amount. The conversion rate must be the most current rate available from FEXCO. These rates are not obtained by the component and must be retrieved using some other method. Note: Four decimal positions implied.

DCCIndicator:   Status of the Dynamic Currency Conversion.

The available values are:

Value Description
"" [Empty String] (default) Not a DCC transaction
1 Converted
2 Not convertible
3 Convertible but declined by the cardholder
4 Reserved for future use
DCCTimeZone:   The time zone of the merchant where the DCC transaction is taking place.

Valid values range from '-12' to '+12", deviation in hours from Greenwich Mean Time (GMT), based on merchant time zone. If the merchant were located in GMT, the value would be '+00' or '-00'.

DCCUSAmount:   The US Dollar Amount for a DCC transaction.

This config will contain the US Dollar Amount for a DCC transaction. When performing a DCC transaction, TransactionAmount will contain the converted amount and should equal the US Dollar Amount multiplied by the DCCConversionRate.

MSDI:   Market Specific Data Indicator.

The Market Specific Data Indicator (MSDI) will be "M" for Medical/Healthcare Auto-substantiation transactions, and " " (space) for all other transactions. The MSDI value is automatically passed from the FDMSRetail and FDMSECommerce components to the FDMSSettle or FDMSDetailRecord components via the GetDetailAggregate methods. This config is exposed to allow the user manual control over the contents of the MSDI.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to true.

Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

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.