FDMSDetailRecord Component
Properties Methods Events Config Settings Errors
The FDMSDetailRecord component is a tool used to create off-line Credit or Force transactions to be settled by the FDMSSETTLE component. The FDMSDetailRecord component may also be used to modify the XML aggregates returned by the FDMSRETAIL or FDMSECOMMERCE component's GetDetailAggregate method.
Syntax
TibcFDMSDetailRecord
Remarks
Credit and Force transactions are off-line transactions. This means that there is no authorization of funds using the FDMSECommerce, FDMSRetail components. Instead, you must manually add these transactions to the settlement batch. The FDMSDetailRecord component can be used to create these transactions, which can then be added to the FDMSSettle component's DetailRecord array property.
To create a Credit, first set the TransactionType to fttCredit, and then set the IndustryType. CardEntryDataSource, and DirectMarketingType based on whether you have a card reader, and how your customer is authenticated. The following example shows how this should be set for Direct Marketing:
FDMSDetailRecord.TransactionType = fttCredit
FDMSDetailRecord.IndustryType = fitDirectMarketing
FDMSDetailRecord.CardEntryDataSource = edsManualEntryNoCardReader
FDMSDetailRecord.DirectMarketingType = dmECommerce
Next, set the CardNumber, CardExpMonth, CardExpYear, SettlementAmount, and the current TransactionDate and TransactionTime. Since this example is a Direct Marketing transaction, we're also adding the PurchaseIdentifier. Note that since this is an off-line transaction, the AuthorizedAmount MUST be either zero or empty string.
FDMSDetailRecord.CardNumber = "4444333322221111"
FDMSDetailRecord.CardExpMonth = 3
FDMSDetailRecord.CardExpYear = 2019
FDMSDetailRecord.AuthorizedAmount = "0"
FDMSDetailRecord.SettlementAmount = "5000" '$50.00
FDMSDetailRecord.TransTime = "123456" ' Current time (12:34:56)
FDMSDetailRecord.TransDate = "040506" ' Current date (MMDDYY)
FDMSDetailRecord.PurchaseIdentifier = "123456"
Finally, set the FDMSSettle component's DetailRecord array property with the value returned by the GetDetailAggregate method. You've just added a Credit to the settlement.
FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSDetailRecord.GetDetailAggregate()
Forced transactions are similar to credits, with the exception that a Forced transaction requires a Voice Authorization code obtained from your acquiring bank's call center. Generally, the purchase of large high-dollar items (cars, appliances, etc) will require the merchant to call and receive a voice authorization. Once this code is received, it should be set to the ResponseApprovalCode property. The following example shows a Force transaction in a Retail environment.
FDMSDetailRecord.TransactionType = fttForce
FDMSDetailRecord.IndustryType = fitRetail
FDMSDetailRecord.CardEntryDataSource = edsTrack1
FDMSDetailRecord.CardNumber = "4444333322221111"
FDMSDetailRecord.CardExpMonth = 3
FDMSDetailRecord.CardExpYear = 2019
FDMSDetailRecord.AuthorizedAmount = "0"
FDMSDetailRecord.SettlementAmount = "500000" '$5000.00
FDMSDetailRecord.TransTime = "123456" ' Current time (12:34:56)
FDMSDetailRecord.TransDate = "040506" ' Current date (MMDDYY)
FDMSDetailRecord.ResponseApprovalCode = "123456"
FDMSSettle.DetailRecordCount = 1
FDMSSettle.DetailRecord(0) = FDMSDetailRecord.GetDetailAggregate()
In addition to creating Credit and Force transactions, the FDMSDetailRecord component can be used to adjust the Detail Records returned from the FDMSECommerce and FDMSRetail components. The most common reasons to modify these detail records are to add a Gratuity (tip) to a charge (fitResturant IndustryType), or to add a PurchaseIdentifier or Installment payment info (fitDirectMarketing IndustryType) to the detail record.
For example, to add a gratuity to a charge:
FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate())
FDMSDetailRecord.Gratuity = "500"
FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity
FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()
To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord component to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:
FDMSECommerce.TransactionType = dmtInstallment
FDMSECommerce.TransactionAmount = "1995"
FDMSECommerce.Authorize()
FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate()
FDMSDetailRecord.InstallmentCount = 3
FDMSDetailRecord.InstallmentNumber = 1
FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AuthorizedAmount | Original amount authorized before any reversals. |
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 . |
CardLevelResults | Card Level result code returned only for Visa transactions. |
CardNumber | Customer's credit card number from the original authorization request. |
CashBack | Amount of cash that was returned to the customer. |
DebitReceipt | Merchant-generated number that identifies the debit or EBT transaction. |
DirectMarketingType | Specifies the type of transaction to process. |
ECI | Electronic Commerce Indicator from the original authorization request. |
Gratuity | Gratuity amount for settling restaurant industry transactions. |
IndustryType | Code which indicates the industry the merchant is engaged in. |
InstallmentCount | Total number of installments (installment transactions only). |
InstallmentNumber | Current installment number (installment transactions only). |
PurchaseIdentifier | Optional purchase order number assigned by the merchant. |
ResponseApprovalCode | Response Approval Code from the original authorization response. |
ResponseAVSResult | Address Verification Code from the original authorization response. |
ResponseReturnedACI | Authorization Characteristics Indicator from the original authorization response. |
ServerId | Specifies the employee that served the customer. Used for restaurants only. |
SettlementAmount | The amount that the customer will be charged. |
TicketNumber | Ticket (receipt) number for this transaction. |
TransactionDate | Local Transaction Date (in MMDDYY format) from the original authorization response. |
TransactionId | Transaction Identifier from the original authorization response. |
TransactionTime | Local transaction time from the original authorization response. |
TransactionType | Indicates transaction type for this detail record. |
ValidationCode | Validation Code from the original authorization response. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
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.
CurrencyCode | Currency Code for this transaction. |
DCCConversionRate | The DCC Conversion rate. |
DCCIndicator | Status of the Dynamic Currency Conversion. |
DCCTimeZone | The time zone of the merchant where the DCC transaction is taking place. |
DCCUSAmount | The US Dollar Amount for a DCC transaction. |
MSDI | Market Specific Data Indicator. |
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. |
AuthorizedAmount Property (FDMSDetailRecord Component)
Original amount authorized before any reversals.
Syntax
__property String AuthorizedAmount = { read=FAuthorizedAmount, write=FSetAuthorizedAmount };
Default Value
"0"
Remarks
This field contains the transaction amount from the original authorization request message. If any additional authorizations have been made, or the SettlementAmount is different than the originally authorized amount (due to items out of stock or adding a Gratuity) this property should still reflect the original unchanged amount from the initial authorization request.
Data Type
String
CardEntryDataSource Property (FDMSDetailRecord Component)
This property identifies the source of the customer data.
Syntax
__property TibcFDMSDetailRecordCardEntryDataSources CardEntryDataSource = { read=FCardEntryDataSource, write=FSetCardEntryDataSource };
enum TibcFDMSDetailRecordCardEntryDataSources { edsTrack1=0, edsTrack2=1, edsManualEntryTrack1Capable=2, edsManualEntryTrack2Capable=3, edsManualEntryNoCardReader=4, edsTrack1Contactless=5, edsTrack2Contactless=6, edsManualEntryContactlessCapable=7, edsIVR=8, edsKiosk=9 };
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). |
Data Type
Integer
CardExpMonth Property (FDMSDetailRecord Component)
Expiration month of the credit card specified in CardNumber .
Syntax
__property int CardExpMonth = { read=FCardExpMonth, write=FSetCardExpMonth };
Default Value
1
Remarks
This field contains the expiration date of the customer's credit card. This property must be in the range 1 - 12.
Data Type
Integer
CardExpYear Property (FDMSDetailRecord Component)
Expiration year of the credit card specified in CardNumber .
Syntax
__property int CardExpYear = { read=FCardExpYear, write=FSetCardExpYear };
Default Value
2000
Remarks
This field contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 cannot be specified.
Data Type
Integer
CardLevelResults Property (FDMSDetailRecord Component)
Card Level result code returned only for Visa transactions.
Syntax
__property String CardLevelResults = { read=FCardLevelResults, write=FSetCardLevelResults };
Default Value
""
Remarks
This property contains a two-character code created by Visa during the authorization process. If the transaction being settled was authorized online, this field must contain the value returned in the authorization response. If the transaction is a credit or was otherwise processed offline, this field should be defaulted to "" (empty string) or two spaces.
Data Type
String
CardNumber Property (FDMSDetailRecord Component)
Customer's credit card number from the original authorization request.
Syntax
__property String CardNumber = { read=FCardNumber, write=FSetCardNumber };
Default Value
""
Remarks
This field contains the customer's credit card number used in the original authorization request. This alphanumeric field can be a maximum of 22 characters long, excluding whitespace and dashes which are stripped out when the property is set.
Data Type
String
CashBack Property (FDMSDetailRecord Component)
Amount of cash that was returned to the customer.
Syntax
__property String CashBack = { read=FCashBack, write=FSetCashBack };
Default Value
""
Remarks
This property should reflect the cash back amount from the original debit or EBT card sale. The value sent in the settlement MUST be identical to the amount approved in the sale.
Data Type
String
DebitReceipt Property (FDMSDetailRecord Component)
Merchant-generated number that identifies the debit or EBT transaction.
Syntax
__property String DebitReceipt = { read=FDebitReceipt, write=FSetDebitReceipt };
Default Value
""
Remarks
A merchant must generate a ReceiptNumber for debit and EBT transactions made with the FDMSDebit and FDMSBenefit components. This receipt number must be passed to the settlement unmodified in this DebitReceipt property.
Data Type
String
DirectMarketingType Property (FDMSDetailRecord Component)
Specifies the type of transaction to process.
Syntax
__property TibcFDMSDetailRecordDirectMarketingTypes DirectMarketingType = { read=FDirectMarketingType, write=FSetDirectMarketingType };
enum TibcFDMSDetailRecordDirectMarketingTypes { dmECommerce=0, dmMOTO=1, dmRecurring=2, dmInstallment=3 };
Default Value
dmECommerce
Remarks
The following types of transactions are supported by this component:
dmECommerce (0) | This is an E-Commerce transaction, and consists of goods or services sold online over the Internet. |
dmMOTO (1) | This is a Mail Order or Telephone Order transaction, and consists of goods sold through the mail or over the phone. |
dmRecurring (2) | This is a recurring payment, such as a magazine subscription or health club membership. |
dmInstallment (3) | This is an installment payment. For example, "Three easy payments of $19.95". |
The value of this property will be ignored when the IndustryType is anything other than fitDirectMarketing.
Data Type
Integer
ECI Property (FDMSDetailRecord Component)
Electronic Commerce Indicator from the original authorization request.
Syntax
__property String ECI = { read=FECI, write=FSetECI };
Default Value
""
Remarks
This field should be identical to the ECI property from the original authorization request. This property is used only for eCommerce and Direct Marketing (card not present) transactions, and is ignored for all Card Present (Retail) transactions.
Data Type
String
Gratuity Property (FDMSDetailRecord Component)
Gratuity amount for settling restaurant industry transactions.
Syntax
__property String Gratuity = { read=FGratuity, write=FSetGratuity };
Default Value
""
Remarks
This 5 character numeric field contains the gratuity (tip) amount of the transaction being settled. This amount is only sent when the CFDMSSettle component's IndustryType is set to "Restaurant".
Data Type
String
IndustryType Property (FDMSDetailRecord Component)
Code which indicates the industry the merchant is engaged in.
Syntax
__property TibcFDMSDetailRecordIndustryTypes IndustryType = { read=FIndustryType, write=FSetIndustryType };
enum TibcFDMSDetailRecordIndustryTypes { fitUnknown=0, fitRetail=1, fitRestaurant=2, fitGroceryStore=3, fitDirectMarketing=4, fitHotel=5 };
Default Value
fitRetail
Remarks
This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this component.
fitUnknown (0) | Unknown or unsure. |
fitRetail (1) | Retail store. |
fitRestaurant (2) | Food / Restaurant. |
fitGroceryStore (3) | Grocery store or supermarket. |
fitDirectMarketing (4) | eCommerce or Direct Marketing |
fitHotel (5) | Hotel / Lodging. |
Data Type
Integer
InstallmentCount Property (FDMSDetailRecord Component)
Total number of installments (installment transactions only).
Syntax
__property int InstallmentCount = { read=FInstallmentCount, write=FSetInstallmentCount };
Default Value
0
Remarks
This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSECommerce component.
To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord component to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:
FDMSECommerce.TransactionType = dmtInstallment
FDMSECommerce.TransactionAmount = "1995"
FDMSECommerce.Authorize()
FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate()
FDMSDetailRecord.InstallmentCount = 3
FDMSDetailRecord.InstallmentNumber = 1
FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()
Data Type
Integer
InstallmentNumber Property (FDMSDetailRecord Component)
Current installment number (installment transactions only).
Syntax
__property int InstallmentNumber = { read=FInstallmentNumber, write=FSetInstallmentNumber };
Default Value
0
Remarks
This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSECommerce component.
To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord component to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:
FDMSECommerce.TransactionType = dmtInstallment
FDMSECommerce.TransactionAmount = "1995"
FDMSECommerce.Authorize()
FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate()
FDMSDetailRecord.InstallmentCount = 3
FDMSDetailRecord.InstallmentNumber = 1
FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()
Data Type
Integer
PurchaseIdentifier Property (FDMSDetailRecord Component)
Optional purchase order number assigned by the merchant.
Syntax
__property String PurchaseIdentifier = { read=FPurchaseIdentifier, write=FSetPurchaseIdentifier };
Default Value
""
Remarks
In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and has a maximum length of 25 characters. For American Express transactions, only use the first 9 spaces.
Data Type
String
ResponseApprovalCode Property (FDMSDetailRecord Component)
Response Approval Code from the original authorization response.
Syntax
__property String ResponseApprovalCode = { read=FResponseApprovalCode, write=FSetResponseApprovalCode };
Default Value
""
Remarks
This field contains the authorization code obtained from the original authorization response. If the transaction is a credit or other non-approved transaction type, this property must be empty.
Data Type
String
ResponseAVSResult Property (FDMSDetailRecord Component)
Address Verification Code from the original authorization response.
Syntax
__property String ResponseAVSResult = { read=FResponseAVSResult, write=FSetResponseAVSResult };
Default Value
"0"
Remarks
This field contains a one character Address Verification (result) Code. This field contains the value returned in the original authorization response message. If the transaction is a credit or was otherwise processed off-line, this field should be defaulted to "0".
Data Type
String
ResponseReturnedACI Property (FDMSDetailRecord Component)
Authorization Characteristics Indicator from the original authorization response.
Syntax
__property String ResponseReturnedACI = { read=FResponseReturnedACI, write=FSetResponseReturnedACI };
Default Value
""
Remarks
This field contains a one character returned Authorization Characteristics Indicator. This indicator provides information on conditions or characteristics of the authorization code. If the transaction being settled was authorized on-line, this field must contain the value returned in that authorization response. If the transaction is a credit or was otherwise processed off-line, this field should be defaulted to SPACE.
Data Type
String
ServerId Property (FDMSDetailRecord Component)
Specifies the employee that served the customer. Used for restaurants only.
Syntax
__property String ServerId = { read=FServerId, write=FSetServerId };
Default Value
""
Remarks
This property pertains to restaurant transactions, and should be set with a merchant-assigned server Id code. This code identifies the employee which served the customer at the restaurant. This property is required for restaurant transactions, and is ignored for all other industry types. The maximum length for this property is 3.
Data Type
String
SettlementAmount Property (FDMSDetailRecord Component)
The amount that the customer will be charged.
Syntax
__property String SettlementAmount = { read=FSettlementAmount, write=FSetSettlementAmount };
Default Value
"0"
Remarks
This field contains the final settlement amount of the transaction. In most cases, this is the TransactionAmount from the original authorization request. However, you may settle a lesser amount (ie: Partial shipment or backordered stock). If using the Restaurant IndustryType, you may also increase the SettlementAmount by adding any Gratuity (if present).
This field must always be greater than zero.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
Data Type
String
TicketNumber Property (FDMSDetailRecord Component)
Ticket (receipt) number for this transaction.
Syntax
__property String TicketNumber = { read=FTicketNumber, write=FSetTicketNumber };
Default Value
""
Remarks
This property contains the Ticket number or Receipt of Charge (ROC) for this transaction. This may be optionally sent for any IndustryType, but it is required for Restaurant transactions that include a Gratuity.
The maximum length of this property is 10 digits.
For example, to add a gratuity to a charge:
FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate())
FDMSDetailRecord.Gratuity = "500"
FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity
FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()
Data Type
String
TransactionDate Property (FDMSDetailRecord Component)
Local Transaction Date (in MMDDYY format) from the original authorization response.
Syntax
__property String TransactionDate = { read=FTransactionDate, write=FSetTransactionDate };
Default Value
"010100"
Remarks
This six digit field contains a local transaction date associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value returned in the original authorization response message. If the transaction was processed off-line, this field must contain a Point of Sale (POS) device generated date. This field must appear in MMDDYY format.
Data Type
String
TransactionId Property (FDMSDetailRecord Component)
Transaction Identifier from the original authorization response.
Syntax
__property String TransactionId = { read=FTransactionId, write=FSetTransactionId };
Default Value
"000000000000000"
Remarks
This 15-character field contains a Transaction Identifier associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value (if returned) from the original authorization response message. If a value was not returned in the authorization response or the transaction was processed off-line, this field must be defaulted to zeros.
Data Type
String
TransactionTime Property (FDMSDetailRecord Component)
Local transaction time from the original authorization response.
Syntax
__property String TransactionTime = { read=FTransactionTime, write=FSetTransactionTime };
Default Value
"000000"
Remarks
This six digit field contains a local transaction time associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value generated by the FDMSECommerce or FDMSRetail component at the time of the sale. If the transaction was processed off-line, this field must contain a Point of Sale (POS) device generated time. This field must appear in HHMMSS format.
NOTE: This property is only applicable when settling a debit or EBT transaction, or a credit card transaction that includes Level 2 data, and may be ignored if such data is not being sent.
Data Type
String
TransactionType Property (FDMSDetailRecord Component)
Indicates transaction type for this detail record.
Syntax
__property TibcFDMSDetailRecordTransactionTypes TransactionType = { read=FTransactionType, write=FSetTransactionType };
enum TibcFDMSDetailRecordTransactionTypes { fttSale=0, fttForce=1, fttVoid=2, fttCredit=3, fttVoidCredit=4, fttDebitSale=5, fttDebitRefund=6, fttFoodStampSale=8, fttFoodStampRefund=9, fttCashBenefitSale=10, fttCashBenefitWithdrawal=11 };
Default Value
fttSale
Remarks
This property indicates the type of transaction that is being settled. The following table explains the Transaction Types in detail:
fttSale (0) | The transaction to be settled was a normal authorization and passed into the FDMSDetailRecord component via the ParseAggregate method. |
fttForce (1) | This transaction was not authorized using either the FDMSECommerce or FDMSRetail components. Instead it is created manually with the FDMSDetailRecord's properties. In order to successfully settle a Forced transaction, you must obtain an authorization code from a call center, and place it in the ResponseApprovalCode property. |
fttVoid (2) | When you wish to void a transaction that has been previously authorized, pass the details of the original transaction to the ParseAggregate method, and then change this TransactionType property to fttVoid. |
fttCredit (3) | This transaction type is used to credit money back to a cardholder's account. An (offline) credit is not based on a previous transaction, and you may credit any card for any amount without restriction. Simply set the CardNumber to the customer's card number, and then the AuthorizedAmount to "0" and the SettlementAmount to the amount you wish to refund. No track data or AVS data is sent in an offline credit transaction. |
fttVoidCredit (4) | This transaction voids a previous credit. |
fttDebitSale (5) | Settles an on-line Debit Sale transaction made using the FDMSDebit component. This transaction must not be edited before being settled. (It cannot be voided off-line) |
fttDebitRefund (6) | Settles an on-line Debit Credit transaction made using the FDMSDebit component. |
fttFoodStampSale (8) | Settles an on-line Food Stamp Sale or Voucher Clear made using the FDMSBenefit component. |
fttFoodStampRefund (9) | Settles an on-line Food Stamp Credit or Voucher Clear made using the FDMSBenefit component. |
fttCashBenefitSale (10) | Settles an on-line Cash Benefit sale made using the FDMSBenefit component. |
fttCashBenefitWithdrawal (11) | Settles an on-line Cash Withdrawl (Cash Only) transaction made using the FDMSBenefit component. |
Note: The fttSale and fttVoid TransactionTypes require a previous authorization to work on. fttForce and fttCredit, however, are offline transactions. This means there is no original authorization to work from. The transaction is created solely with this component's properties and is settled without ever having been authorized. Just fill out the properties and sent the FDMSSettle component's DetailAggregate array property with the results from the FDMSDetailRecord's GetDetailAggregate method. The remaining debit, food stamp, and cash benefit transactions may not be edited, voided, or otherwise modified before settlement. The detail aggregates should be set directly to the FDMSSettle component's DetailAggregate array property, and should never be manipulated with the FDMSDetailRecord component.
Data Type
Integer
ValidationCode Property (FDMSDetailRecord Component)
Validation Code from the original authorization response.
Syntax
__property String ValidationCode = { read=FValidationCode, write=FSetValidationCode };
Default Value
""
Remarks
This field contains a four character Transaction Identifier associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value (if returned) from the original authorization response message. If a value was not returned in the authorization response or the transaction was processed off-line, this field must be empty.
Data Type
String
Config Method (FDMSDetailRecord Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
GetDetailAggregate Method (FDMSDetailRecord Component)
Returns an aggregate containing details of this transaction, which is then used for settlement.
Syntax
String __fastcall GetDetailAggregate();
Remarks
This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSSettle component's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSDetailRecord component to do so.
Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseCaptureFlag is false) the method raises an exception.
An example of how this method is used is shown below:
FDMSRetail.AuthorizeTrack1()
If (FDMSRetail.ResponseCaptureFlag = True) Then
FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1
FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate()
End If
ParseAggregate Method (FDMSDetailRecord Component)
Parses the aggregate returned from another component's GetDetailAggregate method.
Syntax
void __fastcall ParseAggregate(String Aggregate);
Remarks
This method takes the XML aggregate returned from the FDMSRetail or FDMSECommerce component, parses it, and then fills all the properties of the FDMSDetailRecord component. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSSettle component, sometimes it is necessary to adjust the contents of the XML aggregate first.
For example, to add a gratuity to a charge:
FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate())
FDMSDetailRecord.Gratuity = "500"
FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity
FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()
Reset Method (FDMSDetailRecord Component)
Clears all properties to their default values.
Syntax
void __fastcall Reset();
Remarks
This method clears all properties to their default values.
Error Event (FDMSDetailRecord Component)
Fired when information is available about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TibcFDMSDetailRecordErrorEventParams; typedef void __fastcall (__closure *TibcFDMSDetailRecordErrorEvent)(System::TObject* Sender, TibcFDMSDetailRecordErrorEventParams *e); __property TibcFDMSDetailRecordErrorEvent OnError = { 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.
Config Settings (FDMSDetailRecord Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.FDMSDetailRecord Config Settings
Value | Description |
"" [Empty String] (default) | Not a DCC transaction |
1 | Converted |
2 | Not convertible |
3 | Convertible but declined by the cardholder |
4 | Reserved for future use |
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 (FDMSDetailRecord Component)
FDMSDetailRecord Errors
501 Data field invalid length. | |
502 Data field invalid format. | |
503 Data field out of range. | |
592 Invalid or unparseable aggregate. | |
605 Invalid CardType. |