FDMSRcRetail Control

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcRetail control is an advanced tool used to authorize credit cards in a Retail environment, where the customer is purchasing products or services in person. This control makes authorizing these types of transactions very easy. Supported Industry Types include retail stores and restaurants.

Syntax

FDMSRcRetail

Remarks

This control connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these controls go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the control. This control can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the control, any application or web page can be deployed without the need for expensive dedicated SSL servers.

The FDMSRcRetail control makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the control and authorizing a transaction are outlined below:

Datawire Setup

First, you must register and activate your account with Datawire. FDMS Rapid Connect will provide you with the following values:

• MerchantId
• MerchantTerminalNumber
• GroupId

The FDMSRegister control must be used to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through ServiceDiscovery, you may begin to authorize transactions. For instance:

 
 Copy
FDMSRegister.FDMSPlatform = FdmsregisterFDMSPlatforms.fpRapidConnect;
FDMSRegister.MerchantNumber = "000000999990";
FDMSRegister.MerchantTerminalNumber = "555555";
FDMSRegister.Config("GroupId=20001"); //Required for Rapid Connect

FDMSRegister.TransactionNumber = "1"; //any unique number will do.
FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do";
FDMSRegister.Register(); 
FDMSRegister.TransactionNumber = FDMSRegister.TransactionNumber + 1;
FDMSRegister.Activate();
FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL);
for (int i = 0; i < FDMSRegister.ServiceProviders.Length; i++) {
  FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]);
  Console.WriteLine(FDMSRegister.ServiceProviders[i] + " = " + FDMSRegister.PingResponseTime);
}

To authorize a credit, debit, ebt or FSA/HSA card set the MerchantId, MerchantTerminalNumber, and GroupId properties with the values supplied by FDMS Rapid Connect. Set the DatawireId property with the value retrieved by the FDMSRegister control after activating your merchant account. Set the URL property with one of the URLs you retrieved during ServiceDiscovery.

Transaction Processing

To begin processing transactions first set the required merchant values. For instance:

 
 Copy
retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;
retail.TPPID = "AAA000";
retail.MerchantTerminalNumber = "00000001";
retail.MerchantId = "1234";
retail.GroupId = "20001";
retail.DatawireId = "00011122233344455566";
retail.URL = "https://stg.dw.us.fdcnet.biz/rc";
retail.ApplicationId = "RAPIDCONNECTVXN";

Next specify transaction specific information. These values uniquely identify the transaction to Datawire and FDMS.

 
 Copy
retail.STAN = "112";
retail.TransactionNumber = "1234";
retail.OrderNumber = "123";
retail.ReferenceNumber = "123";

 
 Copy
retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD   /VISA^170410054321000000000000000  150  A";
retail.Card.EntryDataSource = EntryDataSources.edsTrack1;

retail.TransactionAmount = "1200"; //$12.00

Finally, submit the transaction by calling the Sale method.

 
 Copy
retail.Sale();

The ResponseCode property indicates the result of the transaction. A code of 000 indicates success. For all other values please see the Response Codes section. Additional Response properties such as ResponseApprovalCode, ResponseAuthorizedAmount, ResponseText, ResponseAVSResult, ResponseCVVResult, and more, provide further details about the transaction response.

To perform subsequent operations on a transaction, such as calling Reverse to reverse a Sale, or calling Capture to capture a previous AuthOnly transaction the GetDetailAggregate method must be used to get details about the original transaction. This aggregate must be stored securely, it will contain cardholder information that is required for subsequent transactions. For instance:

 
 Copy
retail.AuthOnly();

//Save the detail aggregate to use with Capture
string aggregate = retail.GetDetailAggregate();

//The aggregate must then be stored securely.
//At a later time the aggregate is retrieved in order to perform a capture.

//Capture
retail = new Fdmsrcretail();
...

//Specify the detail aggregate from the original transaction
retail.SetDetailAggregate(aggregate);

retail.Capture();

Transaction Types

In addition to a basic sale transaction, additional transaction types exist for other common operations. Not all transaction types are applicable for all controls. Check the method list for applicable transaction types.

Note: FDMS Rapid Connect is a host capture system. No explicit calls are needed to settle or otherwise manage the batch.

Gratuity for Restaurant Transactions:

In order to add gratuity the transaction may be authorized using AuthOnly and then Captured for a different amount that includes the tip. Gratuity cannot be added later to a Sale transaction. Consult FDMS for any applicable limits on the additional amount being captured.

Level 2 Transactions

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

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DestinationPostalCode (required)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2ProductDescription (required)
• Level2PurchaseIdentifier (required)
• Level2MerchantTaxId
• Level2ShipFromPostalCode
• Level2TaxAmount
• Level2TaxIndicator

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode
• Level2MerchantTaxId

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2MerchantTaxId (required)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode

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.

ApplicationId Property (FDMSRcRetail Control)

Identifies the merchant application to the Datawire System.

Syntax

fdmsrcretailcontrol.ApplicationId[=string]

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application Id identifies the application that has generated and is sending the transaction. This is a 15 character alphanumeric code that identifies each application and is provided by the Datawire Secure Transport Vendor Integration Team

This property may be validated along with the DatawireId as connection credentials.

The default value of this property is a value used for testing with Rapid Connect. You may be required to have a new ApplicationId assigned for the software you create with this control.

Data Type

String

InstallmentDescription Property (FDMSRcRetail Control)

The merchant's description of an Installment Bill Payment Transaction.

Syntax

fdmsrcretailcontrol.InstallmentDescription[=string]

Default Value

""

Remarks

The merchant's description of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 15 characters.

Data Type

String

InstallmentInvoiceNumber Property (FDMSRcRetail Control)

The Invoice Number of an Installment Bill Payment Transaction.

Syntax

fdmsrcretailcontrol.InstallmentInvoiceNumber[=string]

Default Value

""

Remarks

The Invoice Number of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 12 characters.

Data Type

String

InstallmentType Property (FDMSRcRetail Control)

The type of the Installment payment.

Syntax

fdmsrcretailcontrol.InstallmentType[=integer]

Possible Values

itUnspecified(0), 
itMerchant(1), 
itThirdParty(2), 
itIssuer(3)

Default Value

0

Remarks

The type of the Installment payment.

This field is required for all Discover, Diners (including JCB - US Domestic) Installment transactions TransactionIndicator value 3 (tiInstallment) and it is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

Data Type

Integer

MerchantAdviceCode Property (FDMSRcRetail Control)

This property contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

Syntax

fdmsrcretailcontrol.MerchantAdviceCode

Default Value

""

Remarks

This field contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

The following values are defined:

This property is read-only.

Data Type

String

MITAmount Property (FDMSRcRetail Control)

The amount of the Recurring or Installment payment.

Syntax

fdmsrcretailcontrol.MITAmount[=string]

Default Value

""

Remarks

The amount of the Recurring or Installment payment.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

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

MITAmountType Property (FDMSRcRetail Control)

Identifies the type of the Recurring or Installment Payment amount.

Syntax

fdmsrcretailcontrol.MITAmountType[=integer]

Possible Values

atUnspecified(0), 
atFixed(1), 
atVariable(2)

Default Value

0

Remarks

Identifies the type of the Recurring or Installment Payment amount.

The following values are defined:

Data Type

Integer

MITFrequency Property (FDMSRcRetail Control)

This property indicates the frequency of a Recurring or Installment payment.

Syntax

fdmsrcretailcontrol.MITFrequency[=integer]

Possible Values

freqUnspecified(0), 
freqDaily(1), 
freqWeekly(2), 
freqBiweekly(3), 
freqMonthly(4), 
freqQuarterly(5), 
freqBiannually(6), 
freqAnnually(7), 
freqUnscheduled(8), 
freqTenDays(9), 
freqTwiceWeekly(10), 
freqEveryTwoMonths(11), 
freqTrimester(12)

Default Value

0

Remarks

This field indicates the frequency of a Recurring or Installment payment.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

When the Card Type is 'Discover', 'JCB', or 'Diners', the valid values are 1, 2, 3, 4, 5, 6, 7, or 8.

For Visa Recurring transactions, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12.

For Visa Installment transactions, valid values are 2, 3, or 4.

Data Type

Integer

MITPaymentCurrency Property (FDMSRcRetail Control)

