Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

FDMSRcECommerce Class

Properties   Methods   Events   Configuration Settings   Errors  

The FDMSRcECommerce component is an advanced tool used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This component makes authorizing these types of transactions very easy.

Class Name

InPayDirect_FDMSRcECommerce

Procedural Interface

 inpaydirect_fdmsrcecommerce_open();
 inpaydirect_fdmsrcecommerce_close($res);
 inpaydirect_fdmsrcecommerce_register_callback($res, $id, $function);
 inpaydirect_fdmsrcecommerce_get_last_error($res);
 inpaydirect_fdmsrcecommerce_get_last_error_code($res);
 inpaydirect_fdmsrcecommerce_set($res, $id, $index, $value);
 inpaydirect_fdmsrcecommerce_get($res, $id, $index);
 inpaydirect_fdmsrcecommerce_do_authonly($res);
 inpaydirect_fdmsrcecommerce_do_capture($res);
 inpaydirect_fdmsrcecommerce_do_config($res, $configurationstring);
 inpaydirect_fdmsrcecommerce_do_credit($res);
 inpaydirect_fdmsrcecommerce_do_getdetailaggregate($res);
 inpaydirect_fdmsrcecommerce_do_interrupt($res);
 inpaydirect_fdmsrcecommerce_do_reset($res);
 inpaydirect_fdmsrcecommerce_do_reverse($res);
 inpaydirect_fdmsrcecommerce_do_sale($res);
 inpaydirect_fdmsrcecommerce_do_setdetailaggregate($res, $aggregate);
 inpaydirect_fdmsrcecommerce_do_verifycard($res);

Remarks

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

The FDMSRcECommerce class makes authorizing Card-Not-Present Mail Order and E-Commerce transactions 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 class 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 class 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 class 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:

fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.fitEcommerce;
fdmsrcecommerce.TPPID = "AAA000";
fdmsrcecommerce.MerchantTerminalNumber = "00000001";
fdmsrcecommerce.MerchantId = "1234";
fdmsrcecommerce.GroupId = "20001";
fdmsrcecommerce.DatawireId = "00011122233344455566";
fdmsrcecommerce.MerchantURL = "mywebsite"; //Required for ECommerce transactions
fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN";
fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc";

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

fdmsrcecommerce.STAN = "112";
fdmsrcecommerce.TransactionNumber = "120013";
fdmsrcecommerce.OrderNumber = "12000503";
fdmsrcecommerce.ReferenceNumber = "123";
Then specify customer card and address information along with the transaction amount:
fdmsrcecommerce.Card.Number = "36185900055556";
fdmsrcecommerce.Card.ExpMonth = 4;
fdmsrcecommerce.Card.ExpYear = 2016;
fdmsrcecommerce.Card.CVVData = "123";

fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road";
fdmsrcecommerce.CustomerZip = "11747";

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

Finally, submit the transaction by calling the Sale method.


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


fdmsrcecommerce.AuthOnly();

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

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

//Capture
fdmsrcecommerce = new Fdmsrcecommerce();
...

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

fdmsrcecommerce.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 classs. 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.

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

Visa MasterCard

Property List


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

