FDMSSettle Class

Properties Methods Events Config Settings Errors

The FDMSSettle class is used to do a Batch Settlement on all transactions that were successfully authorized with the FDMSECOMMERCE or FDMSRETAIL classes. This class may also send Level 2 and Level 3 Corporate Purchasing Card data for better interchange rates.

Syntax

FDMSSettle

Remarks

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

The FDMSSettle class is used to settle all transactions previously authorized by the FDMSECommerce or FDMSRetail class. 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 class 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 class 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 class 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 class after activating your merchant account. Set the URL property with one of the URLs you retrieved during Service Discovery.

  Copy
  FDMSSettle.MerchantNumber = "000000999990"                   'Supplied by FDMS/Datawire
  FDMSSettle.MerchantTerminalNumber = "555555"                 'Supplied by FDMS/Datawire
  FDMSSettle.DatawireId = "0000B47FFFFFFFFFFFFF"               'Retrieved with the FDMSRegister class.
  FDMSSettle.URL = "https://staging1.datawire.net/sd/";         'Retrieved with the FDMSRegister class.

Additionally, set the IndustryType and the BatchSequenceNumber.

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

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

Finally, call the SendSettlement method.

  Copy
  FDMSSettle.SendSettlement()

If the settlement is successful, the BatchStatus will contain "OK" and the BatchNumber will contain a number which can be used to identify the batch in the future. If the batch was not successful the class 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 DetailAggregate 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 class to modify the transaction aggregate and set the TransactionType property to fttVoid. Credits and forced transactions may also be created using the FDMSDetailRecord class 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 classs to create addendum aggregates, and then add them to the AddendumAggregate for the corresponding transaction stored in DetailAggregate.

Note that the IndustryType from the FDMSSettle class 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 class with short descriptions. Click on the links for further details.


ApiVersion	Identifies the application version number.
ApplicationId	Identifies the merchant application to the Datawire System.
BatchSequenceNumber	Starting sequence number for the transactions in this batch.
DatawireId	Identifies the merchant to the Datawire System.
DetailRecords	Collection of detail records to send in the settlement.
FDMSPlatform	Specifies the FDMS platform that the transactions will be processed on.
IndustryType	Code which indicates the industry the merchant is engaged in.
MerchantNumber	A unique number used to identify the merchant within the FDMS and Datawire systems.
MerchantServiceNumber	Merchant's customer service phone number.
MerchantTerminalNumber	Used to identify a unique terminal within a merchant location.
Proxy	A set of properties related to proxy access.
Response	Contains the response to the settlement.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the class.
URL	Location of the Datawire server to which transactions are sent.

Method List

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


Config	Sets or retrieves a configuration setting.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.
SendSettlement	Begins a Batch Settlement transaction with the transaction server.

Event List

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


Connected	Fired immediately after a connection completes (or fails).
DataPacketIn	Fired when receiving a data packet from the transaction server.
DataPacketOut	Fired when sending a data packet to the transaction server.
Disconnected	Fired when a connection is closed.
Error	Fired when information is available about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
Status	Shows the progress of the FDMS/Datawire connection.

Config Settings

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


ClientTimeout	Indicates timeout client application will wait for response.
DetailErrorIndex	Contains the detail record number that caused the error during settlement.
RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
UseEnhancedSettlement	Forces enhanced settlement mode.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

ApiVersion Property (FDMSSettle Class)

Identifies the application version number.

Syntax

ANSI (Cross Platform)
char* GetApiVersion();
int SetApiVersion(const char* lpszApiVersion);

Unicode (Windows)
LPWSTR GetApiVersion();
INT SetApiVersion(LPCWSTR lpszApiVersion);

char* dpaymentssdk_fdmssettle_getapiversion(void* lpObj);
int dpaymentssdk_fdmssettle_setapiversion(void* lpObj, const char* lpszApiVersion);

QString GetApiVersion();
int SetApiVersion(QString qsApiVersion);

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 Class)

Identifies the merchant application to the Datawire System.

Syntax