Contains the Installment Payment Currency represented as a 3 digit value.

Syntax

fdmsrcretailcontrol.MITPaymentCurrency[=string]

Default Value

"840"

Remarks

Contains the Installment Payment Currency represented as a 3 digit value.

This field is only applicable when Card Type is 'Visa'. For US Dollars, use "840".

Data Type

String

MITRecurringPaymentType Property (FDMSRcRetail Control)

This property contains the type of Recurring Payment.

Syntax

fdmsrcretailcontrol.MITRecurringPaymentType[=integer]

Possible Values

rptUnspecified(0), 
rptRegistration(1), 
rptSubsequent(2), 
rptModification(3), 
rptCancellation(4)

Default Value

0

Remarks

This field contains the type of Recurring Payment.

This field is only applicable when Card Type is 'Visa'. The following values are defined:

Data Type

Integer

MITRegistrationRefNum Property (FDMSRcRetail Control)

This property contains a unique Reference Number for the Recurring Payment transaction.

Syntax

fdmsrcretailcontrol.MITRegistrationRefNum[=string]

Default Value

""

Remarks

This field contains a unique Reference Number for the Recurring Payment transaction.

This field is only applicable when Card Type is 'Visa'.

The maximum length of this field is 35 characters.

Data Type

String

MITSequenceIndicator Property (FDMSRcRetail Control)

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

Syntax

fdmsrcretailcontrol.MITSequenceIndicator[=integer]

Default Value

0

Remarks

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

This field should be populated in ascending order and is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

Valid values for this field are numbers from 0 to 99.

Data Type

Integer

MITTotalPaymentAmount Property (FDMSRcRetail Control)

This property contains the Total Installment Amount.

Syntax

fdmsrcretailcontrol.MITTotalPaymentAmount[=string]

Default Value

""

Remarks

This field contains the Total Installment Amount.

This field is only applicable for Visa Installment transactions. Note : The total amount cannot exceed USD 500,000.

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

MITTotalPaymentCount Property (FDMSRcRetail Control)

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

Syntax

fdmsrcretailcontrol.MITTotalPaymentCount[=string]

Default Value

""

Remarks

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'. For Discover, the valid values should be from 02 to 99, UD and UC. For Visa, the valid values should be from 01 to 99. Note: For Visa recurring payments, value of '99' means that recurring payments are authorized until canceled or that the Number of Recurring Payments is not defined.

When this field is sent for Visa or Discover (including JCB - US Domestic Only and Diners), the Bill Payment Transaction Indicator must be present with the value of 'Recurring' or 'Installment'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field can only be sent when the Installment Type field contains the value of 'Merchant' or 'ThirdParty'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field must be sent for ALL Installment transactions for a series of payments, and the original CIT transaction must be initiated with 3DS.

The maximum length of this field is 2 characters.

Data Type

String

MITUniqueID Property (FDMSRcRetail Control)

This property is used to uniquely identify each of the Recurring or Installment Payment.

Syntax

fdmsrcretailcontrol.MITUniqueID[=string]

Default Value

""

Remarks

This field is used to uniquely identify each of the Recurring or Installment Payment. This ID is used to reference authorization transactions.

This field is only applicable when Card Type is 'Discover', 'JCB' or 'Diners'.

The maximum length of this field is 14 characters.

Data Type

String

MITValidationFlag Property (FDMSRcRetail Control)

Indicates the validation source for the validity of a transaction.

Syntax

fdmsrcretailcontrol.MITValidationFlag[=integer]

Possible Values

vfUnspecified(0), 
vfValidated(1), 
vfNotValidated(2)

Default Value

0

Remarks

Indicates the validation source for the validity of a transaction.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

The following values are defined:

Data Type

Integer

MITValidationRef Property (FDMSRcRetail Control)

This property contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

Syntax

fdmsrcretailcontrol.MITValidationRef[=string]

Default Value

""

Remarks

This field contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

This field is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

The maximum length of this field is 20 characters.

Data Type

String

TransactionIndicator Property (FDMSRcRetail Control)

Specifies the type of Bill Payment being made.

Syntax

fdmsrcretailcontrol.TransactionIndicator[=integer]

Possible Values

