FDMSRcSettle Control

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcSettle control is used to do a Batch Settlement on all transactions that were successfully authorized with the FDMSRcECommerce or FDMSRcRetail controls.

Syntax

FDMSRcSettle

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 FDMSRcSettle control is used to settle all transactions previously authorized by the FDMSRcECommerce or FDMSRcRetail 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 FDMSRcSettle 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 component is easy. First, you must register and activate your account with Datawire. FDMS Rapid Connect will provide you with a MerchantId, MerchantTerminalNumber, and GroupId 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 ServiceDiscovery, you may begin to authorize transactions.

To authorize a credit, debit, ebt, or FSA/HSA card set the TPPID, MerchantId, MerchantTerminalNumber, and GroupId properties with the values supplied by FDMS Rapid Connect. Set the DatawireId property 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 ServiceDiscovery.

 
 Copy
  FDMSRcSettle.TPPID = "AAA000";                        'Supplied by FDMS/Datawire
  FDMSRcSettle.MerchantId = "RCTST0000012345";          'Supplied by FDMS/Datawire
  FDMSRcSettle.MerchantTerminalNumber = "00000001";     'Supplied by FDMS/Datawire
  FDMSRcSettle.GroupId = "20001";                       'Supplied by FDMS/Datawire
  FDMSRcSettle.DatawireId = "00011122233344455566";     'Retrieved with the FDMSRegister control.
  FDMSRcSettle.URL = "https://stg.dw.us.fdcnet.biz/rc"; 'Retrieved with the FDMSRegister control.
  FDMSRcSettle.ApplicationId = "RAPIDCONNECTSRS";
  FDMSRcSettle.Config("UserAgent=MySoftware 1.X.X");

Additionally, set the IndustryType, BatchSequenceNumber, and BatchTicketNumber.

 
 Copy
  FDMSRcSettle.IndustryType = itDirectMarketing;
  FDMSRcSettle.BatchSequenceNumber = "1001";
  FDMSRcSettle.BatchTicketNumber = "4D00015";

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 FDMSRcRetail, FDMSRcECommerce, or FDMSRcDetailrecord control's GetDetailAggregate method.

 
 Copy
  FDMSRcSettle.DetailRecordCount = 1
  FDMSRcSettle.DetailRecordAggregate(0) = FDMSRcECommerce.GetDetailAggregate()

Finally, call the SendSettlement method.

 
 Copy
  FDMSRcSettle.SendSettlement()

If the settlement is successful, the ResponseText will contain "APPROVAL", the ResponseCode will contain "000", and the ResponseBatchId will contain a number (FDMS-generated Id) 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. Refunds and Forced/Voice Approved transactions may also be created using the FDMSRcDetailrecord control and settled in the same manner as regular transactions.

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

ApplicationId Property (FDMSRcSettle Control)

Identifies the merchant application to the Datawire System.

Syntax

fdmsrcsettlecontrol.ApplicationId[=string]

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application Id identifies the application that has generated and is sending the transaction. This is a 15 character alphanumeric code that identifies each application and is provided by the Datawire Secure Transport Vendor Integration Team

This property may be validated along with the DatawireId as connection credentials.

The default value of this property is a value used for testing with Rapid Connect. You may be required to have a new ApplicationId assigned for the software you create with this control.

Data Type

String

BatchSequenceNumber Property (FDMSRcSettle Control)

Starting sequence number for the transactions in this batch.

Syntax

fdmsrcsettlecontrol.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.

 
 Copy
  ...
  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

BatchTicketNumber Property (FDMSRcSettle Control)

The merchant assigned Batch Ticket Number.

Syntax

fdmsrcsettlecontrol.BatchTicketNumber[=string]

Default Value

""

Remarks

This property is used to specify the Batch Ticket Number identifying the Batch that the transactions will be processed in.

The value may be up to 10 alphanumeric characters.

Data Type

String

CloseBatchSTAN Property (FDMSRcSettle Control)

The merchant assigned System Trace Audit Number(STAN) for the Close Batch.

Syntax

fdmsrcsettlecontrol.CloseBatchSTAN[=string]

Default Value

""

Remarks

This property represents a six digit number assigned by the merchant to uniquely reference the transaction. Any request sent to FiServ, such as authorization request, open batch request, close batch request, is considered a transaction and the assigned STAN must be unique accross all those transactions within a given day per Merchant ID and Terminal ID.

Valid values are from 000001 to 999999 inclusive.

Data Type

String

DatawireId Property (FDMSRcSettle Control)

Identifies the merchant to the Datawire System.

Syntax

fdmsrcsettlecontrol.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 (FDMSRcSettle Control)

The number of records in the DetailRecord arrays.

Syntax

fdmsrcsettlecontrol.DetailRecordCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• DetailRecordAggregate

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

This property is not available at design time.

Data Type

Integer

DetailRecordAggregate Property (FDMSRcSettle Control)

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

Syntax

fdmsrcsettlecontrol.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 FDMSRcECommerce, FDMSRcRetail, FDMSRcHealthCare, FDMSRcBenefit, FDMSRcDebit, or FDMSRcDetailrecord control's GetDetailAggregate method. For instance:

 
 Copy
FDMSRcSettle.DetailRecords.Add(new FDMSRcRecordtype(FDMSRcRetail1.GetDetailAggregate()));

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

To settle an Installment transaction, you must use the FDMSRcDetailrecord 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:

 
 Copy
  FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment
  FDMSRcECommerce.TransactionAmount = "1995"
  FDMSRcECommerce.AuthOnly()

  FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate())
  FDMSRcDetailRecord.InstallmentCount = 3
  FDMSRcDetailRecord.InstallmentNumber = 1
  
  FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.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

GroupId Property (FDMSRcSettle Control)

The Id assigned by FDMS to identify the merchant or group of merchants.

Syntax

fdmsrcsettlecontrol.GroupId[=string]

Default Value

""

Remarks

This property specifies the FDMS assigned group Id. This Id identifies the merchant or group of merchants. This property is required.

Data Type

String

IndustryType Property (FDMSRcSettle Control)

The merchant's industry type.

Syntax

fdmsrcsettlecontrol.IndustryType[=integer]

Possible Values

fitRcUnknown(0), 
fitRcRetail(1), 
fitRcRestaurant(2), 
fitRcGroceryStore(3), 
fitRcDirectMarketing(4), 
fitRcHotel(5), 
fitRcMOTO(6)

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Data Type

Integer

MerchantId Property (FDMSRcSettle Control)

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

Syntax

fdmsrcsettlecontrol.MerchantId[=string]

Default Value

""

Remarks

This property holds the Merchant Id assigned by FDMS. The value is an alphanumeric value up to 16 characters in length.

This property is required.

Data Type

String

MerchantTerminalNumber Property (FDMSRcSettle Control)

Used to identify a unique terminal within a merchant location.

Syntax

fdmsrcsettlecontrol.MerchantTerminalNumber[=string]

Default Value

""

Remarks

This property contains a number assigned by FDMS to uniquely identify a terminal within a merchant location. The value is numeric and may be up to 8 digits in length.

This property is required.

Data Type

String

OpenBatchSTAN Property (FDMSRcSettle Control)

The merchant assigned System Trace Audit Number(STAN) for the Open Batch.

Syntax

fdmsrcsettlecontrol.OpenBatchSTAN[=string]

Default Value

""

Remarks

This property represents a six digit number assigned by the merchant to uniquely reference the transaction. Any request sent to FiServ, such as authorization request, open batch request, close batch request, is considered a transaction and the assigned STAN must be unique accross all those transactions within a given day per Merchant ID and Terminal ID.

Valid values are from 000001 to 999999 inclusive.

Data Type

String

ProxyAuthScheme Property (FDMSRcSettle Control)

The type of authorization to perform when connecting to the proxy.

Syntax

fdmsrcsettlecontrol.ProxyAuthScheme[=integer]

Possible Values

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

Default Value

0

Remarks

The 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 control 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 (FDMSRcSettle Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fdmsrcsettlecontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (FDMSRcSettle Control)

A password if authentication is to be used for the proxy.

Syntax

fdmsrcsettlecontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password 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

ProxyPort Property (FDMSRcSettle Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fdmsrcsettlecontrol.ProxyPort[=integer]

Default Value

80

Remarks

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 (FDMSRcSettle Control)

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

Syntax

fdmsrcsettlecontrol.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 (FDMSRcSettle Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fdmsrcsettlecontrol.ProxySSL[=integer]

Possible Values

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

Default Value

0

Remarks

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 (FDMSRcSettle Control)

A username if authentication is to be used for the proxy.

Syntax

fdmsrcsettlecontrol.ProxyUser[=string]

Default Value

""

Remarks

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

ResponseBatchId Property (FDMSRcSettle Control)

FDMS-generated Id of the batch settlement.

Syntax

fdmsrcsettlecontrol.ResponseBatchId

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

ResponseCode Property (FDMSRcSettle Control)

Contains the 3 digit response code indicating success or reason of failure.

Syntax

fdmsrcsettlecontrol.ResponseCode

Default Value

""

Remarks

Contains the 3 digit response code indicating success or reason of failure.

This property contains a 3 digit code indicating success or the reason of failure. A value of 000 indicates approval. For all other values please see the Response Codes section.

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSRcSettle Control)

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

Syntax

fdmsrcsettlecontrol.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 ResponseApprovalCode contains 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 (FDMSRcSettle Control)

Status of the communication with Datawire.

Syntax

fdmsrcsettlecontrol.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 ResponseApprovalCode 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

ResponseText Property (FDMSRcSettle Control)

This property may hold additional text which describes the reason for a decline, the property in error, etc.

Syntax

fdmsrcsettlecontrol.ResponseText

Default Value

""

Remarks

This property may hold additional text which describes the reason for a decline, the field in error, etc. Applications should not be coded to the text in this property as it is subject to change.

This property is read-only.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (FDMSRcSettle Control)

The date on which this certificate becomes valid.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (FDMSRcSettle Control)

The date on which the certificate expires.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (FDMSRcSettle Control)

A comma-delimited list of extended key usage identifiers.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (FDMSRcSettle Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (FDMSRcSettle Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (FDMSRcSettle Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (FDMSRcSettle Control)

The issuer of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (FDMSRcSettle Control)

The private key of the certificate (if available).

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (FDMSRcSettle Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (FDMSRcSettle Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (FDMSRcSettle Control)

The public key of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (FDMSRcSettle Control)

The textual description of the certificate's public key algorithm.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (FDMSRcSettle Control)

The length of the certificate's public key (in bits).

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (FDMSRcSettle Control)

The serial number of the certificate encoded as a string.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (FDMSRcSettle Control)

The text description of the certificate's signature algorithm.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (FDMSRcSettle Control)

The name of the certificate store for the client certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (FDMSRcSettle 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

fdmsrcsettlecontrol.SSLAcceptServerCertStorePassword[=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

SSLAcceptServerCertStoreType Property (FDMSRcSettle Control)

The type of certificate store for this certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertStoreType[=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

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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (FDMSRcSettle Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (FDMSRcSettle Control)

The MD5 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (FDMSRcSettle Control)

The SHA-1 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (FDMSRcSettle Control)

The SHA-256 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (FDMSRcSettle Control)

The text description of UsageFlags .

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (FDMSRcSettle Control)

The flags that show intended use for the certificate.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (FDMSRcSettle Control)

The certificate's version number.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (FDMSRcSettle Control)

The subject of the certificate used for client authentication.

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (FDMSRcSettle Control)

The certificate (PEM/Base64 encoded).

Syntax

fdmsrcsettlecontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

SSLCertEffectiveDate Property (FDMSRcSettle Control)

The date on which this certificate becomes valid.

Syntax

fdmsrcsettlecontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (FDMSRcSettle Control)

The date on which the certificate expires.

Syntax

fdmsrcsettlecontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (FDMSRcSettle Control)

A comma-delimited list of extended key usage identifiers.

Syntax

fdmsrcsettlecontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (FDMSRcSettle Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (FDMSRcSettle Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (FDMSRcSettle Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (FDMSRcSettle Control)

The issuer of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (FDMSRcSettle Control)

The private key of the certificate (if available).

Syntax

fdmsrcsettlecontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (FDMSRcSettle Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

fdmsrcsettlecontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (FDMSRcSettle Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

fdmsrcsettlecontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (FDMSRcSettle Control)

The public key of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (FDMSRcSettle Control)

The textual description of the certificate's public key algorithm.

Syntax

fdmsrcsettlecontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (FDMSRcSettle Control)

The length of the certificate's public key (in bits).

Syntax

fdmsrcsettlecontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (FDMSRcSettle Control)

The serial number of the certificate encoded as a string.

Syntax

fdmsrcsettlecontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (FDMSRcSettle Control)

The text description of the certificate's signature algorithm.

Syntax

fdmsrcsettlecontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (FDMSRcSettle Control)

The name of the certificate store for the client certificate.

Syntax

fdmsrcsettlecontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (FDMSRcSettle 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

fdmsrcsettlecontrol.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 (FDMSRcSettle Control)

The type of certificate store for this certificate.

Syntax

fdmsrcsettlecontrol.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

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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLCertSubjectAltNames Property (FDMSRcSettle Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (FDMSRcSettle Control)

The MD5 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (FDMSRcSettle Control)

The SHA-1 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (FDMSRcSettle Control)

The SHA-256 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (FDMSRcSettle Control)

The text description of UsageFlags .

Syntax

fdmsrcsettlecontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (FDMSRcSettle Control)

The flags that show intended use for the certificate.

Syntax

fdmsrcsettlecontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (FDMSRcSettle Control)

The certificate's version number.

Syntax

fdmsrcsettlecontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (FDMSRcSettle Control)

The subject of the certificate used for client authentication.

Syntax

fdmsrcsettlecontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (FDMSRcSettle Control)

The certificate (PEM/Base64 encoded).

Syntax

fdmsrcsettlecontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

SSLProvider Property (FDMSRcSettle Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fdmsrcsettlecontrol.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 as follows:

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

SSLServerCertEffectiveDate Property (FDMSRcSettle Control)

The date on which this certificate becomes valid.

Syntax

fdmsrcsettlecontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (FDMSRcSettle Control)

The date on which the certificate expires.

Syntax

fdmsrcsettlecontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (FDMSRcSettle Control)

A comma-delimited list of extended key usage identifiers.

Syntax

fdmsrcsettlecontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (FDMSRcSettle Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (FDMSRcSettle Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (FDMSRcSettle Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (FDMSRcSettle Control)

The issuer of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (FDMSRcSettle Control)

The private key of the certificate (if available).

Syntax

fdmsrcsettlecontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (FDMSRcSettle Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (FDMSRcSettle Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

fdmsrcsettlecontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (FDMSRcSettle Control)

The public key of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (FDMSRcSettle Control)

The textual description of the certificate's public key algorithm.

Syntax

fdmsrcsettlecontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (FDMSRcSettle Control)

The length of the certificate's public key (in bits).

Syntax

fdmsrcsettlecontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (FDMSRcSettle Control)

The serial number of the certificate encoded as a string.

Syntax

fdmsrcsettlecontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (FDMSRcSettle Control)

The text description of the certificate's signature algorithm.

Syntax

fdmsrcsettlecontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (FDMSRcSettle Control)

The name of the certificate store for the client certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (FDMSRcSettle 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

fdmsrcsettlecontrol.SSLServerCertStorePassword

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (FDMSRcSettle Control)

The type of certificate store for this certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertStoreType

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

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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (FDMSRcSettle Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (FDMSRcSettle Control)

The MD5 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (FDMSRcSettle Control)

The SHA-1 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (FDMSRcSettle Control)

The SHA-256 hash of the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (FDMSRcSettle Control)

The text description of UsageFlags .

Syntax

fdmsrcsettlecontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (FDMSRcSettle Control)

The flags that show intended use for the certificate.

Syntax

fdmsrcsettlecontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (FDMSRcSettle Control)

The certificate's version number.

Syntax

fdmsrcsettlecontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (FDMSRcSettle Control)

The subject of the certificate used for client authentication.

Syntax

fdmsrcsettlecontrol.SSLServerCertSubject

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (FDMSRcSettle Control)

The certificate (PEM/Base64 encoded).

Syntax

fdmsrcsettlecontrol.SSLServerCertEncoded

Default Value

""

Remarks

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 (FDMSRcSettle Control)

A timeout for the control.

Syntax

fdmsrcsettlecontrol.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

TPPID Property (FDMSRcSettle Control)

Third Party Processor Identifier assigned by FDMS.

Syntax

fdmsrcsettlecontrol.TPPID[=string]

Default Value

""

Remarks

The Third Party Processor Identifier (TPPID. Also sometimes referred to as a "Vendor Id") is assigned by FDMS to each third party who is processing transactions. Each merchant will receive a TPPID from FDMS.

The default value is "" (empty string). This should be set to the FDMS assigned TPPID.

A VisaIdentifier is also required for Visa transactions.

Data Type

String

URL Property (FDMSRcSettle Control)

Location of the Datawire server to which transactions are sent.

Syntax

fdmsrcsettlecontrol.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 (FDMSRcSettle Control)

Sets or retrieves a configuration setting.

Syntax

fdmsrcsettlecontrol.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 (FDMSRcSettle Control)

Interrupts the current action.

Syntax

fdmsrcsettlecontrol.Interrupt 

Remarks

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

Reset Method (FDMSRcSettle Control)

Clears all properties to their default values.

Syntax

fdmsrcsettlecontrol.Reset 

Remarks

This method clears all properties to their default values.

SendSettlement Method (FDMSRcSettle Control)

Begins a Batch Settlement transaction with the transaction server.

Syntax

fdmsrcsettlecontrol.SendSettlement 

Remarks

This begins a Batch Settlement transaction. The control begins a session with the Datawire system, and then posts an OpenBatch record, all the detail records (BatchSettleDetail records), and a CloseBatch record in sequence. The session is then automatically terminated, and the ResponseBatchId property will indicate the FDMS-generated Id of the batch if the settlement process was successful.

Connected Event (FDMSRcSettle Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Fired when a connection is closed.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Fired when information is available about errors during data delivery.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Fired after the server presents its certificate to the client.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Fired when secure connection progress messages are available.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

Shows the progress of the FDMS/Datawire connection.

Syntax

Sub fdmsrcsettlecontrol_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 (FDMSRcSettle Control)

FDMSRcSettle Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

 
 Copy
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");

 
 Copy
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

C#
 Copy
server.Config("SSLNegotiatedCipher[connId]");

C#
 Copy
server.Config("SSLNegotiatedCipherStrength[connId]");

C#
 Copy
server.Config("SSLNegotiatedCipherSuite[connId]");

C#
 Copy
server.Config("SSLNegotiatedKeyExchange[connId]");

C#
 Copy
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

C#
 Copy
server.Config("SSLNegotiatedVersion[connId]");

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

C#
 Copy
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSRcSettle Control)

FDMSRcSettle 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