FDMSSettle Control

Properties   Methods   Events   Configuration Settings   Errors  

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.

Syntax

FDMSSettle

Remarks

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

The FDMSSettle control is used to settle all transactions previously authorized by the FDMSECommerce or FDMSRetail control. 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 control 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 control 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 control 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 control 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 control.
  FDMSSettle.URL = "https://staging1.datawire.net/sd/"         'Retrieved with the FDMSRegister control.

Additionally, set the IndustryType and the BatchSequenceNumber.

  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 DetailRecordAggregate array property. First set the DetailRecordCount to the total number of transactions you wish to settle. Each index in the DetailRecordAggregate array property must be set with the XML aggregate returned from the FDMSRetail, FDMSECommerce, or FDMSDetailRecord control's GetDetailAggregate method.

  FDMSSettle.DetailRecordCount = 1
  FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate()

Finally, call the SendSettlement method.

  FDMSSettle.SendSettlement()

If the settlement is successful, the ResponseBatchStatus will contain "OK" and the ResponseBatchNumber will contain a number which can be used to identify the batch in the future. If the batch was not successful the control fails with an error 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 DetailRecordAggregate 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 control to modify the transaction aggregate and set the TransactionType property to ttVoid. Credits and forced transactions may also be created using the FDMSDetailRecord control 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 controls to create addendum aggregates, and then add them to the DetailRecordAddendum for the corresponding transaction stored in DetailRecordAggregate.

Note that the IndustryType from the FDMSSettle control 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.