ANSI (Cross Platform)
char* GetApplicationId();
int SetApplicationId(const char* lpszApplicationId);

Unicode (Windows)
LPWSTR GetApplicationId();
INT SetApplicationId(LPCWSTR lpszApplicationId);

char* dpaymentssdk_fdmssettle_getapplicationid(void* lpObj);
int dpaymentssdk_fdmssettle_setapplicationid(void* lpObj, const char* lpszApplicationId);

QString GetApplicationId();
int SetApplicationId(QString qsApplicationId);

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

Data Type

String

BatchSequenceNumber Property (FDMSSettle Class)

Starting sequence number for the transactions in this batch.

Syntax

ANSI (Cross Platform)
char* GetBatchSequenceNumber();
int SetBatchSequenceNumber(const char* lpszBatchSequenceNumber);

Unicode (Windows)
LPWSTR GetBatchSequenceNumber();
INT SetBatchSequenceNumber(LPCWSTR lpszBatchSequenceNumber);

char* dpaymentssdk_fdmssettle_getbatchsequencenumber(void* lpObj);
int dpaymentssdk_fdmssettle_setbatchsequencenumber(void* lpObj, const char* lpszBatchSequenceNumber);

QString GetBatchSequenceNumber();
int SetBatchSequenceNumber(QString qsBatchSequenceNumber);

Default Value

Remarks

A batch settlement is made up of many separate transaction packets. The class 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 class 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

DatawireId Property (FDMSSettle Class)

Identifies the merchant to the Datawire System.

Syntax

ANSI (Cross Platform)
char* GetDatawireId();
int SetDatawireId(const char* lpszDatawireId);

Unicode (Windows)
LPWSTR GetDatawireId();
INT SetDatawireId(LPCWSTR lpszDatawireId);

char* dpaymentssdk_fdmssettle_getdatawireid(void* lpObj);
int dpaymentssdk_fdmssettle_setdatawireid(void* lpObj, const char* lpszDatawireId);

QString GetDatawireId();
int SetDatawireId(QString qsDatawireId);

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 class). 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

DetailRecords Property (FDMSSettle Class)

Collection of detail records to send in the settlement.

Syntax

DPaymentsSDKList<DPaymentsSDKFDMSRecordType>* GetDetailRecords();
int SetDetailRecords(DPaymentsSDKList<DPaymentsSDKFDMSRecordType>* val);

int dpaymentssdk_fdmssettle_getdetailrecordcount(void* lpObj);
int dpaymentssdk_fdmssettle_setdetailrecordcount(void* lpObj, int iDetailRecordCount);

char* dpaymentssdk_fdmssettle_getdetailrecordaddendum(void* lpObj, int detailrecordindex);
int dpaymentssdk_fdmssettle_setdetailrecordaddendum(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAddendum);

char* dpaymentssdk_fdmssettle_getdetailrecordaggregate(void* lpObj, int detailrecordindex);
int dpaymentssdk_fdmssettle_setdetailrecordaggregate(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAggregate);

int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

QString GetDetailRecordAddendum(int iDetailRecordIndex);
int SetDetailRecordAddendum(int iDetailRecordIndex, QString qsDetailRecordAddendum);

QString GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, QString qsDetailRecordAggregate);

Remarks

Each FDMSRecordType object in the collection specifies an XML aggregate representing the transaction to be settled. The FDMSRecordType may also specify an addenda aggregate for sending Level 2 or Level 2 and Level 3 data. The XML aggregate to be settled is generated from the FDMSRetail, FDMSECommerce, or FDMSDetailRecord class.

The following example shows how to add a detail record to the collection.

  Copy
  FDMSEcommerce1.Authorize();
  FDMSSettle.DetailRecords.Add(new FDMSRecordType(FDMSEcommerce1.GetDetailAggregate()));

Xml aggregates are used instead of directly passing Objects because it is easy to store XML aggregates in a database after authorization, and then retrieve them for settlement at the end of the business day.

Up to 9900 detail records may be settled in the above manner, just by adding a transactions to the DetailRecords property. However, it is recommended that Batch Settlements be kept relatively small - around 350 transactions or so - to decrease the number of records that must be resent in the event of an error.

