Search: 
Available in: FDMS
FDMSRegister Component [IBiz FDMS Integrator V1]

Properties   Methods   Events   Configuration Settings  

The FDMSRegister component is an tool used to Register and Activate a merchant account with the Datawire VXN. This allows you to send transactions through the Datawire system to the First Data Merchant Services (FDMS) processor. This component is also used to find the appropriate url's to which authorizations and settlements will be posted.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This component communicates with the Datawire VXN transaction transport network, and allows you to set up your account so that credit card transactions made with the FDMSECOMMERCE, FDMSRETAIL, and FDMSSETTLE components will pass through Datawire and ultimately reach the First Data Merchant Services (FDMS) transaction processor. Before you can charge a single credit card, you must Register and Activate your FDMS account, and then run a ServiceDiscovery to find acceptable URLs, which you will ultimately use to send credit card authorizations.

The first thing you must do is Register your merchant account. First Data Merchant Services will provide you with a MerchantNumber and a MerchantTerminalNumber, which are required for registering with Datawire. In addition, you will need to set the TransactionNumber with a unique value. (The TransactionNumber should be incremented for each transaction you send to the Datawire VXN). The example below also sets the URL to point to the Datawire test server.

   
  FDMSRegister.MerchantNumber = "000000999990"
  FDMSRegister.MerchantTerminalNumber = "555555"
  FDMSRegister.TransactionNumber = "1" 'any unique number will do.
  FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do"
  FDMSRegister.Register()

If the registration was successful, the DatawireResponseStatus will contain "OK", and the DatawireId will contain the new Id which you must save and send with every subsequent transaction. The PrimaryDiscoveryURL and SecondaryDiscoveryURL properties will also be filled after a successful authorization. These urls should be saved for later, and used to perform ServiceDiscovery.

After registering, you must immediately Activate the merchant. If you wait too long, your registration will time out, and you will have to contact Datawire to have them reset your account so that you may register again. When activating the merchant, the same properties are required as for the Register method, with the addition of the DatawireId property. Since the call to Register filled the DatawireId property with the correct value, all we need to do now is:

   
  FDMSRegister.TransactionNumber = 2
  FDMSRegister.Activate()

After registering and activating the account, you may now move on to Service Discovery. The Register method will return both a PrimaryDiscoveryURL and a SecondaryDiscoveryURL. Use these urls with the ServiceDiscovery method to retrieve a list of valid transaction URLs. For instance:

   
  FDMSRegister.ServiceDiscovery("https://staging1.datawire.net/sd")

After a successful ServiceDiscovery the DatawireResponseStatus will be "OK". The ServiceProviderCount will contain the total number of transaction URLs returned, and the URLs will be listed in the ServiceProvider array property. At this time, you should ping each of those URLs to find the URL with the shortest PingResponseTime.

   
  For i = 0 To FDMSRegister.ServiceProviderCount - 1
    FDMSRegister.Ping(FDMSRegister.ServiceProvider[i])
    Debug.Print(FDMSRegister.ServiceProvider[i] & " = " & FDMSRegister.PingResponseTime)
  Next

You may now use the DatawireId and the Service Provider URLs retrieved by this component to submit transactions using the FDMSECOMMERCE, FDMSRETAIL, and FDMSSETTLE components.

Property List


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

DatawireId Identifies the merchant to the Datawire System.
DatawireResponseStatus Status of the communication with Datawire.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
MerchantNumber A unique number used to identify the merchant within the FDMS and Datawire systems.
MerchantTerminalNumber Used to identify a unique terminal within a merchant location.
PingResponseTime Returned after calling the Ping method.
PrimaryDiscoveryURL URL to use with the ServiceDiscovery method to retrieve a list of service provider urls.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
SecondaryDiscoveryURL URL to use with the ServiceDiscovery method to retrieve a list of service provider urls.
ServiceProvider Array containing a list of urls which may be used to send credit card transactions to.
ServiceProviderCount Number of ServiceProvider urls returned by the ServiceDiscovery method.
Timeout A timeout for the component.
TransactionNumber Uniquely identifies the transaction.
URL Location of the Datawire server with which to provision the merchant.

Method List


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

Activate Activates a merchant account on the Datawire VXN.
Config Sets or retrieves a component configuration setting.
Interrupt Interrupts the current action.
Ping Used to find the fastest service provider to use to send credit card transactions.
Register Registers a merchant account on the Datawire VXN.
Reset Clears all properties to their default values.
ServiceDiscovery Retrieves transaction URLs from Datawire.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Connected Fired immediately after a connection completes (or fails).
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 component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
NumRetries Number of times to retry registration.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
RetryInterval Interval in seconds to wait between registration retry attempts.
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
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.