tiUnspecified(0), 
tiSingleTransaction(1), 
tiRecurring(2), 
tiInstallment(3), 
tiDeferredBilling(4)

Default Value

0

Remarks

Specifies the type of Bill Payment being made.

This property contains the type of bill payment being made. This is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

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:

 
 Copy
  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

CardType Property (FDMSRcRetail Control)

Type of credit card being used in this transaction.

Syntax

fdmsrcretailcontrol.CardType[=integer]

Possible Values

ctUnknown(0), 
ctVisa(1), 
ctMasterCard(2), 
ctAMEX(3), 
ctDiscover(4), 
ctDiners(5), 
ctJCB(6), 
ctVisaElectron(7), 
ctMaestro(8), 
ctLaser(10)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (FDMSRcRetail Control)

Three digit security code on back of card (optional).

Syntax

fdmsrcretailcontrol.CardCVVData[=string]

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (FDMSRcRetail Control)

Indicates the presence of the card verification value.

Syntax

fdmsrcretailcontrol.CardCVVPresence[=integer]

Possible Values

cvpNotProvided(0), 
cvpProvided(1), 
cvpIllegible(2), 
cvpNotOnCard(3)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The control will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (FDMSRcRetail Control)

This property contains a 1-character code identifying the source of the customer data.

Syntax

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

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (FDMSRcRetail Control)

Expiration month of the credit card specified in Number .

Syntax

fdmsrcretailcontrol.CardExpMonth[=integer]

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (FDMSRcRetail Control)

Expiration year of the credit card specified in Number .

Syntax

fdmsrcretailcontrol.CardExpYear[=integer]

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property 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 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (FDMSRcRetail Control)

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

fdmsrcretailcontrol.CardIsEncrypted[=boolean]

Default Value

False

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (FDMSRcRetail Control)

Track data read off of the card's magnetic stripe.

Syntax

fdmsrcretailcontrol.CardMagneticStripe[=string]

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

 
 Copy
control.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
control.CardEntryDataSource = edsTrack1

or

control.CardMagneticStripe = "4788250000028291=05121015432112345678"
control.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (FDMSRcRetail Control)

Customer's credit card number for the transaction.

Syntax

fdmsrcretailcontrol.CardNumber[=string]

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

CashBack Property (FDMSRcRetail Control)

Optional cash back amount to return to the customer.

Syntax

fdmsrcretailcontrol.CashBack[=string]

Default Value

""

Remarks

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 largest possible CashBack amount is "99999", yielding a maximum US dollar amount of $999.99. This field may not contain a negative number.

For cash back transactions, the TransactionAmount must contain the sum total of the purchase amount PLUS the CashBack amount. If the purchase is for $10 and the customer requests $20 cash back, CashBack should be set to "2000" and TransactionAmount must contain "3000".

Note that only US currency is supported for debit transactions.

Data Type

String

CustomerAddress Property (FDMSRcRetail Control)

The customer's billing address.

Syntax

fdmsrcretailcontrol.CustomerAddress[=string]

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

The maximum length of this property is 30 characters.

If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

Data Type

String

CustomerZip Property (FDMSRcRetail Control)

Customer's zip code (or postal code if outside of the USA).

Syntax

fdmsrcretailcontrol.CustomerZip[=string]

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

The maximum length of this property is 9 characters.

Data Type

String

DatawireId Property (FDMSRcRetail Control)

Identifies the merchant to the Datawire System.

Syntax

fdmsrcretailcontrol.DatawireId[=string]

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister control). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Data Type

String

DigitalWalletType Property (FDMSRcRetail Control)

Identifies the brand of digital wallet or tokenization program used in a transaction.

Syntax

fdmsrcretailcontrol.DigitalWalletType[=integer]

Possible Values

frdwNotUsed(0), 
frdwAndroidPay(1), 
frdwApplePay(2), 
frdwMerchantTokenization(3), 
frdwSamsungPay(4), 
frdwDiscoverClickToPay(5)

Default Value

0

Remarks

Digital Wallet Program Type. Possible values are:

Data Type

Integer

EMVData Property (FDMSRcRetail Control)

The EMV Data returned from a Pin Pad after reading an EMV card.

Syntax

fdmsrcretailcontrol.EMVData[=string]

