FDMSRcRetail Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPayments.DPaymentsSDK.Fdmsrcretail

Remarks

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

The FDMSRcRetail component 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 component 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 component 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:

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 component 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: 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. retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.ReferenceNumber = "123"; Then specify customer card and address information along with the transaction amount: 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.

retail.Sale();

The Code field 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 ApprovalCode, AuthorizedAmount, Text, AVSResult, CVVResult, 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:

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

• CustomerReferenceNumber (required if TaxAmount specified)
• DestinationPostalCode (required)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• ProductDescription (required)
• PurchaseIdentifier (required)
• MerchantTaxId
• ShipFromPostalCode
• TaxAmount
• TaxIndicator

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode
• MerchantTaxId

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• MerchantTaxId (required)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

ApplicationId Property (FDMSRcRetail Component)

Identifies the merchant application to the Datawire System.

Syntax

• C#
• VB.NET

public string ApplicationId { get; set; }

Public Property ApplicationId As 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 component.

BillPay Property (FDMSRcRetail Component)

Specifies information used in a bill payment or MIT transaction

Syntax

• C#
• VB.NET

public FDMSRcBillPay BillPay { get; set; }

Public Property BillPay As FDMSRcBillPay

Remarks

This property specifies information used in processing a bill payment or MIT transaction.

Card Property (FDMSRcRetail Component)

Contains the customer's credit card information.

Syntax

• C#
• VB.NET

public CCCard Card { get; set; }

Public Property Card As CCCard

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

CashBack Property (FDMSRcRetail Component)

Optional cash back amount to return to the customer.

Syntax

• C#
• VB.NET

public string CashBack { get; set; }

Public Property CashBack As 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.

CustomerAddress Property (FDMSRcRetail Component)

The customer's billing address.

Syntax

• C#
• VB.NET

public string CustomerAddress { get; set; }

Public Property CustomerAddress As 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.

CustomerZip Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string CustomerZip { get; set; }

Public Property CustomerZip As 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.

DatawireId Property (FDMSRcRetail Component)

Identifies the merchant to the Datawire System.

Syntax

• C#
• VB.NET

public string DatawireId { get; set; }

Public Property DatawireId As 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 component). 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.

EMVData Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string EMVData { get; set; }

Public Property EMVData As 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 component will send this data in an authorization request.

Retail EMV Example 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();

GroupId Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string GroupId { get; set; }

Public Property GroupId As 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.

IndustryType Property (FDMSRcRetail Component)

The merchant's industry type.

Syntax

• C#
• VB.NET

public FdmsrcretailIndustryTypes IndustryType { get; set; }

enum FdmsrcretailIndustryTypes {
  fritRetail,
  fritRestaurant,
  fritHotel
}

Public Property IndustryType As FdmsrcretailIndustryTypes

Enum FdmsrcretailIndustryTypes
  fritRetail
  fritRestaurant
  fritHotel
End Enum

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Level2 Property (FDMSRcRetail Component)

Specifies Level 2 (purchasing card information).

Syntax

• C#
• VB.NET

public FDMSRcLevel2 Level2 { get; set; }

Public Property Level2 As FDMSRcLevel2

Remarks

This property specifies Level 2 (purchasing card information).

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

American Express

• CustomerReferenceNumber (required if TaxAmount specified)
• DestinationPostalCode (required)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• ProductDescription (required)
• PurchaseIdentifier (required)
• MerchantTaxId
• ShipFromPostalCode
• TaxAmount
• TaxIndicator

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode
• MerchantTaxId

• CustomerReferenceNumber (required if TaxAmount specified)
• DiscountAmount (required if discount applied)
• DutyAmount (required if duty amount applied)
• FreightAmount (required if freight amount applied)
• MerchantTaxId (required)
• PurchaseIdentifier (required)
• TaxAmount (required if TaxIndicator indicates tax is applied)
• TaxIndicator (required)
• DestinationPostalCode
• ShipFromPostalCode

MerchantId Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string MerchantId { get; set; }

Public Property MerchantId As 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.

MerchantServicePhone Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string MerchantServicePhone { get; set; }

Public Property MerchantServicePhone As String

Default Value

""

Remarks

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

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

MerchantTerminalNumber Property (FDMSRcRetail Component)

Used to identify a unique terminal within a merchant location.

Syntax

• C#
• VB.NET

public string MerchantTerminalNumber { get; set; }

Public Property MerchantTerminalNumber As 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.

MerchantURL Property (FDMSRcRetail Component)

The URL of the site performing the ECommerce transaction.

Syntax

• C#
• VB.NET

public string MerchantURL { get; set; }

Public Property MerchantURL As 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.

OrderNumber Property (FDMSRcRetail Component)

A merchant assigned order number to uniquely reference the transaction.

Syntax

• C#
• VB.NET

public string OrderNumber { get; set; }

Public Property OrderNumber As String

Default Value

""

Remarks

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

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

Proxy Property (FDMSRcRetail Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

ReferenceNumber Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string ReferenceNumber { get; set; }

Public Property ReferenceNumber As 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.

Response Property (FDMSRcRetail Component)

Contains the response to an authorization request.

Syntax

• C#
• VB.NET

public FDMSRcResponse Response { get; }

Public ReadOnly Property Response As FDMSRcResponse

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSRcResponse type contains the following fields:

This property is read-only.

ReversalTransactionType Property (FDMSRcRetail Component)

The type of transaction to reverse.

Syntax

• C#
• VB.NET

public FdmsrcretailReversalTransactionTypes ReversalTransactionType { get; set; }

enum FdmsrcretailReversalTransactionTypes {
  frttAuthOnly,
  frttCapture,
  frttCredit,
  frttSale
}

Public Property ReversalTransactionType As FdmsrcretailReversalTransactionTypes

Enum FdmsrcretailReversalTransactionTypes
  frttAuthOnly
  frttCapture
  frttCredit
  frttSale
End Enum

Default Value

0

Remarks

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

ReversalType Property (FDMSRcRetail Component)

The type of reversal.

Syntax

• C#
• VB.NET

public FdmsrcretailReversalTypes ReversalType { get; set; }

enum FdmsrcretailReversalTypes {
  frtFullReversal,
  frtTimeoutReversal,
  frtVoidForSuspectedFraud,
  frtPartialReversal
}

Public Property ReversalType As FdmsrcretailReversalTypes

Enum FdmsrcretailReversalTypes
  frtFullReversal
  frtTimeoutReversal
  frtVoidForSuspectedFraud
  frtPartialReversal
End Enum

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

SettlementMode Property (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public FdmsrcretailSettlementModes SettlementMode { get; set; }

enum FdmsrcretailSettlementModes {
  smiHostCapture,
  smiTerminalCapture
}

Public Property SettlementMode As FdmsrcretailSettlementModes

Enum FdmsrcretailSettlementModes
  smiHostCapture
  smiTerminalCapture
End Enum

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 component throws an exception.

SSLAcceptServerCert Property (FDMSRcRetail Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (FDMSRcRetail Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (FDMSRcRetail Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public FdmsrcretailSSLProviders SSLProvider { get; set; }

enum FdmsrcretailSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As FdmsrcretailSSLProviders

Enum FdmsrcretailSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (FDMSRcRetail Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

STAN Property (FDMSRcRetail Component)

The merchant assigned System Trace Audit Number(STAN).

Syntax

• C#
• VB.NET

public string STAN { get; set; }

Public Property STAN As String

Default Value

""

Remarks

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

Valid values are from 000001 to 999999 inclusive.

Timeout Property (FDMSRcRetail Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the component will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

TPPID Property (FDMSRcRetail Component)

Third Party Processor Identifier assigned by FDMS.

Syntax

• C#
• VB.NET

public string TPPID { get; set; }

Public Property TPPID As String

Default Value

""

Remarks

The Third Party Processor Identifier (TPPID. Also sometimes referred to as a "Vendor Id") is assigned by FDMS to each third party who is processing transactions. Each merchant will receive a TPPID from FDMS.

The default value is "" (empty string). This should be set to the FDMS assigned TPPID.

A VisaIdentifier is also required for Visa transactions.

TransactionAmount Property (FDMSRcRetail Component)

The transaction amount to be authorized.

Syntax

• C#
• VB.NET

public string TransactionAmount { get; set; }

Public Property TransactionAmount As String

Default Value

""

Remarks

This property contains the transaction amount to be authorized.

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.

TransactionNumber Property (FDMSRcRetail Component)

Uniquely identifies the transaction.

Syntax

• C#
• VB.NET

public string TransactionNumber { get; set; }

Public Property TransactionNumber As String

Default Value

""

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

For all components except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, and nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

URL Property (FDMSRcRetail Component)

Location of the Datawire server to which transactions are sent.

Syntax

• C#
• VB.NET

public string URL { get; set; }

Public Property URL As String

Default Value

"https://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister component. Once you Register and Activate the merchant using the FDMSRegister component, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister component.

VisaIdentifier Property (FDMSRcRetail Component)

Additional merchant identification field used when authorizing Visa transactions.

Syntax

• C#
• VB.NET

public string VisaIdentifier { get; set; }

Public Property VisaIdentifier As String

Default Value

""

Remarks

First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). Each Visa Agent Identifier in the chain is composed of the following pieces:

A VisaIdentifier (Agent Identification Service - AUAR) is required for Visa transactions. A VisaIdentifier value is assigned by Visa as part of their Trusted Agent Program (TAP). Therefore it is suggested that you contact your FDMS certification analyst as they should be able to provide you with further information and put you in contact with the required party at Visa. Unfortunately more specific information on this matter cannot be provided as we do not handle live customer data and thus are not required to register in this particular program. However below is some additional information in regards to the requirements of a Visa Identifier.

Any merchant that transmits, processes, or stores cardholder data on server(s) that you own, manage, or operate on behalf of your clients (who are other merchant account holders) must meet the PCI Data Security Standard and follow additional steps to register as a service provider. Applicable services commonly include webhosting, software as a service, or collecting payment on behalf of a client. Any company providing these services must register with Visa's Third Party Agent (TAP) program.

You can register for the Visa Third Party Agent Program at http://usa.visa.com/merchants/risk_management/third-party-registration.html

If you find that you are not required to register with this program you can send all spaces for the BID and all zeros for the AUAR for instance: " 000000000000"

AuthOnly Method (FDMSRcRetail Component)

Performs an authorization request.

Syntax

• C#
• VB.NET

public void AuthOnly();

Public Sub AuthOnly()

Remarks

This method performs an authorization request. This transaction places a hold on the funds. To capture the funds the Capture method must be called.

After calling this method call GetDetailAggregate to generate a detail aggregate. The detail aggregate should be saved for use with Capture or Reverse later.

When ready to Capture or Reverse the transaction call SetDetailAggregate to the previously stored detail aggregate before calling the method.

After this method returns check the value of Code to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Retail AuthOnly Example 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"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.TransactionAmount = "1200"; retail.ReferenceNumber = "123"; retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^170410054321000000000000000 150 A"; retail.Card.EntryDataSource = EntryDataSources.edsTrack1; retail.AuthOnly();

BalanceInquiry Method (FDMSRcRetail Component)

Performs a Balance Inquiry Request using the specified Card data.

Syntax

• C#
• VB.NET

public void BalanceInquiry();

Public Sub BalanceInquiry()

Remarks

This methods allows you to perform a Balance Inquiry Request using the specified Card data. The balance amount will be returned via Balance. Note that Balance Inquiries do not place a hold on a cardholder's funds and are not captured.

Note: This method is only applicable to swiped MasterCards.

Capture Method (FDMSRcRetail Component)

Captures a previously authorized transaction.

Syntax

• C#
• VB.NET

public void Capture();

Public Sub Capture()

Remarks

This method captures a previously authorized transaction. Before calling this method call SetDetailAggregate to specify the detail aggregate from the original AuthOnly transaction.

After this method returns check the value of Code to determine if the transaction was successful.

FDMS Recommendations:

Vendors/Gateways, who systematically send all Capture transactions during their end of day processing or at a specific time for their entire chain, must configure/program their systems to send the Capture transactions for all locations or merchants varying times of day based on the MerchantId or MerchantTerminalNumber (whichever provides a more random value).

To assist with implementing this logic, FDMS Rapid Connect recommends sending the Capture transactions based on the MerchantTerminalNumber in each location. For example If the last digit of the MerchantTerminalNumber is 0, set the time for the Capture transactions to be sent as xx:00 (xx=hh:00=mm). The time for the MerchantTerminalNumber ending with 1 would be xx:05. The time for the MerchantTerminalNumber ending with 2 would be xx:10. All remaining MerchantTerminalNumbers would follow this same logic. This logic would be applied across the entire chain or merchant base, to ensure that all Captures for all merchants are not systematically sent to First Data at the same time. FDMS recommends that the software calculate the offset of time based on the MerchantId or MerchantTerminalNumber, and not rely on a user to specify the time as noted above.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Retail AuthOnly and Capture Example 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"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.ReferenceNumber = "123456"; retail.TransactionAmount = "1200"; retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^170410054321000000000000000 150 A"; retail.Card.EntryDataSource = EntryDataSources.edsTrack1; retail.AuthOnly(); string aggregate = retail.GetDetailAggregate(); //Capture retail = new Fdmsrcretail(); 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"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.STAN = "113"; retail.TransactionNumber = "1235"; retail.ReferenceNumber = "123457"; retail.SetDetailAggregate(aggregate); //The TransactionAmount is populated when SetDetailAggregate is called. //TransactionAmount may be set to a different amount when capturing, //for instance to include Gratuity. retail.TransactionAmount = "1600"; retail.Capture();

Config Method (FDMSRcRetail Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Credit Method (FDMSRcRetail Component)

Submits a credit transaction.

Syntax

• C#
• VB.NET

public void Credit();

Public Sub Credit()

Remarks

This method credits funds to the card. This is not based on a previous transaction. This may be used to return funds to a card if a previous transaction has already been settled. To void or cancel a transaction before it has been settled call Reverse instead.

After this method returns check the value of Code to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Retail Credit Example 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"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.ReferenceNumber = "123"; retail.TransactionAmount = "1200"; retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^170410054321000000000000000 150 A"; retail.Card.EntryDataSource = EntryDataSources.edsTrack1; retail.Credit(); ;

GetDetailAggregate Method (FDMSRcRetail Component)

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

Syntax

• C#
• VB.NET

public string GetDetailAggregate();

Public Function GetDetailAggregate() As String

Remarks

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

When using Terminal Capture Settlement Mode this aggregate must be passed to the FDMSRcSettle component's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSRcDetailrecord component to do so.

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

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

HostTotals Method (FDMSRcRetail Component)

Performs a Host Totals request.

Syntax

• C#
• VB.NET

public void HostTotals();

Public Sub HostTotals()

Remarks

This method performs a Host Totals transaction submitted to request a Host Totals Report for a particular day.

You need to set the required merchant password and report type fields using the HostTotalsPassword and HostTotalsType configuration settings, respectively.

Retail HostTotals Example 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"; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.Config("CurrencyCode=840"); retail.Config("HostTotalsType=1"); retail.Config("HostTotalsPassword=111111"); retail.HostTotals();

Interrupt Method (FDMSRcRetail Component)

Interrupts the current action.

Syntax

• C#
• VB.NET

public void Interrupt();

Public Sub Interrupt()

Remarks

This method interrupts any processing that the component is currently executing.

Reset Method (FDMSRcRetail Component)

Clears all properties to their default values.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Reverse Method (FDMSRcRetail Component)

Reverses a transaction.

Syntax

• C#
• VB.NET

public void Reverse();

Public Sub Reverse()

Remarks

This method reverses a transaction that has not been settled.

To void/reverse a Sale or AuthOnly transaction first set ReversalTransactionType to specify the type of original transaction that is being reversed. Next set ReversalType to frtFullReversal and call this method.

If the previous transaction did not receive a response and the state of the transaction is uncertain you may perform a Timeout Reversal. To perform a timeout reversal set ReversalTransactionType to specify the type of original transaction that is being reversed. Next set ReversalType to frtTimeoutReversal and call this method.

Timeout Reversals are applicable to the following transaction types:

• AuthOnly
• Capture
• Credit
• Sale

Full Reversals are applicable to the following transaction types:

• AuthOnly
• Sale

After this method returns check the value of Code to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Retail Sale and Reverse Example 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"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.ReferenceNumber = "123"; retail.TransactionAmount = "1200"; retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^170410054321000000000000000 150 A"; retail.Card.EntryDataSource = EntryDataSources.edsTrack1; retail.Sale(); string aggregate = retail.GetDetailAggregate(); //Reverse retail = new Fdmsrcretail(); 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"; retail.STAN = "113"; retail.TransactionNumber = "1235"; retail.ReferenceNumber = "123457"; retail.SetDetailAggregate(aggregate); retail.Reverse();

Sale Method (FDMSRcRetail Component)

Performs a sale transaction.

Syntax

• C#
• VB.NET

public void Sale();

Public Sub Sale()

Remarks

This method performs a sale transaction. Once a sale is performed no further action is needed, the funds will automatically be captured by FDMS.

After this method returns check the value of Code to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Retail Sale Example 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"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.OrderNumber = "123"; retail.ReferenceNumber = "123"; retail.TransactionAmount = "1200"; retail.Card.MagneticStripe = "B4012000033330026^FDCS TEST CARD /VISA^170410054321000000000000000 150 A"; retail.Card.EntryDataSource = EntryDataSources.edsTrack1; retail.Sale();

SetDetailAggregate Method (FDMSRcRetail Component)

Specifies the detail aggregate before calling Capture or Reverse.

Syntax

• C#
• VB.NET

public void SetDetailAggregate(string aggregate);

Public Sub SetDetailAggregate(ByVal aggregate As String)

Remarks

This method specifies the detail aggregate from the original AuthOnly or Sale transaction. This must be set before calling Capture or Reverse.

The aggregate specified here should have been obtained from the GetDetailAggregate method after the original AuthOnly or Sale transaction.

VerifyCard Method (FDMSRcRetail Component)

Performs a zero dollar verification of the card.

Syntax

• C#
• VB.NET

public void VerifyCard();

Public Sub VerifyCard()

Remarks

This method performs a card verification without charging any funds. This can be used to simply verify if the card is valid, or perform AVS and CVV checks without actually charging any funds to the card.

When calling this method TransactionAmount must be set to 0. Set either CustomerAddress or CustomerZip to perform AVS checks. Set CVVData to perform CVV checks.

The following combinations are supported:

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Retail VerifyCard Example retail.TPPID = "AAA000"; retail.MerchantTerminalNumber = "00000001"; retail.MerchantId = "1234"; retail.GroupId = "20001"; retail.DatawireId = "00011122233344455566"; retail.ApplicationId = "RAPIDCONNECTVXN"; retail.URL = "https://stg.dw.us.fdcnet.biz/rc"; retail.IndustryType = FdmsrcretailIndustryTypes.fritRetail; retail.URL = "https://stg.dw.us.fdcnet.biz/rc"; retail.STAN = "112"; retail.TransactionNumber = "1234"; retail.ReferenceNumber = "123"; retail.TransactionAmount = "0"; retail.CustomerZip = "11747"; //Card data can be swiped or manually keyed retail.Card.Number = "373953123443227"; retail.Card.ExpMonth = 12; retail.Card.ExpYear = 2018; retail.Card.EntryDataSource = EntryDataSources.edsManualEntryTrack1Capable; retail.VerifyCard();

Connected Event (FDMSRcRetail Component)

This event is fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, FdmsrcretailConnectedEventArgs e);

public class FdmsrcretailConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As FdmsrcretailConnectedEventArgs)

Public Class FdmsrcretailConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSRcRetail Component)

Fired when receiving a data packet from the transaction server.

Syntax

• C#
• VB.NET

public event OnDataPacketInHandler OnDataPacketIn;

public delegate void OnDataPacketInHandler(object sender, FdmsrcretailDataPacketInEventArgs e);

public class FdmsrcretailDataPacketInEventArgs : EventArgs {
  public string DataPacket { get; }
  public byte[] DataPacketB { get; }
}

Public Event OnDataPacketIn As OnDataPacketInHandler

Public Delegate Sub OnDataPacketInHandler(sender As Object, e As FdmsrcretailDataPacketInEventArgs)

Public Class FdmsrcretailDataPacketInEventArgs Inherits EventArgs
  Public ReadOnly Property DataPacket As String
  Public ReadOnly Property DataPacketB As Byte()
End Class

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this component.

DataPacketOut Event (FDMSRcRetail Component)

Fired when sending a data packet to the transaction server.

Syntax

• C#
• VB.NET

public event OnDataPacketOutHandler OnDataPacketOut;

public delegate void OnDataPacketOutHandler(object sender, FdmsrcretailDataPacketOutEventArgs e);

public class FdmsrcretailDataPacketOutEventArgs : EventArgs {
  public string DataPacket { get; }
  public byte[] DataPacketB { get; }
}

Public Event OnDataPacketOut As OnDataPacketOutHandler

Public Delegate Sub OnDataPacketOutHandler(sender As Object, e As FdmsrcretailDataPacketOutEventArgs)

Public Class FdmsrcretailDataPacketOutEventArgs Inherits EventArgs
  Public ReadOnly Property DataPacket As String
  Public ReadOnly Property DataPacketB As Byte()
End Class

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this component.

Disconnected Event (FDMSRcRetail Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, FdmsrcretailDisconnectedEventArgs e);

public class FdmsrcretailDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As FdmsrcretailDisconnectedEventArgs)

Public Class FdmsrcretailDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (FDMSRcRetail Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class FdmsrcretailErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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.

SSLServerAuthentication Event (FDMSRcRetail Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, FdmsrcretailSSLServerAuthenticationEventArgs e);

public class FdmsrcretailSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As FdmsrcretailSSLServerAuthenticationEventArgs)

Public Class FdmsrcretailSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FDMSRcRetail Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, FdmsrcretailSSLStatusEventArgs e);

public class FdmsrcretailSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As FdmsrcretailSSLStatusEventArgs)

Public Class FdmsrcretailSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (FDMSRcRetail Component)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, FdmsrcretailStatusEventArgs e);

public class FdmsrcretailStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As FdmsrcretailStatusEventArgs)

Public Class FdmsrcretailStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the component are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the component will look for MagneticStripe data when authorizing the transaction, and will throws an exception because none is present.

Fields

Constructors

• C#
• VB.NET

public CCCard();

Public CCCard()

• C#
• VB.NET

public CCCard(string number, int expMonth, int expYear);

Public CCCard(ByVal Number As String, ByVal ExpMonth As Integer, ByVal ExpYear As Integer)

• C#
• VB.NET

public CCCard(string magneticStripe, EntryDataSources entryDataSource);

Public CCCard(ByVal MagneticStripe As String, ByVal EntryDataSource As EntryDataSources)

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

FDMSRcBillPay Type

Contains bill payment information.

Remarks

This type contains information used in processing a bill payment.

Fields

Constructors

• C#
• VB.NET

public FDMSRcBillPay();

Public FDMSRcBillPay()

FDMSRcLevel2 Type

Specifies Level 2 (purchasing card) information.

Remarks

This type specifies Level 2 (purchasing card) information.

Fields

Constructors

• C#
• VB.NET

public FDMSRcLevel2();

Public FDMSRcLevel2()

FDMSRcResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the FDMSRcECommerce or FDMSRcRetail component. The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public FDMSRcResponse();

Public FDMSRcResponse()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (FDMSRcRetail Component)

FDMSRcRetail Config Settings

HTTP Config Settings

TCPClient Config Settings