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 GetDetailAggregate method.
Syntax
TibcFDMSRcDetailRecord
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.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 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.DetailRecordAggregate(5) = 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.
ApprovalCode | Approval code of the Voice/Force transaction to be sent for settlement. |
ArrivalDate | The arrival date of the guest. |
CardEntryDataSource | This property identifies the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in CardNumber . |
CardExpYear | Expiration year of the credit card specified in CardNumber . |
CardholderName | The name of the Cardholder. |
CardNumber | Customer's credit card number from the original authorization request. |
CashBack | Amount of cash that was returned to the customer. |
DepartureDate | The departure date of the guest. |
Duration | Length of hotel stay in days. |
ECI | Identifies the security level of the ECommerce transaction. |
ExtraCharges | List of extra charges for hotel transactions. |
FolioNumber | The Folio or Room Agreement number assigned by the hotel. |
HotelNoShow | Indicates whether the guest did not show. |
IndustryType | The merchant's industry type. |
InstallmentCount | Total number of installments (installment transactions only). |
InstallmentNumber | Current installment number (installment transactions only). |
Level2 | Specifies Level 2 (purchasing card information). |
LodgingChargeType | Type of charge made at a hotel. |
LodgingPhoneNumber | Phone number of the property the customer stayed at. |
LodgingReferenceNumber | A reference number assigned by the hotel/lodging establishment. |
MerchantServicePhone | The merchant's phone number, used to assist cardholders. |
MerchantURL | The URL of the site performing the ECommerce transaction. |
OrderNumber | A merchant assigned order number to uniquely reference the transaction. |
ProgramIndicator | Indicates the reason for the charge in a hotel transaction. |
ReferenceNumber | A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions. |
RoomNumber | The Room Number assigned by the hotel. |
RoomRate | The daily room rate in a hotel transaction. |
RoomTax | The daily room tax amount. |
SettlementAmount | The amount that the customer will be charged. |
STAN | The merchant assigned System Trace Audit Number(STAN). |
TotalAuthorizedAmount | Sum total of all the original authorization and all subsequent incremental authorizations. |
TransactionType | Indicates 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.
Config | Sets or retrieves a configuration setting. |
GetDetailAggregate | Returns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode. |
ParseAggregate | Parses the aggregate returned from another component's GetDetailAggregate method. |
Reset | Clears 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.
Error | Fired when information is available 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.
ACI | Authorization Characteristics Indicator. |
CardInputMode | The method used to input the card details. |
CurrencyCode | Currency Code for this transaction. |
LocalTransactionDate | The local date of the transaction. |
MOTOIndicator | Indicates whether the transaction is Mail Order or Telephone Order. |
POSConditionCode | The POS condition code. |
TerminalCardCapability | The terminal's card capture capability. |
TerminalCategoryCode | The Terminal Category Code. |
TerminalEntryCapability | The terminal's entry mode capability. |
TerminalLocationIndicator | The terminal's location. |
TerminalPinCapability | The terminal's PIN capability. |
UTCTransactionDate | The UTC date of the transaction. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | 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
property ApprovalCode: String read get_ApprovalCode write set_ApprovalCode;
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
property ArrivalDate: String read get_ArrivalDate write set_ArrivalDate;
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
property CardEntryDataSource: TibcEntryDataSources read get_CardEntryDataSource write set_CardEntryDataSource;
TibcEntryDataSources = ( edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk );
Default Value
edsTrack1
Remarks
Allowable values include: This property contains a 1-character code identifying the source of the customer data.
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
property CardExpMonth: Integer read get_CardExpMonth write set_CardExpMonth;
Default Value
1
Remarks
This field contains the expiration date of the customer's credit card. This property must be in the range 1 - 12.
CardExpYear Property (FDMSRcDetailRecord Component)
Expiration year of the credit card specified in CardNumber .
Syntax
property CardExpYear: Integer read get_CardExpYear write set_CardExpYear;
Default Value
2000
Remarks
This field contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 cannot be specified.
CardholderName Property (FDMSRcDetailRecord Component)
The name of the Cardholder.
Syntax
property CardholderName: String read get_CardholderName write set_CardholderName;
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
property CardNumber: String read get_CardNumber write set_CardNumber;
Default Value
''
Remarks
This field contains the customer's credit card number used in the original authorization request. This alphanumeric field can be a maximum of 22 characters long, excluding whitespace and dashes which are stripped out when the property is set.
CashBack Property (FDMSRcDetailRecord Component)
Amount of cash that was returned to the customer.
Syntax
property CashBack: String read get_CashBack write set_CashBack;
Default Value
''
Remarks
This property should reflect the cash back amount from the original debit or EBT card sale. The value sent in the settlement MUST be identical to the amount approved in the sale.
DepartureDate Property (FDMSRcDetailRecord Component)
The departure date of the guest.
Syntax
property DepartureDate: String read get_DepartureDate write set_DepartureDate;
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
property Duration: Integer read get_Duration write set_Duration;
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
property ECI: String read get_ECI write set_ECI;
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. |
ExtraCharges Property (FDMSRcDetailRecord Component)
List of extra charges for hotel transactions.
Syntax
property ExtraCharges: String read get_ExtraCharges write set_ExtraCharges;
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
property FolioNumber: String read get_FolioNumber write set_FolioNumber;
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
property HotelNoShow: Boolean read get_HotelNoShow write set_HotelNoShow;
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
property IndustryType: TibcFDMSRcIndustryTypes read get_IndustryType write set_IndustryType;
TibcFDMSRcIndustryTypes = ( fitRcUnknown, fitRcRetail, fitRcRestaurant, fitRcGroceryStore, fitRcDirectMarketing, fitRcHotel, fitRcMOTO );
Default Value
fitRcUnknown
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
property InstallmentCount: Integer read get_InstallmentCount write set_InstallmentCount;
Default Value
0
Remarks
This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the 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.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()
InstallmentNumber Property (FDMSRcDetailRecord Component)
Current installment number (installment transactions only).
Syntax
property InstallmentNumber: Integer read get_InstallmentNumber write set_InstallmentNumber;
Default Value
0
Remarks
This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the 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.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()
Level2 Property (FDMSRcDetailRecord Component)
Specifies Level 2 (purchasing card information).
Syntax
property Level2: TibcFDMSRcLevel2 read get_Level2 write set_Level2;
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
- CustomerReferenceNumber (required if TaxAmount specified)
- DestinationPostalCode (required)
- DiscountAmount (required if discount applied)
- DutyAmount (required if duty amount applied)
- FreightAmount (required if freight amount applied)
- ProductDescription (required)
- PurchaseIdentifier (required)
- MerchantTaxId
- ShipFromPostalCode
- TaxAmount
- TaxIndicator
- CustomerReferenceNumber (required if TaxAmount specified)
- DiscountAmount (required if discount applied)
- DutyAmount (required if duty amount applied)
- FreightAmount (required if freight amount applied)
- PurchaseIdentifier (required)
- TaxAmount (required if TaxIndicator indicates tax is applied)
- TaxIndicator (required)
- DestinationPostalCode
- ShipFromPostalCode
- MerchantTaxId
- CustomerReferenceNumber (required if TaxAmount specified)
- DiscountAmount (required if discount applied)
- DutyAmount (required if duty amount applied)
- FreightAmount (required if freight amount applied)
- MerchantTaxId (required)
- PurchaseIdentifier (required)
- TaxAmount (required if TaxIndicator indicates tax is applied)
- TaxIndicator (required)
- DestinationPostalCode
- ShipFromPostalCode
LodgingChargeType Property (FDMSRcDetailRecord Component)
Type of charge made at a hotel.
Syntax
property LodgingChargeType: TibcFDMSRcLodgingChargeTypes read get_LodgingChargeType write set_LodgingChargeType;
TibcFDMSRcLodgingChargeTypes = ( lctLodging, lctRestaurant, lctGiftShop );
Default Value
lctLodging
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
property LodgingPhoneNumber: String read get_LodgingPhoneNumber write set_LodgingPhoneNumber;
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
property LodgingReferenceNumber: String read get_LodgingReferenceNumber write set_LodgingReferenceNumber;
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
property MerchantServicePhone: String read get_MerchantServicePhone write set_MerchantServicePhone;
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
property MerchantURL: String read get_MerchantURL write set_MerchantURL;
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
property OrderNumber: String read get_OrderNumber write set_OrderNumber;
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
property ProgramIndicator: Integer read get_ProgramIndicator write set_ProgramIndicator;
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
property ReferenceNumber: String read get_ReferenceNumber write set_ReferenceNumber;
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
property RoomNumber: String read get_RoomNumber write set_RoomNumber;
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
property RoomRate: String read get_RoomRate write set_RoomRate;
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
property RoomTax: String read get_RoomTax write set_RoomTax;
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
property SettlementAmount: String read get_SettlementAmount write set_SettlementAmount;
Default Value
'0'
Remarks
This field contains the final settlement amount of the transaction. In most cases, this is the TransactionAmount from the original authorization request. However, you may settle a lesser amount (ie: Partial shipment or backordered stock).
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
property STAN: String read get_STAN write set_STAN;
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
property TotalAuthorizedAmount: String read get_TotalAuthorizedAmount write set_TotalAuthorizedAmount;
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
property TransactionType: TibcFDMSRcDetailTransactionTypes read get_TransactionType write set_TransactionType;
TibcFDMSRcDetailTransactionTypes = ( fttNotSet, fttAuthorization, fttAuthorizationWithCashback, fttVoiceApproved, fttEBTCashAuthorizationWithoutCashback, fttRefundCredit, fttEBTCashAuthorizationWithCashback, fttEBTCashAuthorizationCashbackOnly, fttEBTSNAPAuthorization, fttEBTSNAPVoucherClear, fttNoShowCredit, fttNoShowDebit, fttMOTOAuthorization, fttRefundDebit, fttRefundEBTSNAP );
Default Value
fttNotSet
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
function Config(ConfigurationString: String): String;
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
GetDetailAggregate Method (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
function GetDetailAggregate(): 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 raises 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
procedure ParseAggregate(Aggregate: 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
procedure Reset();
Remarks
This method clears all properties to their default values.
Error Event (FDMSRcDetailRecord Component)
Fired when information is available about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
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 property 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 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 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 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.
DutyAmount
String
Default Value: ""
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.
FreightAmount
String
Default Value: ""
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.
MerchantTaxId
String
Default Value: ""
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.
ProductDescription
String
Default Value: ""
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.
PurchaseIdentifier
String
Default Value: ""
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.
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 property contains the portion of the transaction amount that represents the tax.
This property 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
TibcTTaxIndicators
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
constructor Create();
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
Value | Visa | Mastercard | Discover | |
P | X | X | Preferred Rate/Customer Status (Lodging or Auto Rental) | |
I | X | X | X | Incremental Authorization |
Y (Default) | X | Transaction requests participation | ||
R | X | Card-not-present, AVS not required (permitted for certain MCCs only) |
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) |
1 | Mail Order |
2 | Telephone Order |
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 |
0 | Terminal has no capture capability or no terminal used |
1 | Terminal has card capture capability |
Note: If set to 0 track data must not be specified.
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 |
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 |
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.
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.
0 | Unspecified |
1 | PIN entry capability |
2 | No PIN entry capability |
3 | PIN Pad Inoperative |
4 | PIN verified by terminal device |
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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.
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.
Setting this configuration setting to True tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to False by default on all platforms.
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. |