FDMSRcDetailRecord Component

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcDetailRecord component is a tool used to create off-line Refund or Force/VoiceApproved transactions to be settled by the FDMSRcSettle component. The FDMSRcDetailRecord component may also be used to modify the XML aggregates returned by the FDMSRcRetail or FDMSRcECommerce component's method.

Syntax

DPayments.DPaymentsSDK.Fdmsrcdetailrecord

Remarks

Creating off-line transactions means that there is no authorization of funds using the FDMSRcECommerce, or FDMSRcRetail components. Instead, you must manually add these transactions to the settlement batch. The FDMSRcDetailRecord component can be used to create these transactions, which can then be added to the FDMSRcSettle component's DetailRecord array property.

To create an off-line Refund, first set the TransactionType to fttRefundCredit, and then set the IndustryType and CardEntryDataSource based on whether you have a card reader, and how your customer is authenticated. The following example shows how this should be set for MOTO:

FDMSRcDetailRecord.TransactionType = fttRefundCredit FDMSRcDetailRecord.IndustryType = fitRcMOTO FDMSRcDetailRecord.CardEntryDataSource = edsManualEntryNoCardReader

Next, set the CardNumber, CardExpMonth, CardExpYear, TotalAuthorizedAmount, and SettlementAmount. Note that since this is an off-line transaction, the TotalAuthorizedAmount MUST be zero.

FDMSRcDetailRecord.CardNumber = "371030089111114" FDMSRcDetailRecord.CardExpMonth = 12 FDMSRcDetailRecord.CardExpYear = 2025 FDMSRcDetailRecord.TotalAuthorizedAmount = "0" FDMSRcDetailRecord.SettlementAmount = "5000" ' $50.00

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

FDMSRcSettle.DetailRecords.Add(New FDMSRcRecordType(FDMSRcDetailRecord.GetDetailAggregate()))

Forced/VoiceApproved transactions are similar to refunds, with the exception that a Forced transaction requires a Voice Authorization code obtained from your acquiring bank's call center. Generally, the purchase of large high-dollar items (cars, appliances, etc) will require the merchant to call and receive a voice authorization. Once this code is received, it should be set to the ApprovalCode property. The following example shows a Force/VoiceApproved transaction in a Retail environment.

FDMSRcDetailRecord.TransactionType = fttVoiceApproved FDMSRcDetailRecord.IndustryType = fitRcRetail FDMSRcDetailRecord.CardEntryDataSource = edsTrack1 FDMSRcDetailRecord.CardNumber = "4444333322221111" FDMSRcDetailRecord.CardExpMonth = 12 FDMSRcDetailRecord.CardExpYear = 2025 FDMSRcDetailRecord.TotalAuthorizedAmount = "0" FDMSRcDetailRecord.SettlementAmount = "500000" '$5000.00 FDMSRcDetailRecord.ApprovalCode = "123456" FDMSRcSettle.DetailRecords.Add(New FDMSRcRecordType(FDMSRcDetailRecord.GetDetailAggregate()))

In addition to creating off-line Refund and Force transactions, the FDMSRcDetailRecord component can be used to adjust the Detail Records returned from the FDMSRcECommerce and FDMSRcRetail components. For instance, one reason to modify these detail records is to add Installment payment info (fitRcDirectMarketing or fitRcMOTO IndustryType) to the detail record.

