FDMSRcDetailRecord Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

FDMSRcDetailRecord

Remarks

Creating off-line transactions means that there is no authorization of funds using the FDMSRcECommerce, or FDMSRcRetail controls. Instead, you must manually add these transactions to the settlement batch. The FDMSRcDetailRecord control can be used to create these transactions, which can then be added to the FDMSRcSettle control'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 control's DetailRecord array property with the value returned by the GetDetailAggregate method. You've just added a Refund to the settlement.

FDMSRcSettle.DetailRecordCount = 1 FDMSRcSettle.DetailRecordAggregate(0) = 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.DetailRecordCount = 1 FDMSRcSettle.DetailRecord(0) = FDMSRcDetailRecord.GetDetailAggregate()

In addition to creating off-line Refund and Force transactions, the FDMSRcDetailRecord control can be used to adjust the Detail Records returned from the FDMSRcECommerce and FDMSRcRetail controls. 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 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:

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

ApprovalCode Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.ApprovalCode[=string]

Default Value

""

Remarks

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

Data Type

String

ArrivalDate Property (FDMSRcDetailRecord Control)

The arrival date of the guest.

Syntax

fdmsrcdetailrecordcontrol.ArrivalDate[=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.

Data Type

String

CardEntryDataSource Property (FDMSRcDetailRecord Control)

This property identifies the source of the customer data.

Syntax

fdmsrcdetailrecordcontrol.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 (FDMSRcDetailRecord Control)

Expiration month of the credit card specified in CardNumber .

Syntax

fdmsrcdetailrecordcontrol.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 (FDMSRcDetailRecord Control)

Expiration year of the credit card specified in CardNumber .

Syntax

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

CardholderName Property (FDMSRcDetailRecord Control)

The name of the Cardholder.

Syntax

fdmsrcdetailrecordcontrol.CardholderName[=string]

Default Value

""

Remarks

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

Data Type

String

CardNumber Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.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 (FDMSRcDetailRecord Control)

Amount of cash that was returned to the customer.

Syntax

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

DepartureDate Property (FDMSRcDetailRecord Control)

The departure date of the guest.

Syntax

fdmsrcdetailrecordcontrol.DepartureDate[=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.

Data Type

String

Duration Property (FDMSRcDetailRecord Control)

Length of hotel stay in days.

Syntax

fdmsrcdetailrecordcontrol.Duration[=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.

Data Type

Integer

ECI Property (FDMSRcDetailRecord Control)

Identifies the security level of the ECommerce transaction.

Syntax

fdmsrcdetailrecordcontrol.ECI[=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:

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

Data Type

String

ExtraCharges Property (FDMSRcDetailRecord Control)

List of extra charges for hotel transactions.

Syntax

fdmsrcdetailrecordcontrol.ExtraCharges[=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.

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.

Data Type

String

FolioNumber Property (FDMSRcDetailRecord Control)

The Folio or Room Agreement number assigned by the hotel.

Syntax

fdmsrcdetailrecordcontrol.FolioNumber[=string]

Default Value

""

Remarks

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

Data Type

String

HotelNoShow Property (FDMSRcDetailRecord Control)

Indicates whether the guest did not show.

Syntax

fdmsrcdetailrecordcontrol.HotelNoShow[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

IndustryType Property (FDMSRcDetailRecord Control)

The merchant's industry type.

Syntax

fdmsrcdetailrecordcontrol.IndustryType[=integer]

Possible Values

fitRcUnknown(0), 
fitRcRetail(1), 
fitRcRestaurant(2), 
fitRcGroceryStore(3), 
fitRcDirectMarketing(4), 
fitRcHotel(5), 
fitRcMOTO(6)

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Data Type

Integer

InstallmentCount Property (FDMSRcDetailRecord Control)

Total number of installments (installment transactions only).

Syntax

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

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

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()

Data Type

Integer

InstallmentNumber Property (FDMSRcDetailRecord Control)

Current installment number (installment transactions only).

Syntax

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

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

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()

Data Type

Integer

Level2CustomerReferenceNumber Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2CustomerReferenceNumber[=string]

Default Value

""

Remarks

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

If Level2TaxAmount is specified this property is required.

The value may be up to 17 characters in length.

Data Type

String

Level2DestinationCountryCode Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2DestinationCountryCode[=string]

Default Value

""

Remarks

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.

Data Type

String

Level2DestinationPostalCode Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2DestinationPostalCode[=string]

Default Value

""

Remarks

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

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

The value may be up to 9 characters.

Data Type

String

Level2DiscountAmount Property (FDMSRcDetailRecord Control)

This property contains the discount amount for the purchase.

Syntax

fdmsrcdetailrecordcontrol.Level2DiscountAmount[=string]

Default Value

""

Remarks

This property contains the discount amount for the purchase.

This property 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.

Data Type

String

Level2DutyAmount Property (FDMSRcDetailRecord Control)

This property contains the duty amount for this purchase.

Syntax

fdmsrcdetailrecordcontrol.Level2DutyAmount[=string]

Default Value

""

Remarks

This property contains the duty amount for this purchase.

This property 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.

Data Type

String

Level2FreightAmount Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2FreightAmount[=string]

Default Value

""

Remarks

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

This property 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.

Data Type

String

Level2MerchantTaxId Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2MerchantTaxId[=string]

Default Value

""

Remarks

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

This property is required for MasterCard purchase card transactions.

The value may be up to 15 characters in length.

Data Type

String

Level2ProductDescription Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2ProductDescription[=string]

Default Value

""

Remarks

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

This property 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.

Data Type

String

Level2PurchaseIdentifier Property (FDMSRcDetailRecord Control)

This property represents the data used by the merchant or customer to identify the purchase.

Syntax

fdmsrcdetailrecordcontrol.Level2PurchaseIdentifier[=string]

Default Value

""

Remarks

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

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

The value may be up to 25 characters in length.

Data Type

String

Level2ShipFromPostalCode Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2ShipFromPostalCode[=string]

Default Value

""

Remarks

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

The value may be up to 9 characters.

Data Type

String

Level2TaxAmount Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.Level2TaxAmount[=string]

Default Value

""

Remarks

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

This property is required when Level2TaxIndicator 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.

Data Type

String

Level2TaxIndicator Property (FDMSRcDetailRecord Control)

This property indicates the taxable status of the transaction.

Syntax

fdmsrcdetailrecordcontrol.Level2TaxIndicator[=integer]

Possible Values

tiUnSet(0), 
tiNotProvided(1), 
tiProvided(2), 
tiExempt(3)

Default Value

0

Remarks

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

Data Type

Integer

LodgingChargeType Property (FDMSRcDetailRecord Control)

Type of charge made at a hotel.

Syntax

fdmsrcdetailrecordcontrol.LodgingChargeType[=integer]

Possible Values

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

Default Value

0

Remarks

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

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

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

Data Type

Integer

LodgingPhoneNumber Property (FDMSRcDetailRecord Control)

Phone number of the property the customer stayed at.

Syntax

fdmsrcdetailrecordcontrol.LodgingPhoneNumber[=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.

Data Type

String

LodgingReferenceNumber Property (FDMSRcDetailRecord Control)

A reference number assigned by the hotel/lodging establishment.

Syntax

fdmsrcdetailrecordcontrol.LodgingReferenceNumber[=string]

Default Value

""

Remarks

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

Data Type

String

MerchantServicePhone Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.MerchantServicePhone[=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.

Data Type

String

MerchantURL Property (FDMSRcDetailRecord Control)

The URL of the site performing the ECommerce transaction.

Syntax

fdmsrcdetailrecordcontrol.MerchantURL[=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.

Data Type

String

OrderNumber Property (FDMSRcDetailRecord Control)

A merchant assigned order number to uniquely reference the transaction.

Syntax

fdmsrcdetailrecordcontrol.OrderNumber[=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.

Data Type

String

ProgramIndicator Property (FDMSRcDetailRecord Control)

Indicates the reason for the charge in a hotel transaction.

Syntax

fdmsrcdetailrecordcontrol.ProgramIndicator[=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:

Data Type

Integer

ReferenceNumber Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.ReferenceNumber[=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.

Data Type

String

RoomNumber Property (FDMSRcDetailRecord Control)

The Room Number assigned by the hotel.

Syntax

fdmsrcdetailrecordcontrol.RoomNumber[=string]

Default Value

""

Remarks

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

Data Type

String

RoomRate Property (FDMSRcDetailRecord Control)

The daily room rate in a hotel transaction.

Syntax

fdmsrcdetailrecordcontrol.RoomRate[=string]

Default Value

""

Remarks

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

Data Type

String

RoomTax Property (FDMSRcDetailRecord Control)

The daily room tax amount.

Syntax

fdmsrcdetailrecordcontrol.RoomTax[=string]

Default Value

""

Remarks

This property contains the daily Room Tax for lodging.

Data Type

String

SettlementAmount Property (FDMSRcDetailRecord Control)

The amount that the customer will be charged.

Syntax

fdmsrcdetailrecordcontrol.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).

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

STAN Property (FDMSRcDetailRecord Control)

The merchant assigned System Trace Audit Number(STAN).

Syntax

fdmsrcdetailrecordcontrol.STAN[=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.

Data Type

String

TotalAuthorizedAmount Property (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.TotalAuthorizedAmount[=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.

Data Type

String

TransactionType Property (FDMSRcDetailRecord Control)

Indicates transaction type for this detail record.

Syntax

fdmsrcdetailrecordcontrol.TransactionType[=integer]

Possible Values

fttNotSet(0), 
fttAuthorization(1), 
fttAuthorizationWithCashback(2), 
fttVoiceApproved(3), 
fttEBTCashAuthorizationWithoutCashback(4), 
fttRefundCredit(5), 
fttEBTCashAuthorizationWithCashback(6), 
fttEBTCashAuthorizationCashbackOnly(7), 
fttEBTSNAPAuthorization(8), 
fttEBTSNAPVoucherClear(9), 
fttNoShowCredit(10), 
fttNoShowDebit(11), 
fttMOTOAuthorization(12), 
fttRefundDebit(13), 
fttRefundEBTSNAP(14)

Default Value

0

Remarks

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

Data Type

Integer

Config Method (FDMSRcDetailRecord Control)

Sets or retrieves a configuration setting.

Syntax

fdmsrcdetailrecordcontrol.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 (FDMSRcDetailRecord Control)

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

fdmsrcdetailrecordcontrol.GetDetailAggregate 

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 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 FDMSRcDetailrecord control to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

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

ParseAggregate Method (FDMSRcDetailRecord Control)

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

Syntax

fdmsrcdetailrecordcontrol.ParseAggregate Aggregate

Remarks

This method takes the XML aggregate returned from the FDMSRcRetail or FDMSRcECommerce control, parses it, and then fills all the properties of the FDMSRcDetailrecord control. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSRcSettle control, sometimes it is necessary to adjust the contents of the XML aggregate first.

Reset Method (FDMSRcDetailRecord Control)

Clears all properties to their default values.

Syntax

fdmsrcdetailrecordcontrol.Reset 

Remarks

This method clears all properties to their default values.

Error Event (FDMSRcDetailRecord Control)

Fired when information is available about errors during data delivery.

Syntax

Sub fdmsrcdetailrecordcontrol_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 (FDMSRcDetailRecord 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.

FDMSRcDetailRecord Config Settings

Base Config Settings

Trappable Errors (FDMSRcDetailRecord Control)

FDMSRcDetailRecord Errors

	20502    Data field invalid length.
	20503    Data field invalid format.
	20504    Data field out of range.
	20593    Invalid or unparseable aggregate.
	20594    Verification of post data failed: Invalid mix of properties for the current method call.
	20606    Invalid CardType.