Default Value

""

Remarks

This configuration setting takes the entire TLV (tag-length-value) response received from a Pin Pad after reading an EMV card. The control will send this data in an authorization request.

Retail EMV Example

 
 Copy
Fdmsrcretail fdmsrcretail = new Fdmsrcretail();
fdmsrcretail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;
 
fdmsrcretail.TPPID = "AAA000";
fdmsrcretail.MerchantTerminalNumber = "00000001";
fdmsrcretail.MerchantId = "1234";
fdmsrcretail.GroupId = "20001";
fdmsrcretail.DatawireId = "00011122233344455566";
fdmsrcretail.VisaIdentifier = "01000000000000";
fdmsrcretail.ApplicationId = "RAPIDCONNECTVXN";
fdmsrcretail.URL = "https://stg.dw.us.fdcnet.biz/rc";
 
fdmsrcretail.STAN = "112";
fdmsrcretail.TransactionNumber = "120013";
fdmsrcretail.ReferenceNumber = "123456";
fdmsrcretail.OrderNumber = "12000503";
 
fdmsrcretail.Card.MagneticStripe = "4761739001010010=15122011143804489";
fdmsrcretail.Card.EntryDataSource = EntryDataSources.edsTrack2;
fdmsrcretail.TransactionAmount = "250";
fdmsrcretail.EMVData = "9F4005F000F0A0019F...F7906123456789012";
fdmsrcretail.Sale();

Data Type

String

GroupId Property (FDMSRcRetail Control)

The Id assigned by FDMS to identify the merchant or group of merchants.

Syntax

fdmsrcretailcontrol.GroupId[=string]

Default Value

""

Remarks

This property specifies the FDMS assigned group Id. This Id identifies the merchant or group of merchants. This property is required.

Data Type

String

IndustryType Property (FDMSRcRetail Control)

The merchant's industry type.

Syntax

fdmsrcretailcontrol.IndustryType[=integer]

Possible Values

fritRetail(0), 
fritRestaurant(1), 
fritHotel(2)

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Data Type

Integer