To settle an Installment transaction, you must use the FDMSRcDetailrecord 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:

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecords.Add(new FDMSRcRecordType(FDMSRcDetailRecord.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.

ApprovalCodeApproval code of the Voice/Force transaction to be sent for settlement.
ArrivalDateThe arrival date of the guest.
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 .
CardholderNameThe name of the Cardholder.
CardNumberCustomer's credit card number from the original authorization request.
CashBackAmount of cash that was returned to the customer
DepartureDateThe departure date of the guest.
DurationLength of hotel stay in days.
ECIIdentifies the security level of the ECommerce transaction.
ExtraChargesList of extra charges for hotel transactions.
FolioNumberThe Folio or Room Agreement number assigned by the hotel.
HotelNoShowIndicates whether the guest did not show.
IndustryTypeThe merchant's industry type.
InstallmentCountTotal number of installments (installment transactions only).
InstallmentNumberCurrent installment number (installment transactions only).
Level2Specifies Level 2 (purchasing card information).
LodgingChargeTypeType of charge made at a hotel.
LodgingPhoneNumberPhone number of the property the customer stayed at.
LodgingReferenceNumberA reference number assigned by the hotel/lodging establishment.
MerchantServicePhoneThe merchant's phone number, used to assist cardholders.
MerchantURLThe URL of the site performing the ECommerce transaction.
OrderNumberA merchant assigned order number to uniquely reference the transaction.
ProgramIndicatorIndicates the reason for the charge in a hotel transaction.
ReferenceNumberA value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.
RoomNumberThe Room Number assigned by the hotel.
RoomRateThe daily room rate in a hotel transaction.
RoomTaxThe daily room tax amount.
SettlementAmountThe amount that the customer will be charged.
STANThe merchant assigned System Trace Audit Number(STAN).
TotalAuthorizedAmountSum total of all the original authorization and all subsequent incremental authorizations.
TransactionTypeIndicates transaction type for this detail record

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 a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode.
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.

CardInputModeThe method used to input the card details.
CurrencyCodeCurrency Code for this transaction.
LocalTransactionDateThe local date of the transaction.
MOTOIndicatorIndicates whether the transaction is Mail Order or Telephone Order.
POSConditionCodeThe POS condition code.
TerminalCardCapabilityThe terminal's card capture capability.
TerminalCategoryCodeThe Terminal Category Code.
TerminalEntryCapabilityThe terminal's entry mode capability.
TerminalLocationIndicatorThe terminal's location.
TerminalPinCapabilityThe terminal's PIN capability.
UTCTransactionDateThe UTC date of the transaction.
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.

ApprovalCode Property (FDMSRcDetailRecord Component)

Approval code of the Voice/Force transaction to be sent for settlement.

Syntax

public string ApprovalCode { get; set; }

Public Property ApprovalCode As String

Default Value

""

Remarks

This property should be set with the approval code the merchant gets over the phone for a Voice/Force transaction.

ArrivalDate Property (FDMSRcDetailRecord Component)

The arrival date of the guest.

Syntax

public string ArrivalDate { get; set; }

Public Property ArrivalDate As String

Default Value

""

Remarks

Date the guest checked in, or the expected arrival date when authorizing a reservation. The date specified should be in the format "MMDDYY".

Note: The Arrival Date must be a date that precedes the Departure Date.

CardEntryDataSource Property (FDMSRcDetailRecord Component)

This property identifies the source of the customer data.

Syntax

public FdmsrcdetailrecordCardEntryDataSources CardEntryDataSource { get; set; }

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

Public Property CardEntryDataSource As FdmsrcdetailrecordCardEntryDataSources

Enum FdmsrcdetailrecordCardEntryDataSources
  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 (FDMSRcDetailRecord 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 (FDMSRcDetailRecord 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.

CardholderName Property (FDMSRcDetailRecord Component)

The name of the Cardholder.

Syntax

public string CardholderName { get; set; }

Public Property CardholderName As String

Default Value

""

Remarks

This property is used to specify the name of the cardholder.

CardNumber Property (FDMSRcDetailRecord 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 (FDMSRcDetailRecord 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.

DepartureDate Property (FDMSRcDetailRecord Component)

The departure date of the guest.

Syntax

public string DepartureDate { get; set; }

Public Property DepartureDate As String

Default Value

""

Remarks

Date the guest checked out, or the expected departure date when authorizing a reservation. The date specified should be in the format "MMDDYY".

Note: The Departure Date must be a date that is after the Arrival Date.

Duration Property (FDMSRcDetailRecord Component)

Length of hotel stay in days.

Syntax

public int Duration { get; set; }

Public Property Duration As Integer

Default Value

1

Remarks

The number of days the guest stayed in the hotel, or the expected duration of stay when authorizing a reservation. This field must be between 1 and 99 days.

ECI Property (FDMSRcDetailRecord Component)

Identifies the security level of the ECommerce transaction.

Syntax

public string ECI { get; set; }

Public Property ECI As String

Default Value

""

Remarks

This setting specifies the security level of the ECommerce transaction. In most cases this does not need to be changed. A common reason for modifying this value is when supplying 3-D secure values. Possible values are:

01 Merchant is 3-D Secure capable and the cardholder information is fully authenticated.
02 Merchant is 3-D Secure capable but the cardholder was not authenticated. Use this value when authentication was attempted but the issuer is not participating in 3-D Secure, the cardholder is not participating in 3-D Secure, or the authentication server was not available.
03 3-D Secure was not attempted.
This is only applicable when IndustryType is set to fitRcDirectMarketing or fitRcHotel.

ExtraCharges Property (FDMSRcDetailRecord Component)

List of extra charges for hotel transactions.

Syntax

public string ExtraCharges { get; set; }

Public Property ExtraCharges As String

Default Value

""

Remarks

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

Value Hotel Definition
0 None.
2 Restaurant.
3 Gift Shop.
4 Mini Bar.
5 Telephone.
6 Other.
7 Laundry.

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

This field is only applicable to Visa card transactions when IndustryType is Hotel and will not be sent for any other industry types.

FolioNumber Property (FDMSRcDetailRecord Component)

The Folio or Room Agreement number assigned by the hotel.

Syntax

public string FolioNumber { get; set; }

Public Property FolioNumber As String

Default Value

""

Remarks

This is a 12 alphanumeric code assigned by the hotel during the transaction.

HotelNoShow Property (FDMSRcDetailRecord Component)

Indicates whether the guest did not show.

Syntax

public bool HotelNoShow { get; set; }

Public Property HotelNoShow As Boolean

Default Value

False

Remarks

This property can be set to 'True' to indicate that the guest did not show.

IndustryType Property (FDMSRcDetailRecord Component)

The merchant's industry type.

Syntax

public FdmsrcdetailrecordIndustryTypes IndustryType { get; set; }

enum FdmsrcdetailrecordIndustryTypes {
  fitRcUnknown,
  fitRcRetail,
  fitRcRestaurant,
  fitRcGroceryStore,
  fitRcDirectMarketing,
  fitRcHotel,
  fitRcMOTO
}

Public Property IndustryType As FdmsrcdetailrecordIndustryTypes

Enum FdmsrcdetailrecordIndustryTypes
  fitRcUnknown
  fitRcRetail
  fitRcRestaurant
  fitRcGroceryStore
  fitRcDirectMarketing
  fitRcHotel
  fitRcMOTO
End Enum

Default Value

0

Remarks

The merchant's industry type. Possible values are:

fitRcUnknown (0) Unknown or unsure.
fitRcRetail (1) Retail store.
fitRcRestaurant (2) Food / Restaurant.
fitRcGroceryStore (3) Grocery store or supermarket.
fitRcDirectMarketing (4) eCommerce or Direct Marketing
fitRcHotel (5) Hotel / Lodging.
fitRcMOTO (6) Mail Order / Telephone Order

InstallmentCount Property (FDMSRcDetailRecord 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 FDMSRcEcommerce component.

To settle an Installment transaction, you must use the FDMSRcDetailrecord 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:

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecords.Add(new FDMSRcRecordType(FDMSRcDetailRecord.GetDetailAggregate()))

InstallmentNumber Property (FDMSRcDetailRecord 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 FDMSRcEcommerce component.

To settle an Installment transaction, you must use the FDMSRcDetailrecord 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:

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecords.Add(new FDMSRcRecordType(FDMSRcDetailRecord.GetDetailAggregate()))

Level2 Property (FDMSRcDetailRecord Component)

Specifies Level 2 (purchasing card information).

Syntax

public FDMSRcLevel2 Level2 { get; set; }

Public Property Level2 As FDMSRcLevel2

Remarks

This property specifies Level 2 (purchasing card information).

The values required for Level 2 transaction depend on the card type. The following tables indicate which properties are valid for what card type:

American Express

Visa MasterCard

Please refer to the FDMSRcLevel2 type for a complete list of fields.

LodgingChargeType Property (FDMSRcDetailRecord Component)

Type of charge made at a hotel.

Syntax

public FdmsrcdetailrecordLodgingChargeTypes LodgingChargeType { get; set; }

enum FdmsrcdetailrecordLodgingChargeTypes {
  lctLodging,
  lctRestaurant,
  lctGiftShop
}

Public Property LodgingChargeType As FdmsrcdetailrecordLodgingChargeTypes

Enum FdmsrcdetailrecordLodgingChargeTypes
  lctLodging
  lctRestaurant
  lctGiftShop
End Enum

Default Value

0

Remarks

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

  • lctLodging (0)
  • lctRestaurant (1)
  • lctGiftShop (2)

Note, this property is only applicable when using the Hotel IndustryType.

LodgingPhoneNumber Property (FDMSRcDetailRecord Component)

Phone number of the property the customer stayed at.

Syntax

public string LodgingPhoneNumber { get; set; }

Public Property LodgingPhoneNumber As String

Default Value

""

Remarks

This 10 character field contains the customer service phone number without dashes or spaces. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "8001234567" is acceptable, while "18001234567" or "1-800-123-4567" is not.

Note, this property is only applicable when using the Hotel IndustryType.

LodgingReferenceNumber Property (FDMSRcDetailRecord Component)

A reference number assigned by the hotel/lodging establishment.

Syntax

public string LodgingReferenceNumber { get; set; }

Public Property LodgingReferenceNumber As String

Default Value

""

Remarks

This is a 9 character identifier assigned by the hotel/lodging for the transaction.

MerchantServicePhone Property (FDMSRcDetailRecord Component)

The merchant's phone number, used to assist cardholders.

Syntax

public string MerchantServicePhone { get; set; }

Public Property MerchantServicePhone As String

Default Value

""

Remarks

This property specifies a 10 digit phone number which cardholders can call for assistance.

This value is required for fitRcMOTO transactions. It is recommended but not required for fitRcDirectMarketing and fitRcHotel transactions.

MerchantURL Property (FDMSRcDetailRecord Component)

The URL of the site performing the ECommerce transaction.

Syntax

public string MerchantURL { get; set; }

Public Property MerchantURL As String

Default Value

""

Remarks

This property specifies the URL of the merchant's site.

For Visa and Discover transactions this value is limited to 13 characters. For all other card types this value is limited to 32 characters.

This is only applicable when the IndustryType is set to fitRcDirectMarketing or fitRcHotel.

OrderNumber Property (FDMSRcDetailRecord Component)

A merchant assigned order number to uniquely reference the transaction.

Syntax

public string OrderNumber { get; set; }

Public Property OrderNumber As String

Default Value

""

Remarks

This property holds a merchant assigned order number that uniquely identifies the transaction. This must hold a numeric value up to 8 digits in length. This value cannot be all zeros.

This value is required for ECommerce and MOTO transactions. This value is optional for Retail transactions.

ProgramIndicator Property (FDMSRcDetailRecord Component)

Indicates the reason for the charge in a hotel transaction.

Syntax

public int ProgramIndicator { get; set; }

Public Property ProgramIndicator As Integer

Default Value

1

Remarks

This is used to specify the program indicator for a hotel/lodging transaction. This property is not applicable for Mastercards.

Valid Values:

Value Description
1 (Default) Normal Charge (Visa, Amex)
2 Assured Reservation No Show (Visa, Amex, Discover)
3 Card Deposit (Visa, Amex)
4 Delayed Charge (Visa, Amex, Discover)
5 Express Service (Visa, Amex)
6 Assured Reservation (Visa, Amex)

ReferenceNumber Property (FDMSRcDetailRecord Component)

A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.

Syntax

public string ReferenceNumber { get; set; }

Public Property ReferenceNumber As String

Default Value

""

Remarks

This value is a merchant assigned 10 bytes value. The value must be unique within a day for a given merchant id and terminal id. The Reference Number entered in the DetailRecord should be the same as the Reference Number submitted in the original transaction.

RoomNumber Property (FDMSRcDetailRecord Component)

The Room Number assigned by the hotel.

Syntax

public string RoomNumber { get; set; }

Public Property RoomNumber As String

Default Value

""

Remarks

This is a 6 character room number code assigned by the hotel during the transaction.

RoomRate Property (FDMSRcDetailRecord Component)

The daily room rate in a hotel transaction.

Syntax

public string RoomRate { get; set; }

Public Property RoomRate As String

Default Value

""

Remarks

This property contains the daily rate for one room at the lodging property.

RoomTax Property (FDMSRcDetailRecord Component)

The daily room tax amount.

Syntax

public string RoomTax { get; set; }

Public Property RoomTax As String

Default Value

""

Remarks

This property contains the daily Room Tax for lodging.

SettlementAmount Property (FDMSRcDetailRecord 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).

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.

STAN Property (FDMSRcDetailRecord Component)

The merchant assigned System Trace Audit Number(STAN).

Syntax

public string STAN { get; set; }

Public Property STAN As String

Default Value

""

Remarks

This property represents a six digit number assigned by the merchant to uniquely reference the transaction. This number must be unique within a day per Merchant ID and Terminal ID.

Valid values are from 000001 to 999999 inclusive.

TotalAuthorizedAmount Property (FDMSRcDetailRecord Component)

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

Syntax

public string TotalAuthorizedAmount { get; set; }

Public Property TotalAuthorizedAmount As String

Default Value

""

Remarks

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

TransactionType Property (FDMSRcDetailRecord Component)

Indicates transaction type for this detail record

Syntax

public FdmsrcdetailrecordTransactionTypes TransactionType { get; set; }

enum FdmsrcdetailrecordTransactionTypes {
  fttNotSet,
  fttAuthorization,
  fttAuthorizationWithCashback,
  fttVoiceApproved,
  fttEBTCashAuthorizationWithoutCashback,
  fttRefundCredit,
  fttEBTCashAuthorizationWithCashback,
  fttEBTCashAuthorizationCashbackOnly,
  fttEBTSNAPAuthorization,
  fttEBTSNAPVoucherClear,
  fttNoShowCredit,
  fttNoShowDebit,
  fttMOTOAuthorization,
  fttRefundDebit,
  fttRefundEBTSNAP
}

Public Property TransactionType As FdmsrcdetailrecordTransactionTypes

Enum FdmsrcdetailrecordTransactionTypes
  fttNotSet
  fttAuthorization
  fttAuthorizationWithCashback
  fttVoiceApproved
  fttEBTCashAuthorizationWithoutCashback
  fttRefundCredit
  fttEBTCashAuthorizationWithCashback
  fttEBTCashAuthorizationCashbackOnly
  fttEBTSNAPAuthorization
  fttEBTSNAPVoucherClear
  fttNoShowCredit
  fttNoShowDebit
  fttMOTOAuthorization
  fttRefundDebit
  fttRefundEBTSNAP
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:

fttAuthorization (1) The transaction to be settled was a normal authorization and passed into the FDMSRcDetailRecord component via the ParseAggregate method.
fttAuthorizationWithCashback (2)The transaction to be settled was a normal authorization with cashback and passed into the FDMSRcDetailRecord component via the ParseAggregate method.
fttVoiceApproved (3)This transaction type is used to force a settlement without a previous authorization. This is generally used when an authorization response indicates that the merchant should call the cardholder's bank to verify the funds transfer. The merchant will then be given an authorization code over the phone, with which to settle the transaction.
fttEBTCashAuthorizationWithoutCashback (4)Settles a normal EBTCash Authorization without CashBack made using the FDMSRcBenefit component.
fttRefundCredit (5)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.
fttEBTCashAuthorizationWithCashback (6)Settles a normal EBTCash Authorization with CashBack made using the FDMSRcBenefit component.
fttEBTCashAuthorizationCashbackOnly (7)TODO
fttEBTSNAPAuthorization (8)TODO
fttEBTSNAPVoucherClear (9)TODO
fttNoShowCredit (10)Settles a normal (Credit) Authorization for HotelNoShow made using the FDMSRcRetail component.
fttNoShowDebit (11)TODO
fttMOTOAuthorization (12)Settles a normal (MOTO) Authorization transaction made using the FDMSRcECommerce component.
fttRefundDebit (13)Settles an on-line Debit Credit transaction made using the FDMSRcDebit component.
fttRefundEBTSNAP (14)Settles an on-line EBT Credit transaction made using the FDMSRcBenefit component.

Config Method (FDMSRcDetailRecord 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 (FDMSRcDetailRecord Component)

Returns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode.

Syntax

public string GetDetailAggregate();

Public Function GetDetailAggregate() As String

Remarks

This method will return a detail aggregate representing the transaction. After calling AuthOnly or Sale call this method to obtain a detail aggregate. The aggregate will be required when calling Capture or Reverse.

When using Terminal Capture Settlement Mode this aggregate must be passed to the FDMSRcSettle 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 FDMSRcDetailrecord component to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method throws an exception.

To set the aggregate before calling Capture Reverse or SendSettlement call SetDetailAggregate. Save this aggregate in a secure location.

ParseAggregate Method (FDMSRcDetailRecord 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 FDMSRcRetail or FDMSRcECommerce component, parses it, and then fills all the properties of the FDMSRcDetailrecord component. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSRcSettle component, sometimes it is necessary to adjust the contents of the XML aggregate first.

Reset Method (FDMSRcDetailRecord 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 (FDMSRcDetailRecord Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class FdmsrcdetailrecordErrorEventArgs 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.

FDMSRcLevel2 Type

Specifies Level 2 (purchasing card) information.

Remarks

This type specifies Level 2 (purchasing card) information.

Fields

CustomerReferenceNumber
string
Default Value: ""

The reference number or order number to be reported as part of the Purchase Card data.

If TaxAmount is specified this field is required.

The value may be up to 17 characters in length.

DestinationCountryCode
string
Default Value: ""

This field represents the country code of the location the items in this purchase are being delivered to.

This value is the ISO 3166 three digit numeric identifier.

DestinationPostalCode
string
Default Value: ""

This field contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

This field is required for American Express purchase card transactions. This is the same as the ShipFromPostalCode when the customer takes possession of the items at the merchant location.

The value may be up to 9 characters.

DiscountAmount
string
Default Value: ""

This field contains the discount amount for the purchase.

This field is required for Visa, MasterCard, and American Express purchase card transactions when a discount has been applied.

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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

DutyAmount
string
Default Value: ""

This field contains the duty amount for this purchase.

This field is required for Visa, MasterCard, and American Express purchase card transactions when a duty amount has been applied.

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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

FreightAmount
string
Default Value: ""

This field contains the amount for freight included in this purchase.

This field is required for Visa, MasterCard, and American Express purchase card transactions when a freight amount has been applied.

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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

MerchantTaxId
string
Default Value: ""

This field should contain the Tax Id collected by the merchant for this transaction.

This field is required for MasterCard purchase card transactions.

The value may be up to 15 characters in length.

ProductDescription
string
Default Value: ""

This field should contain a description of an item purchased with this card.

This field is required for American Express purchase card transactions and not applicable to other card types.

The value may be up to 40 characters in length.

PurchaseIdentifier
string
Default Value: ""

This field represents the data used by the merchant or customer to identify the purchase. This can be a SKU, code, or reference number.

This field is required for Visa, MasterCard, and American Express purchase card transactions.

The value may be up to 25 characters in length.

ShipFromPostalCode
string
Default Value: ""

The postal or zip code the item(s) in this purchase are to be shipped from.

The value may be up to 9 characters.

TaxAmount
string
Default Value: ""

This field contains the portion of the transaction amount that represents the tax.

This field is required when TaxIndicator is set to 2 (tiProvided).

For Visa this is the amount of state or provincial tax included in the TransactionAmount. The tax amount must be within 0.1 % and 22% of the pre-tax transaction amount.

For MasterCard the total amount of sales tax on the total purchase must be between 0.1% and 30 % of the total pre-tax transaction amount; zeros indicate that the card acceptor is capable of transmitting the tax amount and the tax amount is 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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

TaxIndicator
TTaxIndicators
Default Value: 0

This field indicates the taxable status of the transaction. Possible values are:

0 (tiUnSet - default) UnSet - no value is sent in the request
1 (tiNotProvided) No tax information provided
2 (tiProvided) Tax amount is provided
3 (tiExempt) Purchase item is tax exempt or non-taxable

Constructors

public FDMSRcLevel2();

Public FDMSRcLevel2()

Config Settings (FDMSRcDetailRecord 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.

FDMSRcDetailRecord Config Settings

CardInputMode:   The method used to input the card details.

This setting optionally specifies the method used to input the card number or track data. If not specified (default) the component will automatically determine the correct value based on EntryDataSource. This should only be set if there is a need to override the automatically determined value. Possible values are:

00 Unspecified
01 Manual (Key entered)
03 Barcode
04 OCR (Optical Character Reader)
05 Integrated Circuit Read (CVV data Reliable)
07 Contactless Integrated Circuit Read (Reliable)
10 Credential on File
79 EMV fallback to manual entry
80 EMV fallback to Magnetic Stripe entry
82 Contactless Mobile Commerce
90 Magnetic Stripe - Track Read
91 Contactless Magnetic Stripe Read
95 Integrated Circuit Read (CVV data unreliable)
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".

LocalTransactionDate:   The local date of the transaction.

This setting may be set to specify the local datetime of the transaction. By default the component will automatically calculate this value from the local system time. If set, this setting overrides the value calculated by the component. The format is "yyyyMMddHHmmss";

MOTOIndicator:   Indicates whether the transaction is Mail Order or Telephone Order.

This setting is required for Amex transactions when POSConditionCode is set to 08. Possible values are:

1 Mail Order
2 Telephone Order
POSConditionCode:   The POS condition code.

This setting may be set to specify a different POS condition code. The component will automatically set this to an appropriate value, however this may be set to provide a specific value. Possible values are:

00 Cardholder Present, Card Present
01 Cardholder Present, Unspecified
02 Cardholder Present, Unattended Device
03 Cardholder Present, Suspect Fraud
04 Cardholder Not Present - Recurring
05 Cardholder Present, Card Not Present
06 Cardholder Present, Identity Verified
08 Cardholder Not Present, Mail Order/Telephone Order
59 Cardholder Not Present, Ecommerce
71 Cardholder Present, Magnetic Stripe Could Not Be Read
TerminalCardCapability:   The terminal's card capture capability.

This setting specifies the terminal's ability to capture card information. Possible values are:

0 Terminal has no capture capability or no terminal used
1 Terminal has card capture capability
The default value is 1.

Note: If set to 0 track data must not be specified.

TerminalCategoryCode:   The Terminal Category Code.

This setting specifies the type of terminal being used for the transaction. Possible values are:

00 Unspecified
01 Electronic Payment Terminal (POS)
05 Automated Fuel Dispensing Machine (AFD)
06 Unattended Customer Terminal
07 Ecommerce Customer present
08 Mobile Terminal (Transponder for example: a wireless terminal)
09 Mobile POS (mPOS for example: a cellphone or tablet device on a cellular network)
12 Electronic Cash Register
13 Interactive Voice Response (IVR)
17 Ticket Machine
18 Call Center Operator
TerminalEntryCapability:   The terminal's entry mode capability.

This settings defines what entry modes are supported by the terminal. Possible values are:

00 Unspecified
01 Terminal not used
02 Magnetic stripe only
03 Magnetic stripe and key entry
04 Magnetic stripe, key entry, and chip
05 Bar code
06 Proximity terminal - contactless chip / RFID
07 OCR
08 Chip only
09 Chip and magnetic stripe
10 Manual entry only
11 Proximity terminal - contactless magnetic stripe
12 Hybrid - Magnetic stripe, Integrated Circuit Card Reader, and contactless capabilities
13 Terminal does not read card data
The default value is 00 (unspecified).

Note: A value of 04, 06, 08, 09, or 12 cannot be specified unless the client is certified and the device is enabled for EMV.

TerminalLocationIndicator:   The terminal's location.

This setting specifies the terminal's location. The component will automatically set this to the appropriate value depending on the IndustryType, however this may be set according to your needs to one of the following possible values:

0 On Premises; Used in a Card Present environment
1 Off Premises; Used in a Card not Present environment

Note: For MOTO and eCommerce transactions the value is set to 1 by default.

TerminalPinCapability:   The terminal's PIN capability.

This setting specifies the terminal's ability to accept PIN entry. Possible values are:

0 Unspecified
1 PIN entry capability
2 No PIN entry capability
3 PIN Pad Inoperative
4 PIN verified by terminal device
The default value is 1.
UTCTransactionDate:   The UTC date of the transaction.

This setting may be set to specify the UTC datetime of the transaction. By default the component will automatically calculate this value from the local system time. If set, this setting overrides the value calculated by the component. The format is "yyyyMMddHHmmss";

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

FDMSRcDetailRecord Errors

501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.
592   Invalid or unparseable aggregate.
593   Verification of post data failed: Invalid mix of properties for the current method call.
605   Invalid CardType.