Data Type

DPaymentsSDKFDMSRecordType

FDMSPlatform Property (FDMSSettle Class)

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

Syntax

ANSI (Cross Platform)
int GetFDMSPlatform();
int SetFDMSPlatform(int iFDMSPlatform);

Unicode (Windows)
INT GetFDMSPlatform();
INT SetFDMSPlatform(INT iFDMSPlatform);

Possible Values

FP_NORTH(0), 
FP_NASHVILLE(1)

int dpaymentssdk_fdmssettle_getfdmsplatform(void* lpObj);
int dpaymentssdk_fdmssettle_setfdmsplatform(void* lpObj, int iFDMSPlatform);

int GetFDMSPlatform();
int SetFDMSPlatform(int iFDMSPlatform);

Default Value

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


fpNorth (0)	North/Cardnet platform.
fpNashville (1)	Nashville platform.

Data Type

Integer

IndustryType Property (FDMSSettle Class)

Code which indicates the industry the merchant is engaged in.

Syntax

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

Possible Values

FIT_UNKNOWN(0), 
FIT_RETAIL(1), 
FIT_RESTAURANT(2), 
FIT_GROCERY_STORE(3), 
FIT_DIRECT_MARKETING(4), 
FIT_HOTEL(5)

int dpaymentssdk_fdmssettle_getindustrytype(void* lpObj);
int dpaymentssdk_fdmssettle_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

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


fitUnknown (0)	Unknown or unsure.
fitRetail (1)	Retail store.
fitRestaurant (2)	Food / Restaurant.
fitGroceryStore (3)	Grocery store or supermarket.
fitDirectMarketing (4)	eCommerce or Direct Marketing
fitHotel (5)	Hotel / Lodging.

Data Type

Integer

MerchantNumber Property (FDMSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber);

Unicode (Windows)
LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);

char* dpaymentssdk_fdmssettle_getmerchantnumber(void* lpObj);
int dpaymentssdk_fdmssettle_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

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 Class)

Merchant's customer service phone number.

Syntax

ANSI (Cross Platform)
char* GetMerchantServiceNumber();
int SetMerchantServiceNumber(const char* lpszMerchantServiceNumber);

Unicode (Windows)
LPWSTR GetMerchantServiceNumber();
INT SetMerchantServiceNumber(LPCWSTR lpszMerchantServiceNumber);

char* dpaymentssdk_fdmssettle_getmerchantservicenumber(void* lpObj);
int dpaymentssdk_fdmssettle_setmerchantservicenumber(void* lpObj, const char* lpszMerchantServiceNumber);

QString GetMerchantServiceNumber();
int SetMerchantServiceNumber(QString qsMerchantServiceNumber);

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 Class)

Used to identify a unique terminal within a merchant location.

Syntax

ANSI (Cross Platform)
char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber);

Unicode (Windows)
LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);

char* dpaymentssdk_fdmssettle_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_fdmssettle_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

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

Proxy Property (FDMSSettle Class)

A set of properties related to proxy access.

Syntax

DPaymentsSDKProxy* GetProxy();
int SetProxy(DPaymentsSDKProxy* val);

int dpaymentssdk_fdmssettle_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmssettle_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int dpaymentssdk_fdmssettle_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmssettle_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* dpaymentssdk_fdmssettle_getproxypassword(void* lpObj);
int dpaymentssdk_fdmssettle_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int dpaymentssdk_fdmssettle_getproxyport(void* lpObj);
int dpaymentssdk_fdmssettle_setproxyport(void* lpObj, int iProxyPort);

char* dpaymentssdk_fdmssettle_getproxyserver(void* lpObj);
int dpaymentssdk_fdmssettle_setproxyserver(void* lpObj, const char* lpszProxyServer);

int dpaymentssdk_fdmssettle_getproxyssl(void* lpObj);
int dpaymentssdk_fdmssettle_setproxyssl(void* lpObj, int iProxySSL);

char* dpaymentssdk_fdmssettle_getproxyuser(void* lpObj);
int dpaymentssdk_fdmssettle_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

DPaymentsSDKProxy

Response Property (FDMSSettle Class)

Contains the response to the settlement.

Syntax

DPaymentsSDKFDMSSettleResponse* GetResponse();

char* dpaymentssdk_fdmssettle_getresponsebatchnumber(void* lpObj);

char* dpaymentssdk_fdmssettle_getresponsebatchstatus(void* lpObj);

char* dpaymentssdk_fdmssettle_getresponsedatawirereturncode(void* lpObj);

char* dpaymentssdk_fdmssettle_getresponsedatawirestatus(void* lpObj);

QString GetResponseBatchNumber();

QString GetResponseBatchStatus();

QString GetResponseDatawireReturnCode();

QString GetResponseDatawireStatus();

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after calling SendSettlement. The FDMSSettleResponse type contains the following fields:


BatchNumber	FDMS-generated Id of the batch settlement.
BatchStatus	Indicates success or failure of the entire settlement.
DatawireReturnCode	Contains an error code providing more details about the DatawireStatus received.
DatawireStatus	Status of the communication with Datawire.

This property is read-only.

Data Type

DPaymentsSDKFDMSSettleResponse

SSLAcceptServerCert Property (FDMSSettle Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_fdmssettle_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_fdmssettle_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmssettle_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmssettle_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_fdmssettle_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_fdmssettle_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_fdmssettle_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_fdmssettle_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_fdmssettle_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_fdmssettle_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_fdmssettle_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_fdmssettle_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_fdmssettle_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmssettle_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DPaymentsSDKCertificate

SSLCert Property (FDMSSettle Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_fdmssettle_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertissuer(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_fdmssettle_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmssettle_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmssettle_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmssettle_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_fdmssettle_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmssettle_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_fdmssettle_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmssettle_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_fdmssettle_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertusage(void* lpObj);

int dpaymentssdk_fdmssettle_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertversion(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmssettle_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_fdmssettle_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmssettle_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DPaymentsSDKCertificate

SSLProvider Property (FDMSSettle Class)

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

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_fdmssettle_getsslprovider(void* lpObj);
int dpaymentssdk_fdmssettle_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

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 class 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:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (FDMSSettle Class)

The server certificate for the last established connection.

Syntax

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_fdmssettle_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_fdmssettle_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmssettle_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmssettle_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_fdmssettle_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_fdmssettle_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertusage(void* lpObj);

int dpaymentssdk_fdmssettle_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertversion(void* lpObj);

char* dpaymentssdk_fdmssettle_getsslservercertsubject(void* lpObj);

int dpaymentssdk_fdmssettle_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

Timeout Property (FDMSSettle Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_fdmssettle_gettimeout(void* lpObj);
int dpaymentssdk_fdmssettle_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

URL Property (FDMSSettle Class)

Location of the Datawire server to which transactions are sent.

Syntax

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* dpaymentssdk_fdmssettle_geturl(void* lpObj);
int dpaymentssdk_fdmssettle_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

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 class. Once you Register and Activate the merchant using the FDMSRegister class, 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 class.

Data Type

String

Config Method (FDMSSettle Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_fdmssettle_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (FDMSSettle Class)

Interrupts the current action.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_fdmssettle_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FDMSSettle Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmssettle_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

SendSettlement Method (FDMSSettle Class)

Begins a Batch Settlement transaction with the transaction server.

Syntax

ANSI (Cross Platform)
int SendSettlement();

Unicode (Windows)
INT SendSettlement();

int dpaymentssdk_fdmssettle_sendsettlement(void* lpObj);

int SendSettlement();

Remarks

This begins a Batch Settlement transaction. The class 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 BatchStatus property will indicate the result of the settlement as returned by the FDMS processor.

Error Handling (C++)

Connected Event (FDMSSettle Class)

Fired immediately after a connection completes (or fails).

Syntax

ANSI (Cross Platform)
virtual int FireConnected(FDMSSettleConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} FDMSSettleConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(FDMSSettleConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FDMSSettleConnectedEventParams;

#define EID_FDMSSETTLE_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class FDMSSettleConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(FDMSSettleConnectedEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireConnected(FDMSSettleConnectedEventParams *e) {...}

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.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSSettle Class)

Fired when receiving a data packet from the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketIn(FDMSSettleDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} FDMSSettleDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(FDMSSettleDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} FDMSSettleDataPacketInEventParams;

#define EID_FDMSSETTLE_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class FDMSSettleDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(FDMSSettleDataPacketInEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireDataPacketIn(FDMSSettleDataPacketInEventParams *e) {...}

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

DataPacketOut Event (FDMSSettle Class)

Fired when sending a data packet to the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketOut(FDMSSettleDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} FDMSSettleDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(FDMSSettleDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} FDMSSettleDataPacketOutEventParams;

#define EID_FDMSSETTLE_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class FDMSSettleDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(FDMSSettleDataPacketOutEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireDataPacketOut(FDMSSettleDataPacketOutEventParams *e) {...}

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

Disconnected Event (FDMSSettle Class)

Fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(FDMSSettleDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} FDMSSettleDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(FDMSSettleDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FDMSSettleDisconnectedEventParams;

#define EID_FDMSSETTLE_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class FDMSSettleDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(FDMSSettleDisconnectedEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireDisconnected(FDMSSettleDisconnectedEventParams *e) {...}

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.

Please refer to the Error Codes section for more information.

Error Event (FDMSSettle Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(FDMSSettleErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FDMSSettleErrorEventParams;


Unicode (Windows)
virtual INT FireError(FDMSSettleErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FDMSSettleErrorEventParams;

#define EID_FDMSSETTLE_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FDMSSettleErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FDMSSettleErrorEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireError(FDMSSettleErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FDMSSettleSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FDMSSettleSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FDMSSettleSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FDMSSettleSSLServerAuthenticationEventParams;

#define EID_FDMSSETTLE_SSLSERVERAUTHENTICATION 6

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FDMSSettleSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FDMSSettleSSLServerAuthenticationEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireSSLServerAuthentication(FDMSSettleSSLServerAuthenticationEventParams *e) {...}

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 Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(FDMSSettleSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FDMSSettleSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FDMSSettleSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FDMSSettleSSLStatusEventParams;

#define EID_FDMSSETTLE_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class FDMSSettleSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FDMSSettleSSLStatusEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireSSLStatus(FDMSSettleSSLStatusEventParams *e) {...}

Remarks

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

Status Event (FDMSSettle Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

ANSI (Cross Platform)
virtual int FireStatus(FDMSSettleStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FDMSSettleStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(FDMSSettleStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FDMSSettleStatusEventParams;

#define EID_FDMSSETTLE_STATUS 8

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

class FDMSSettleStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(FDMSSettleStatusEventParams *e);

// Or, subclass FDMSSettle and override this emitter function.
virtual int FireStatus(FDMSSettleStatusEventParams *e) {...}

Remarks

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

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

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.

ExpirationDate
char* (read-only)
Default Value: ""

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.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

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

Fingerprint
char* (read-only)
Default Value: ""

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

FingerprintSHA1
char* (read-only)
Default Value: ""

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

FingerprintSHA256
char* (read-only)
Default Value: ""

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

Issuer
char* (read-only)
Default Value: ""

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

PrivateKey
char* (read-only)
Default Value: ""

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

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

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

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

PrivateKeyContainer
char* (read-only)
Default Value: ""

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

PublicKey
char* (read-only)
Default Value: ""

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

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

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.

PublicKeyLength
int (read-only)
Default Value: 0

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

SerialNumber
char* (read-only)
Default Value: ""

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.

SignatureAlgorithm
char* (read-only)
Default Value: ""

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.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: 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);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

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

ThumbprintMD5
char* (read-only)
Default Value: ""

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.

ThumbprintSHA1
char* (read-only)
Default Value: ""

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.

ThumbprintSHA256
char* (read-only)
Default Value: ""

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.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

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.

UsageFlags
int (read-only)
Default Value: 0

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


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

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

Version
char* (read-only)
Default Value: ""

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

Subject
char*
Default Value: ""

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 field 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:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

FDMSRecordType Type

Detail record storage type.

Syntax

DPaymentsSDKFDMSRecordType (declared in dpaymentssdk.h)

Remarks

This type contains the XML aggregate for a single transaction, as well as an XML aggregate of any additional addenda to be added to the record at settlement. The fields contained by this type are listed below.

The following fields are available:

AddendumAggregate
DetailAggregate

Fields

AddendumAggregate
char*
Default Value: ""

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

The DetailAggregate field contains an xml aggregate of the transaction retrieved from the FDMSECommerce, FDMSRetail, or FDMSDetailRecord class'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 DetailAggregate. The AddendumAggregate field takes an xml aggregate containing either Level2 or Level2 plus Level3 addendum data, which will be added to the DetailAggregate when sending the settlement. The AddendumAggregate may be created with either the FDMSLevel2 or FDMSLevel3 classs, and then returned via those class's GetAddendum method.

For example:

  Copy
  '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 DetailAggregates have a corresponding AddendumAggregate.

DetailAggregate
char*
Default Value: ""

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

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

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

For example, to add a gratuity to a charge:

  Copy
  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 class 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
  FDMSECommerce.TransactionType = dmtInstallment
  FDMSECommerce.TransactionAmount = "1995"
  FDMSECommerce.Authorize()

  FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate()
  FDMSDetailRecord.InstallmentCount = 3
  FDMSDetailRecord.InstallmentNumber = 1
  
  
  FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

Constructors

FDMSRecordType()

FDMSRecordType(const char* lpszDetailAggregate)

FDMSRecordType(const char* lpszDetailAggregate, const char* lpszAddendumAggregate)

FDMSSettleResponse Type

Contains the response to the batch settlement..

Syntax

DPaymentsSDKFDMSSettleResponse (declared in dpaymentssdk.h)

Remarks

This type contains the results of a transaction made with the FDMSSettle class. The fields contained by this type are listed below.

The following fields are available:

BatchNumber
BatchStatus
DatawireReturnCode
DatawireStatus

Fields

BatchNumber
char* (read-only)
Default Value: "0"

FDMS-generated Id of the batch settlement.

This field 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.

BatchStatus
char* (read-only)
Default Value: ""

Indicates success or failure of the entire settlement.

This field 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 class. Possible responses include:


Code	Description
OK	Batch completed successfully.
DUP GEN RECORD	Duplicate general record.
DUP RECORD	Duplicate detail record.
INVLD ACCT 1	Merchant attempted to capture a transaction for which he is not entitled.
INVLD ACCT 2	Merchant entered an invalid account number (length or prefix error).
INVLD AMT 3	Merchant entered an invalid amount in the capture transaction.
INVLD FIELD DATA	Invalid field data.
INVLD GENERAL TYPE	Invalid or duplicate header record.
INVLD LENGTH	Invalid length when extracting ISO field from data buffer.
INVLD RECORD TYPE	Unknown record type.
INVLD SETTLE 4	The item count or dollar total does not agree. Correct and retransmit the entire batch.
INVLD SETTLE 5	System rejected batch for reasons unrelated to a specific record.
INVLD SUPPL DATA	Invalid supplemental data.
INVLD TRANS CODE	Invalid trans code.
NO HEADER RECORD	No header record.
PLEASE RETRY	Server has timed out. Please retry batch.
SUPPL OUT OF SEQ	Supplemental batch sequence number does not match original.
TCH OUT OF SEQ	Batch sequence number does not match count.
UNSUPPORTED TRAN	Batch Review (Tran Code 97) not supported.
INV SETTL TR1	Batch rejected for invalid track 1 data
INV SETTL TR2	Batch rejected for invalid track 2 data
INVLD DATA!	Data format does not correspond to fields identified in the bit map.
(any other data)	Consider request not approved.

DatawireReturnCode
char* (read-only)
Default Value: ""

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

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". These two fields 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 field only indicates that the request reached FDMS, and that FDMS responded with some data.

The CaptureFlag and ApprovalCode fields contain the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:


000	Transaction successfully passed through the Datawire system to the FDMS Payment Processor and back.
200	Host Busy - The processor's Host is busy and is currently unable to service this request.
201	Host Unavailable - The processor's Host is currently unavailable. For example, the server is sending NAK.
202	Host Connect Error - Could not connect to the processor's Host.
203	Host Drop - The processor's Host disconnected during the transaction before sending a response.
204	Host Comm Error - An error was encountered while communicating with the processor's Host.
205	No Response - No response from the processor's Host
206	Host Send Error - An error has encountered when sending the request to the processor, and the Host daemon cannot continue sending packets to the processor because the connection is broken.
405	Vxn Timeout - The request could not be processed.
505	Network Error - The request could not be processed.

DatawireStatus
char* (read-only)
Default Value: ""

Status of the communication with Datawire.

The CaptureFlag and ApprovalCode fields contains the actual FDMS Transaction Result that was returned.

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


OK	Transaction has successfully passed through the Datawire system to the FDMS Payment processor and back.
AuthenticationError	DatawireId in the request was not successfully authenticated.
UnknownServiceID	ServiceId part of the URL (in the Service Discovery or Ping request) is unknown.
WrongSessionContext	The SessionContext element of the Session Transaction request does not match the SessionContext returned by the InitiateSession response (applicable to the FDMSSettle class).
AccessDenied	Generally, occurs when you try to register a merchant after a merchant has already been activated to use the Datawire VXN.
Failed	Your Merchant Registration has failed. Contact tech.support@datawire.net for more information.
Retry	Registration is not yet complete. You must send the Registration request again.
Timeout	No response from the Service Provider was received during the expected period of time.
XMLError	Request contains some XML error, such as malformed XML, violation of this DTD, etc.
OtherError	Unspecified error occurred.
008	Network Error

Constructors

FDMSSettleResponse()

Proxy Type

The proxy the component will connect to.

Syntax

DPaymentsSDKProxy (declared in dpaymentssdk.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

AuthScheme
AutoDetect
Password
Port
Server
SSL
User

Fields

AuthScheme
int
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.

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

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

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

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
int
Default Value: FALSE

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

Password
char*
Default Value: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default Value: 80

The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

Server
char*
Default Value: ""

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

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

SSL
int
Default Value: 0

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


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

User
char*
Default Value: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

DPaymentsSDKList Type

Syntax

DPaymentsSDKList<T> (declared in dpaymentssdk.h)

Remarks

DPaymentsSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the FDMSSettle class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (FDMSSettle Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

FDMSSettle Config Settings

ClientTimeout: Indicates timeout client application will wait for response.

This setting indicates the interval of time, in seconds, a client will wait for the response for any given request. Normally this value is set to a value 5 seconds less than the Timeout value to allow for a response to be received from Datawire. It may be changed independently by setting this configuration setting AFTER setting the Timeout property. Note that too small a value will cause Datawire to reject a transaction immediately.

DetailErrorIndex: Contains the detail record number that caused the error during settlement.

This field will be populated when an error, caused by a specific detail record, occurs during settlement. This allows you to obtain and review the specific detail record that caused the error. The returned value will need to be adjusted accordingly to obtain the actual index of DetailRecords. For example, if you are using zero-based indexes, a 1 will need to be subtracted from the returned value.

RawRequest: Returns the request sent to the server for debugging purposes.

After an operation this setting may be queried to return the request as it was sent to the server. This is useful for debugging purposes.

RawResponse: Returns the response received from the server for debugging purposes.

After an operation this setting may be queried to return the response as it was received from the server. This is useful for debugging purposes.

UseEnhancedSettlement: Forces enhanced settlement mode.

By default, enhanced settlement is only used when passing Level 2 or Level 3 data in the settlement, or for the Restaurant industry type. Setting this to True will force enhanced settlement mode for all industry types which would normally use the Simple Settlement protocol.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.example.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following:

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

Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

  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");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.