Level2CustomerReferenceNumber Property (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

This property contains the discount amount for the purchase.

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

This property contains the duty amount for this purchase.

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.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 (FDMSRcRetail Control)

This property indicates the taxable status of the transaction.

Syntax

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

MerchantId Property (FDMSRcRetail Control)

A unique Id used to identify the merchant within the FDMS and Datawire systems.

Syntax

fdmsrcretailcontrol.MerchantId[=string]

Default Value

""

Remarks

This property holds the Merchant Id assigned by FDMS. The value is an alphanumeric value up to 16 characters in length.

This property is required.

Data Type

String

MerchantServicePhone Property (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.MerchantServicePhone[=string]

Default Value

""

Remarks

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

This value is required for MOTO transactions. It is recommended but not required for ecommerce and hotel transactions.

Data Type

String

MerchantTerminalNumber Property (FDMSRcRetail Control)

Used to identify a unique terminal within a merchant location.

Syntax

fdmsrcretailcontrol.MerchantTerminalNumber[=string]

Default Value

""

Remarks

This property contains a number assigned by FDMS to uniquely identify a terminal within a merchant location. The value is numeric and may be up to 8 digits in length.

This property is required.

Data Type

String

MerchantURL Property (FDMSRcRetail Control)

The URL of the site performing the ECommerce transaction.

Syntax

fdmsrcretailcontrol.MerchantURL[=string]

Default Value

""

Remarks

This property specifies the URL of the merchant's site. This value is required for ECommerce and Hotel AuthOnly, Sale, Capture, and Credit transactions.

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

Data Type

String

OrderNumber Property (FDMSRcRetail Control)

A merchant assigned order number to uniquely reference the transaction.

Syntax

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

ProxyAuthScheme Property (FDMSRcRetail Control)

The type of authorization to perform when connecting to the proxy.

Syntax

fdmsrcretailcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FDMSRcRetail Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fdmsrcretailcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (FDMSRcRetail Control)

A password if authentication is to be used for the proxy.

Syntax

fdmsrcretailcontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FDMSRcRetail Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fdmsrcretailcontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FDMSRcRetail Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fdmsrcretailcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FDMSRcRetail Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fdmsrcretailcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FDMSRcRetail Control)

A username if authentication is to be used for the proxy.

Syntax

fdmsrcretailcontrol.ProxyUser[=string]

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ReferenceNumber Property (FDMSRcRetail Control)

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

Syntax

fdmsrcretailcontrol.ReferenceNumber[=string]

Default Value

""

Remarks

This value is a merchant assigned 12 digit value. The value must be unique within a day for a given merchant id and terminal id. When performing a Capture or Reverse transaction this must be the same as the original transaction.

Data Type

String

ResponseApprovalCode Property (FDMSRcRetail Control)

The Approval Code returned from the server after a successful authorization.

Syntax

fdmsrcretailcontrol.ResponseApprovalCode

Default Value

""

Remarks

The Approval Code returned from the server after a successful authorization.

This value holds the approval code returned by the authorizer. This value will contain up to 8 characters. Only alphanumeric characters and spaces will be returned.

This property is read-only and not available at design time.

Data Type

String

ResponseAuthorizedAmount Property (FDMSRcRetail Control)

The amount actually charged to the card.

Syntax

fdmsrcretailcontrol.ResponseAuthorizedAmount

Default Value

""

Remarks

The amount actually charged to the card.

This value holds the amount charged to the card. In the case of a partial authorization this will be different than the amount specified in TransactionAmount.

You must collect the remainder via another form of payment, or Reverse the authorization if the customer does not have an additional form of payment.

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.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkId Property (FDMSRcRetail Control)

This property indicates the network Id as returned by the host, if available.

Syntax

fdmsrcretailcontrol.ResponseAuthorizingNetworkId

Default Value

""

Remarks

This field indicates the network Id as returned by the host, if available.

This value is up to 3 alphanumeric characters.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkName Property (FDMSRcRetail Control)

This property indicates the authorizing network name as returned by the host, when available.

Syntax

fdmsrcretailcontrol.ResponseAuthorizingNetworkName

Default Value

""

Remarks

This field indicates the authorizing network name as returned by the host, when available.

This property is read-only.

Data Type

String

ResponseAVSResult Property (FDMSRcRetail Control)

Contains the Address Verification System result code.

Syntax

fdmsrcretailcontrol.ResponseAVSResult

Default Value

""

Remarks

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. This property is populated if a value is present in the response. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. Possible AVS codes are listed in the table below.

Visa Card AVS Codes

MasterCard AVS Codes

Amex AVS Codes

Discover or JCB

This property is read-only.

Data Type

String

ResponseBalance Property (FDMSRcRetail Control)

Contains the remaining available balance left on the card.

Syntax

fdmsrcretailcontrol.ResponseBalance

Default Value

""

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

This property is read-only and not available at design time.

Data Type

String

ResponseCardLevelResult Property (FDMSRcRetail Control)

This property is only applicable to Visa card.

Syntax

fdmsrcretailcontrol.ResponseCardLevelResult

Default Value

""

Remarks

This property is only applicable to Visa card. This property holds a two character value returned by Visa to designate the type of card product used to process the transaction.

This property is read-only and not available at design time.

Data Type

String

ResponseCode Property (FDMSRcRetail Control)

Contains the 3 digit response code indicating success or reason of failure.

Syntax

fdmsrcretailcontrol.ResponseCode

Default Value

""

Remarks

Contains the 3 digit response code indicating success or reason of failure.

This property contains a 3 digit code indicating success or the reason of failure. A value of 000 indicates approval. For all other values please see the Response Codes section.

This property is read-only.

Data Type

String

ResponseCommercialCard Property (FDMSRcRetail Control)

Indicates whether the credit card charged is a corporate commercial card.

Syntax

fdmsrcretailcontrol.ResponseCommercialCard

Possible Values

rcctNotCommercial(0), 
rcctPurchaseCard(1), 
rcctCorporateCard(2), 
rcctBusinessCard(3), 
rcctUnknown(4)

Default Value

0

Remarks

Indicates whether the credit card charged is a corporate commercial card.

This is only applicable to Visa cards. Visa Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data when calling Capture when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Tax amounts should be included with the Level2 or Level3 data when calling Capture in order to receive the best interchange rate.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (FDMSRcRetail Control)

Contains the returned CVV result code (if CVV data was sent in the request).

Syntax

fdmsrcretailcontrol.ResponseCVVResult

Default Value

""

Remarks

Contains the returned CVV result code (if CVV data was sent in the request).

If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. This property is populated if a value is present in the response. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSRcRetail Control)

