FDMSRcRetail Bean

Properties Methods Events Configuration 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

InPayDirect.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:

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 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 being processing transactions first set the required merchant values. For instance:

retail.IndustryType = FdmsrcretailIndustryTypes.fitRetail;
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.


AuthOnly	An authorization that must be Captured later.
BalanceInquiry	Inquire about available balance.
Capture	Captures a previous AuthOnly transaction for settlement.
Credit	Credits funds to the cardholder. This is not based on a previous transaction.
Reverse	Reverse a previous transaction. This is also used for timeout reversals.
Sale	A basic sale, no other steps are required to complete the payment.
VerifyCard	Verifies that a card is valid.

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

Visa

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

MasterCard

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 bean with short descriptions. Click on the links for further details.


ApplicationId	Identifies the merchant application to the Datawire System.
Card	Contains the customer's credit card information.
CashBack	Optional cash back amount to return to the customer.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
DatawireId	Identifies the merchant to the Datawire System.
EMVData	The EMV Data returned from a Pin Pad after reading an EMV card.
GroupId	The Id assigned by FDMS to identify the merchant or group of merchants.
IndustryType	The merchant's industry type.
Level2	Specifies Level 2 (purchasing card information).
MerchantId	A unique Id used to identify the merchant within the FDMS and Datawire systems.
MerchantTerminalNumber	Used to identify a unique terminal within a merchant location.
OrderNumber	A merchant assigned order number to uniquely reference the transaction.
Proxy	A set of properties related to proxy access.
ReferenceNumber	A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.
Response	Contains the response to an authorization request.
ReversalTransactionType	The type of transaction to reverse.
ReversalType	The type of reversal.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
STAN	The merchant assigned System Trace Audit Number(STAN).
Timeout	A timeout for the component.
TPPID	Third Party Processor Identifier assigned by FDMS.
TransactionAmount	The transaction amount to be authorized.
TransactionNumber	Uniquely identifies the transaction.
URL	Location of the Datawire server to which transactions are sent.
VisaIdentifier	Additional merchant identification field used when authorizing Visa transactions.

Method List

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


authOnly	Performs an authorization request.
balanceInquiry	Performs a Balance Inquiry Request using the specified Card data.
capture	Captures a previously authorized transaction.
config	Sets or retrieves a configuration setting .
credit	Submits a credit transaction.
getDetailAggregate	Returns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions.
interrupt	Interrupts the current action.
reset	Clears all properties to their default values.
reverse	Reverses a transaction.
sale	Performs a sale transaction.
setDetailAggregate	Specifies the detail aggregate before calling Capture or Reverse.
verifyCard	Performs a zero dollar verification of the card.

Event List

The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
DataPacketIn	Fired when receiving a data packet from the transaction server.
DataPacketOut	Fired when sending a data packet to the transaction server.
Disconnected	Fired when a connection is closed.
Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Status	Shows the progress of the FDMS/Datawire connection.

Configuration Settings

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


ClientTimeout	Indicates timeout client application will wait for response.
CurrencyCode	Currency Code for this transaction.
DebugTrace	Whether to enable debug logging.
AllowPartialAuths	Indicates whether partial authorizations are supported.
AltMerchantAddress	The alternative merchant address.
AltMerchantCity	The alternative merchant city.
AltMerchantCountryCode	The alternative merchant country code.
AltMerchantName	The alternative merchant name.
AltMerchantState	The alternative merchant state.
AltMerchantZip	The alternative merchant zip code.
AuthSource	Indicates the source of the decision for the Visa transaction.
BillPaymentType	Specifies the type of Bill Payment being made.
CardInputMode	The method used to input the card details.
CardType	Specifies the type of card.
DeviceTypeIndicator	Defines the form factor used at the POS for MasterCard PayPass transactions.
LocalTransactionDate	The local date of the transaction.
UTCTransactionDate	The UTC date of the transaction.
MerchantCategoryCode	The 4 digit Merchant Category Code (MCC).
POSConditionCode	The POS condition code.
POSId	Identifies the specific point of sale device.
TerminalCardCapability	The terminal's card capture capability.
TerminalEntryCapability	The terminal's entry mode capability.
TerminalPinCapability	The terminal's PIN capability.
TerminalTaxCapability	The terminal's ability to prompt for tax.
VoiceApprovalCode	The voice approval.
TransArmorTokenType	The FDMS assigned token type.
TransArmorMode	Specifies the TransArmor Security Level to use.
UpdateTransArmorKey	Allows you to update your TransArmor Key.
TransArmorKey	Specifies the TransArmor key used to perform the encryption.
TransArmorKeyId	Specifies the Id of the TransArmor key used to perform the encryption.
TransArmorToken	A TransArmor Token used in place of a card number or magnetic stripe data.
TransArmorProviderId	The Id of the Provider that issued a TransArmorToken.
TransArmorUpdateIndicator	Indicates whether your TransArmorKey needs to be updated.
GetTransArmorToken	Allows you to retrieve a TransArmor Token for a specified card.
EMVOnlinePIN	DUKPT DES encrypted PIN block for EMV Online PIN transactions.
EMVOnlineKSN	Clear-text Key Sequence Number for EMV Online PIN transactions.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.