ApplicationIdIdentifies the merchant application to the Datawire System.
CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
DatawireIdIdentifies the merchant to the Datawire System.
GroupIdThe Id assigned by FDMS to identify the merchant or group of merchants.
IndustryTypeThe merchant's industry type.
Level2CustomerReferenceNumberThe reference number or order number to be reported as part of the Purchase Card data.
Level2DestinationCountryCodeThis property represents the country code of the location the items in this purchase are being delivered to.
Level2DestinationPostalCodeThis property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.
Level2DiscountAmountThis property contains the discount amount for the purchase.
Level2DutyAmountThis property contains the duty amount for this purchase.
Level2FreightAmountThis property contains the amount for freight included in this purchase.
Level2MerchantTaxIdThis property should contain the Tax Id collected by the merchant for this transaction.
Level2ProductDescriptionThis property should contain a description of an item purchased with this card.
Level2PurchaseIdentifierThis property represents the data used by the merchant or customer to identify the purchase.
Level2ShipFromPostalCodeThe postal or zip code the item(s) in this purchase are to be shipped from.
Level2TaxAmountThis property contains the portion of the transaction amount that represents the tax.
Level2TaxIndicatorThis property indicates the taxable status of the transaction.
MerchantIdA unique Id used to identify the merchant within the FDMS and Datawire systems.
MerchantServicePhoneThe merchant's phone number, used to assist cardholders.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
MerchantURLThe URL of the site performing the ECommerce transaction.
OrderNumberA merchant assigned order number to uniquely reference the transaction.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
ReferenceNumberA value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.
ResponseApprovalCodeThe Approval Code returned from the server after a successful authorization.
ResponseAuthorizedAmountThe amount actually charged to the card.
ResponseAuthorizingNetworkIdThis property indicates the network Id as returned by the host, if available.
ResponseAuthorizingNetworkNameThis property indicates the authorizing network name as returned by the host, when available.
ResponseAVSResultContains the Address Verification System result code.
ResponseBalanceContains the remaining available balance left on the card.
ResponseCardLevelResultThis property is only applicable to Visa card.
ResponseCodeContains the 3 digit response code indicating success or reason of failure.
ResponseCommercialCardIndicates whether the credit card charged is a corporate commercial card.
ResponseCVVResultContains the returned CVV result code (if CVV data was sent in the request).
ResponseDatawireReturnCodeContains an error code providing more details about the DatawireStatus received.
ResponseDatawireStatusStatus of the communication with Datawire.
ResponsePOSDataThis property holds transaction specific information returned by the issuer (if any).
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseRoutingIndicatorIndicates whether the transaction was processed as Credit or Debit.
ResponseSettlementDateThe date the transaction will be settled in the format MMDD.
ResponseTextThis property may hold additional text which describes the reason for a decline, the property in error, etc.
ResponseTransactionDateThe transaction date returned from the server in yyyyMMddHHmmss format.
ResponseTransactionIdCard issuer's Transaction Reference Number.
ReversalTransactionTypeThe type of transaction to reverse.
ReversalTypeThe type of reversal.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
STANThe merchant assigned System Trace Audit Number(STAN).
TimeoutA timeout for the component.
TPPIDThird Party Processor Identifier assigned by FDMS.
TransactionAmountThe transaction amount to be authorized.
TransactionNumberUniquely identifies the transaction.
URLLocation of the Datawire server to which transactions are sent.
VisaIdentifierAdditional merchant identification field used when authorizing Visa transactions.

Method List


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

AuthOnlyPerforms an authorization request.
CaptureCaptures a previously authorized transaction.
ConfigSets or retrieves a configuration setting .
CreditSubmits a credit transaction.
GetDetailAggregateReturns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
ReverseReverses a transaction.
SalePerforms a sale transaction.
SetDetailAggregateSpecifies the detail aggregate before calling Capture or Reverse.
VerifyCardPerforms a zero dollar verification of the card.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the FDMS/Datawire connection.

Configuration Settings


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

ClientTimeoutIndicates timeout client application will wait for response.
CurrencyCodeCurrency Code for this transaction.
DebugTraceWhether to enable debug logging.
AllowPartialAuthsIndicates whether partial authorizations are supported.
AltMerchantAddressThe alternative merchant address.
AltMerchantCityThe alternative merchant city.
AltMerchantCountryCodeThe alternative merchant country code.
AltMerchantNameThe alternative merchant name.
AltMerchantStateThe alternative merchant state.
AltMerchantZipThe alternative merchant zip code.
AuthSourceIndicates the source of the decision for the Visa transaction.
BillPaymentTypeSpecifies the type of Bill Payment being made.
CardInputModeThe method used to input the card details.
CardTypeSpecifies the type of card.
DeviceTypeIndicatorDefines the form factor used at the POS for MasterCard PayPass transactions.
LocalTransactionDateThe local date of the transaction.
UTCTransactionDateThe UTC date of the transaction.
MerchantCategoryCodeThe 4 digit Merchant Category Code (MCC).
POSConditionCodeThe POS condition code.
POSIdIdentifies the specific point of sale device.
TerminalCardCapabilityThe terminal's card capture capability.
TerminalEntryCapabilityThe terminal's entry mode capability.
TerminalPinCapabilityThe terminal's PIN capability.
TerminalTaxCapabilityThe terminal's ability to prompt for tax.
VoiceApprovalCodeThe voice approval.
TransArmorTokenTypeThe FDMS assigned token type.
TransArmorModeSpecifies the TransArmor Security Level to use.
UpdateTransArmorKeyAllows you to update your TransArmor Key.
TransArmorKeySpecifies the TransArmor key used to perform the encryption.
TransArmorKeyIdSpecifies the Id of the TransArmor key used to perform the encryption.
TransArmorTokenA TransArmor Token used in place of a card number or magnetic stripe data.
TransArmorProviderIdThe Id of the Provider that issued a TransArmorToken.
TransArmorUpdateIndicatorIndicates whether your TransArmorKey needs to be updated.
GetTransArmorTokenAllows you to retrieve a TransArmor Token for a specified card.
ECIIdentifies the security level of the ECommerce transaction.
CAVVThe Visa CAVV or American Express AEVV.
XIDThe 3-D Secure transaction Id for Visa 3D Secure or American Express Safekey.
UCAFCollectIndSpecifies whether the merchant supports MasterCard UCAF (SecureCode) data collection.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0