Contains an error code providing more details about the DatawireStatus received.

Syntax

fdmsrcretailcontrol.ResponseDatawireReturnCode

Default Value

""

Remarks

Contains an error code providing more details about the ResponseDatawireStatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseApprovalCode contains the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (FDMSRcRetail Control)

Status of the communication with Datawire.

Syntax

fdmsrcretailcontrol.ResponseDatawireStatus

Default Value

""

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseApprovalCode contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

ResponseEMVData Property (FDMSRcRetail Control)

Contains the EMV data returns in the response (if any).

Syntax

fdmsrcretailcontrol.ResponseEMVData

Default Value

""

Remarks

Contains the EMV data returns in the response (if any).

This property is only applicable to Retail and Debit transactions.

This property is read-only and not available at design time.

Data Type

String

ResponsePOSData Property (FDMSRcRetail Control)

This property holds transaction specific information returned by the issuer (if any).

Syntax

fdmsrcretailcontrol.ResponsePOSData

Default Value

""

Remarks

This property holds transaction specific information returned by the issuer (if any). This is only applicable to MasterCard, Discover, and AmEx card transactions.

This property is read-only and not available at design time.

Data Type

String

ResponseReturnedACI Property (FDMSRcRetail Control)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

fdmsrcretailcontrol.ResponseReturnedACI

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI) for Visa transactions. This value provides information concerning the transaction's Customer Payment Service (CPS) qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value.

Possible returned ACI values are:

This property is read-only.

Data Type

String

ResponseRoutingIndicator Property (FDMSRcRetail Control)

Indicates whether the transaction was processed as Credit or Debit.

Syntax

fdmsrcretailcontrol.ResponseRoutingIndicator

Default Value

""

Remarks

Indicates whether the transaction was processed as Credit or Debit. Possible values are:

This property is read-only.

Data Type

String

ResponseSettlementDate Property (FDMSRcRetail Control)

The date the transaction will be settled in the format MMDD.

Syntax

fdmsrcretailcontrol.ResponseSettlementDate

Default Value

""

Remarks

The date the transaction will be settled in the format MMDD.

This property is read-only.

Data Type

String

ResponseText Property (FDMSRcRetail Control)

This property may hold additional text which describes the reason for a decline, the property in error, etc.

Syntax

fdmsrcretailcontrol.ResponseText

Default Value

""

Remarks

This property may hold additional text which describes the reason for a decline, the field in error, etc. Applications should not be coded to the text in this property as it is subject to change.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (FDMSRcRetail Control)

The transaction date returned from the server in yyyyMMddHHmmss format.

Syntax

fdmsrcretailcontrol.ResponseTransactionDate

Default Value

""

Remarks

The transaction date returned from the server in yyyyMMddHHmmss format.

This 15 digit field contains the transaction date and time returned by the Rapid Connect system. This is not a local datetime, it is the time according the Rapid Connect system.

This property is read-only.

Data Type

String

ResponseTransactionId Property (FDMSRcRetail Control)

Card issuer's Transaction Reference Number.

Syntax

fdmsrcretailcontrol.ResponseTransactionId

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet data, American Express Transaction Id, or Discover Network Result Indicator (NRID). If returned in the response, this property should be printed on the receipt.

This property is read-only and not available at design time.

Data Type

String

ReversalTransactionType Property (FDMSRcRetail Control)

The type of transaction to reverse.

Syntax

fdmsrcretailcontrol.ReversalTransactionType[=integer]

Possible Values

frttAuthOnly(0), 
frttCapture(1), 
frttCredit(2), 
frttSale(3)

Default Value

0

Remarks

This property specifies the type of transaction to reverse. Possible values are:

Data Type

Integer

ReversalType Property (FDMSRcRetail Control)

The type of reversal.

Syntax

fdmsrcretailcontrol.ReversalType[=integer]

Possible Values

frtFullReversal(0), 
frtTimeoutReversal(1), 
frtVoidForSuspectedFraud(2), 
frtPartialReversal(3)

Default Value

0

Remarks

This property specifies the type of reversal. Possible values are:

Timeout Reversals are applicable to the following transaction types:

• AuthOnly
• Capture
• Credit
• Sale

Full Reversals are applicable to the following transaction types:

• AuthOnly
• Sale

Data Type

Integer

SettlementMode Property (FDMSRcRetail Control)

Indicates whether the control uses Host Capture (0) or Terminal Capture (1) system.

Syntax

fdmsrcretailcontrol.SettlementMode[=integer]

Possible Values

smiHostCapture(0), 
smiTerminalCapture(1)

Default Value

0

Remarks

Possible values are:

Host-Capture means that you authorize your transactions using the AuthOnly or Sale methods, and you process refunds and capture outstanding authorizations with the Credit and Capture methods. FDMS Rapid Connect handles all batch management.

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging IndustryType, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types may be processed in Terminal Capture mode. However, Hotel/Lodging transactions MUST be authorized and settled in Terminal Capture mode. Attempting to authorize a Hotel/Lodging transaction with the Host Capture mode will cause the control fails with an error.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (FDMSRcRetail Control)

The date on which this certificate becomes valid.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (FDMSRcRetail Control)

The date on which the certificate expires.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (FDMSRcRetail Control)

A comma-delimited list of extended key usage identifiers.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (FDMSRcRetail Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (FDMSRcRetail Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (FDMSRcRetail Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (FDMSRcRetail Control)

The issuer of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (FDMSRcRetail Control)

The private key of the certificate (if available).

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (FDMSRcRetail Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (FDMSRcRetail Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (FDMSRcRetail Control)

The public key of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (FDMSRcRetail Control)

The textual description of the certificate's public key algorithm.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (FDMSRcRetail Control)

The length of the certificate's public key (in bits).

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (FDMSRcRetail Control)

The serial number of the certificate encoded as a string.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (FDMSRcRetail Control)

The text description of the certificate's signature algorithm.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (FDMSRcRetail Control)

The name of the certificate store for the client certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (FDMSRcRetail Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (FDMSRcRetail Control)

The type of certificate store for this certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (FDMSRcRetail Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (FDMSRcRetail Control)

The MD5 hash of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (FDMSRcRetail Control)

The SHA-1 hash of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (FDMSRcRetail Control)

The SHA-256 hash of the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (FDMSRcRetail Control)

The text description of UsageFlags .

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (FDMSRcRetail Control)

The flags that show intended use for the certificate.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (FDMSRcRetail Control)

The certificate's version number.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (FDMSRcRetail Control)

The subject of the certificate used for client authentication.

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (FDMSRcRetail Control)

The certificate (PEM/Base64 encoded).

Syntax

fdmsrcretailcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (FDMSRcRetail Control)

The date on which this certificate becomes valid.

Syntax

fdmsrcretailcontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (FDMSRcRetail Control)

The date on which the certificate expires.

Syntax

fdmsrcretailcontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (FDMSRcRetail Control)

A comma-delimited list of extended key usage identifiers.

Syntax

fdmsrcretailcontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (FDMSRcRetail Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fdmsrcretailcontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (FDMSRcRetail Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fdmsrcretailcontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (FDMSRcRetail Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fdmsrcretailcontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (FDMSRcRetail Control)

The issuer of the certificate.

Syntax

fdmsrcretailcontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (FDMSRcRetail Control)

The private key of the certificate (if available).

Syntax

fdmsrcretailcontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (FDMSRcRetail Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

fdmsrcretailcontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (FDMSRcRetail Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

fdmsrcretailcontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (FDMSRcRetail Control)

The public key of the certificate.

Syntax

fdmsrcretailcontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (FDMSRcRetail Control)

The textual description of the certificate's public key algorithm.

Syntax

fdmsrcretailcontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (FDMSRcRetail Control)

The length of the certificate's public key (in bits).

Syntax

fdmsrcretailcontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (FDMSRcRetail Control)

The serial number of the certificate encoded as a string.

Syntax

fdmsrcretailcontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (FDMSRcRetail Control)

The text description of the certificate's signature algorithm.

Syntax

fdmsrcretailcontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks