The FDMSSettle component is used to do a Batch Settlement on all transactions that were successfully authorized with the FDMSECOMMERCE or FDMSRETAIL components. This component may also send Level 2 and Level 3 Corporate Purchasing Card data for better interchange rates.
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 FDMSSettle component is used to settle all transactions previously authorized by the FDMSECommerce or FDMSRetail component. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the FDMSSettle component the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.
Sending a Batch Settlement with this component is easy. First, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSRegister component to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.
To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId 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 Service Discovery.
FDMSSettle.MerchantNumber = "000000999990"; 'Supplied by FDMS/Datawire FDMSSettle.MerchantTerminalNumber = "555555"; 'Supplied by FDMS/Datawire FDMSSettle.DatawireId = "0000B47FFFFFFFFFFFFF"; 'Retrieved with the FDMSRegister component. FDMSSettle.URL = "https://staging1.datawire.net/sd/"; 'Retrieved with the FDMSRegister component.
FDMSSettle.IndustryType = itDirectMarketing FDMSSettle.BatchSequenceNumber = "4127"
At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailRecords collection;. The XML aggregates for transactions are returned from the FDMSRetail, FDMSECommerce, or FDMSDetailRecord component's GetDetailAggregate method.
Finally, call the SendSettlement method.
If the settlement is successful, the BatchStatus will contain "OK" and the BatchNumber will contain a number which can be used to identify the batch in the future. If the batch was not successful the component throws an exception that indicates the problem. If any individual record in the batch fails, information concerning that record will appear in the Error event when the response to that particular record is received.
Up to 1000 detail records may be settled in the above manner, just by adding transactions to the DetailRecords property. However, it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.
To void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. If you wish to explicitly void the transaction, use the FDMSDetailRecord component to modify the transaction aggregate and set the TransactionType property to ttVoid. Credits and forced transactions may also be created using the FDMSDetailRecord component and settled in the same manner as regular transactions.
To add Level 2 and Level 3 data to the settled transactions, use the FDMSLevel2 and FDMSLevel3 components to create addendum aggregates, and then add them to the AddendumAggregate for the corresponding transaction stored in DetailAggregate.
Note that the IndustryType from the FDMSSettle component MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|ApiVersion||Identifies the application version number.|
|ApplicationId||Identifies the merchant application to the Datawire System.|
|BatchSequenceNumber||Starting sequence number for the transactions in this batch.|
|DatawireId||Identifies the merchant to the Datawire System.|
|DetailRecords||Collection of detail records to send in the settlement.|
|FDMSPlatform||Specifies the FDMS platform that the transactions will be processed on.|
|IndustryType||Code which indicates the industry the merchant is engaged in.|
|MerchantNumber||A unique number used to identify the merchant within the FDMS and Datawire systems.|
|MerchantServiceNumber||Merchant's customer service phone number.|
|MerchantTerminalNumber||Used to identify a unique terminal within a merchant location.|
|Proxy||A set of properties related to proxy access.|
|Response||Contains the response to the settlement.|
|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.|
|Timeout||A timeout for the component.|
|URL||Location of the Datawire server to which transactions are sent.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting .|
|Interrupt||Interrupts the current action.|
|Reset||Clears all properties to their default values.|
|SendSettlement||Begins a Batch Settlement transaction with the transaction server.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|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.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|ClientTimeout||Indicates timeout client application will wait for response.|
|UseEnhancedSettlement||Forces enhanced settlement mode.|
|DetailErrorIndex||Contains the detail record number that caused the error during settlement.|
|RawRequest||Returns the request sent to the server for debugging purposes.|
|RawResponse||Returns the response received from the server for debugging purposes.|
|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).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|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 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.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|LogSSLPackets||Controls whether SSL packets are logged when using the internal security API.|
|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.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|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.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|UseBackgroundThread||Whether threads created by the component are background threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|