FDMSSettle Control

Properties   Methods   Events   Config Settings   Errors  

The FDMSSettle control is used to do a Batch Settlement on all transactions that were successfully authorized with the FDMSECOMMERCE or FDMSRETAIL controls. This control 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 = fitDirectMarketing 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 fttVoid. 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.

Property List

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

Method List

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

Event List

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

Config Settings

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

ApiVersion Property (FDMSSettle Control)

Identifies the application version number.

Syntax

fdmssettlecontrol.ApiVersion[=string]

Default Value

"016XX0"

Remarks

The ApiVersion includes the application's version number and revision number. This field should be 6 characters long and it cannot contain periods or spaces.

The default value of this property is "016XX0" indicating the current version number of 4D Payments SDK.

Data Type

String

ApplicationId Property (FDMSSettle Control)

Identifies the merchant application to the Datawire System.

Syntax

fdmssettlecontrol.ApplicationId[=string]

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this control.

Data Type

String

BatchSequenceNumber Property (FDMSSettle Control)

Starting sequence number for the transactions in this batch.

Syntax

fdmssettlecontrol.BatchSequenceNumber[=string]

Default Value

""

Remarks

A batch settlement is made up of many separate transaction packets. The control creates these packets and posts them one-by-one to the Datawire VXN, where they are then routed to the FDMS payment processor. Each of these packets sent to Datawire must contain a unique 7 digit transaction sequence identifier. This property should contain the beginning sequence number, which the control will increment for each individual data payload sent in the batch settlement. The component will pad the entered value with trailing zeros as needed and restart at 0 when the maximum transaction sequence identifier is reached.

To retrieve the last transaction sequence identifier used by the component in the batch settlement you need to read the value of BatchSequenceNumber after SendSettlement method is called. ... FDMSSettle.BatchSequenceNumber = "1234"; FDMSSettle.DetailRecords.Add(new FDMSRecordType(FDMSEcommerce.GetDetailAggregate())); FDMSSettle.SendSettlement(); // retrieve the last transaction sequence identifier used in batch settlement // increment it and use in the consecutive transaction to First Data String lastUsedTranNum = FDMSSettle.BatchSequenceNumber; 'this returns the last transaction sequence identifier used in batch settlement.

Data Type

String

DatawireId Property (FDMSSettle Control)

Identifies the merchant to the Datawire System.

Syntax

fdmssettlecontrol.DatawireId[=string]

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister control). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Data Type

String

DetailRecordCount Property (FDMSSettle Control)

The number of records in the DetailRecord arrays.

Syntax

fdmssettlecontrol.DetailRecordCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• DetailRecordAddendum
• DetailRecordAggregate

The array indices start at 0 and end at DetailRecordCount - 1.

This property is not available at design time.

Data Type

Integer

DetailRecordAddendum Property (FDMSSettle Control)

Optional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the FDMSECOMMERCE , FDMSRETAIL , or FDMSDETAILRECORD control's GetDetailAggregate method.

Syntax

fdmssettlecontrol.DetailRecordAddendum(DetailRecordIndex)[=string]

Default Value

""

Remarks

Optional Detail Record Addendum data (such as Level2 or Level3 data)

The DetailRecordDetailAggregate property contains an xml aggregate of the transaction retrieved from the FDMSECommerce, FDMSRetail, or FDMSDetailRecord control's GetDetailAggregate method. If you wish to accept corporate purchasing cards you will also need to send Level2, and possibly Level3 addendum data along with the DetailRecordDetailAggregate. The DetailRecordAddendumAggregate property takes an xml aggregate containing either Level2 or Level2 plus Level3 addendum data, which will be added to the DetailRecordDetailAggregate when sending the settlement. The DetailRecordAddendumAggregate may be created with either the FDMSLevel2 or FDMSLevel3 controls, and then returned via those control's GetAddendum method.

For example:

'First, authorize the credit card FDMSECommerce.TransactionAmount = "2720" '$27.20 FDMSECommerce.Authorize() 'Then, put the result into the settlement component FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() 'Then build the Level 2 portion FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "230928" 'September 28th, 2023 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" '$6.00 FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" '$1.20 'Now build the Level 3 portion FDMSLevel3.CardType = fctVisa FDMSLevel3.LineItemCount = 2 FDMSLevel3.ItemCommodityCode(0) = "4900" ' Books and printed materials FDMSLevel3.ItemDescription(0) = "Reference manual" FDMSLevel3.ItemDiscountAmount(0) = "" ' No discount FDMSLevel3.ItemProductCode(0) = "ISBN123456" FDMSLevel3.ItemTaxAmount(0) = "60" '$0.60 FDMSLevel3.ItemTaxRate(0) = "600" '6.00 percent FDMSLevel3.ItemQuantity(0) = "2" FDMSLevel3.ItemUnitCost(0) = "500" '$5.00 FDMSLevel3.ItemTotal(0) = "1060" '$10.60 FDMSLevel3.ItemUnits(0) = "each" FDMSLevel3.ItemCommodityCode(1) = "4900" ' Books and printed materials FDMSLevel3.ItemDescription(1) = "Quick Start manual" FDMSLevel3.ItemDiscountAmount(1) = "" ' No discount FDMSLevel3.ItemProductCode(1) = "ISBN654321" FDMSLevel3.ItemTaxAmount(1) = "60" '$0.60 FDMSLevel3.ItemTaxRate(1) = "600" '6.00 percent FDMSLevel3.ItemQuantity(1) = "1" FDMSLevel3.ItemUnitCost(1) = "1000" '$10.00 FDMSLevel3.ItemTotal(1) = "1060" '$10.60 FDMSLevel3.ItemUnits(1) = "each" 'Finally, add the Level 2 and Level 3 addendum data to the settlement at the same index 'as the associated transaction. FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum() & FDMSLevel3.GetAddendum()

Note that you may mix corporate and non-corporate card transactions in the same settlement. It is not necessary that all DetailRecordDetailAggregates have a corresponding DetailRecordAddendumAggregate.

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

DetailRecordAggregate Property (FDMSSettle Control)

Set this property with xml aggregates of the transactions you wish to settle.

Syntax

fdmssettlecontrol.DetailRecordAggregate(DetailRecordIndex)[=string]

Default Value

""

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the FDMSECommerce, FDMSRetail, or FDMSDetailRecord control's GetDetailAggregate method. For instance:

FDMSSettle.DetailRecords.Add(new FDMSRecordtype(FDMSRetail1.GetDetailAggregate()));

On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the FDMSDetailRecord control.

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

To settle a transaction authorized with the dmtInstallment TransactionType, you must use the FDMSDetailRecord control to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

FDMSPlatform Property (FDMSSettle Control)

Specifies the FDMS platform that the transactions will be processed on.

Syntax

fdmssettlecontrol.FDMSPlatform[=integer]

Possible Values

fpNorth(0), 
fpNashville(1)

Default Value

0

Remarks

This property is used to identify the FDMS platform that the transactions will be sent to and processed on. The following table lists the platforms supported by this control.

Data Type

Integer

IndustryType Property (FDMSSettle Control)

Code which indicates the industry the merchant is engaged in.

Syntax

fdmssettlecontrol.IndustryType[=integer]

Possible Values

fitUnknown(0), 
fitRetail(1), 
fitRestaurant(2), 
fitGroceryStore(3), 
fitDirectMarketing(4), 
fitHotel(5)

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this control.

Data Type

Integer

MerchantNumber Property (FDMSSettle Control)

A unique number used to identify the merchant within the FDMS and Datawire systems.

Syntax

fdmssettlecontrol.MerchantNumber[=string]

Default Value

""

Remarks

This property contains a unique number (typically 12 digits) which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS and Datawire systems, and is used along with the MerchantTerminalNumber and DatawireId as connection credentials.

Data Type

String

MerchantServiceNumber Property (FDMSSettle Control)

Merchant's customer service phone number.

Syntax

fdmssettlecontrol.MerchantServiceNumber[=string]

Default Value

""

Remarks

This 10 character field contains the merchant customer service phone number without dashes or spaces. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "8001234567" is acceptable, while "18001234567" or "1-800-123-4567" is not.

This property is only required when the IndustryType is set to fitDirectMarketing, and will otherwise not be sent.

Data Type

String

MerchantTerminalNumber Property (FDMSSettle Control)

Used to identify a unique terminal within a merchant location.

Syntax

fdmssettlecontrol.MerchantTerminalNumber[=string]

Default Value

""

Remarks

This property contains a number (typically 6 digits) assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber and DatawireId as connection credentials.

Data Type

String

ProxyAuthScheme Property (FDMSSettle Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

fdmssettlecontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FDMSSettle Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

fdmssettlecontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (FDMSSettle Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

fdmssettlecontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FDMSSettle Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fdmssettlecontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FDMSSettle Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fdmssettlecontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FDMSSettle Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fdmssettlecontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FDMSSettle Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

fdmssettlecontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseBatchNumber Property (FDMSSettle Control)

FDMS-generated Id of the batch settlement.

Syntax

fdmssettlecontrol.ResponseBatchNumber

Default Value

"0"

Remarks

FDMS-generated Id of the batch settlement.

This property is filled after a successful batch settlement, and contains a unique number which identifies the settlement with the FDMS processor. This number should be logged in case you have any questions about the settlement in the future.

This property is read-only.

Data Type

String

ResponseBatchStatus Property (FDMSSettle Control)

Indicates success or failure of the entire settlement.

Syntax

fdmssettlecontrol.ResponseBatchStatus

Default Value

""

Remarks

Indicates success or failure of the entire settlement.

This property will be filled after calling the SendSettlement method. If it contains "OK", the batch settlement has succeeded. If it contains any other data, an error will be generated by the control. Possible responses include:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSSettle Control)

Contains an error code providing more details about the DatawireStatus received.

Syntax

fdmssettlecontrol.ResponseDatawireReturnCode

Default Value

""

Remarks

Contains an error code providing more details about the ResponseDatawireStatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contain the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (FDMSSettle Control)

Status of the communication with Datawire.

Syntax

fdmssettlecontrol.ResponseDatawireStatus

Default Value

""

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (FDMSSettle Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmssettlecontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FDMSSettle Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmssettlecontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FDMSSettle Control)

This is the name of the certificate store for the client certificate.

Syntax

fdmssettlecontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (FDMSSettle Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fdmssettlecontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FDMSSettle Control)

This is the type of certificate store for this certificate.

Syntax

fdmssettlecontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FDMSSettle Control)

This is the subject of the certificate used for client authentication.

Syntax

fdmssettlecontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (FDMSSettle Control)

This specifies the SSL/TLS implementation to use.

Syntax

fdmssettlecontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (FDMSSettle Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmssettlecontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (FDMSSettle Control)

A timeout for the control.

Syntax

fdmssettlecontrol.Timeout[=integer]

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the control will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

URL Property (FDMSSettle Control)

Location of the Datawire server to which transactions are sent.

Syntax

fdmssettlecontrol.URL[=string]

Default Value

"https://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister control. Once you Register and Activate the merchant using the FDMSRegister control, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister control.

Data Type

String

Config Method (FDMSSettle Control)

Sets or retrieves a configuration setting.

Syntax

fdmssettlecontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Interrupt Method (FDMSSettle Control)

Interrupts the current action.

Syntax

fdmssettlecontrol.Interrupt 

Remarks

This method interrupts any processing that the control is currently executing.

Reset Method (FDMSSettle Control)

Clears all properties to their default values.

Syntax

fdmssettlecontrol.Reset 

Remarks

This method clears all properties to their default values.

SendSettlement Method (FDMSSettle Control)

Begins a Batch Settlement transaction with the transaction server.

Syntax

fdmssettlecontrol.SendSettlement 

Remarks

This begins a Batch Settlement transaction. The control begins a session with the Datawire system, and then posts a header record, all the detail records, all the Level 2 and Level 3 addendum records (if any), and a trailer record in sequence. The session is then automatically terminated, and the ResponseBatchStatus property will indicate the result of the settlement as returned by the FDMS processor.

Connected Event (FDMSSettle Control)

This event is fired immediately after a connection completes (or fails).

Syntax

Sub fdmssettlecontrol_Connected(StatusCode As Integer, Description As String)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSSettle Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub fdmssettlecontrol_DataPacketIn(DataPacket As String)

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this control.

DataPacketOut Event (FDMSSettle Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub fdmssettlecontrol_DataPacketOut(DataPacket As String)

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this control.

Disconnected Event (FDMSSettle Control)

This event is fired when a connection is closed.

Syntax

Sub fdmssettlecontrol_Disconnected(StatusCode As Integer, Description As String)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (FDMSSettle Control)

Fired when information is available about errors during data delivery.

Syntax

Sub fdmssettlecontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (FDMSSettle Control)

Fired after the server presents its certificate to the client.

Syntax

Sub fdmssettlecontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FDMSSettle Control)

Fired when secure connection progress messages are available.

Syntax

Sub fdmssettlecontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (FDMSSettle Control)

Shows the progress of the FDMS/Datawire connection.

Syntax

Sub fdmssettlecontrol_Status(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (FDMSSettle Control)

FDMSSettle Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSSettle Control)

FDMSSettle Errors

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors