FDMSRegister Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRegister class is a tool used to Register and Activate a merchant account with the Datawire VXN. This allows you to send transactions through the Datawire system to the First Data Merchant Services (FDMS) processor. This class is also used to find the appropriate URLs to which authorizations and settlements will be posted.

Class Name

DPaymentsSDK_FDMSRegister

Procedural Interface

 dpaymentssdk_fdmsregister_open();
 dpaymentssdk_fdmsregister_close($res);
 dpaymentssdk_fdmsregister_register_callback($res, $id, $function);
 dpaymentssdk_fdmsregister_get_last_error($res);
 dpaymentssdk_fdmsregister_get_last_error_code($res);
 dpaymentssdk_fdmsregister_set($res, $id, $index, $value);
 dpaymentssdk_fdmsregister_get($res, $id, $index);
 dpaymentssdk_fdmsregister_do_activate($res);
 dpaymentssdk_fdmsregister_do_config($res, $configurationstring);
 dpaymentssdk_fdmsregister_do_interrupt($res);
 dpaymentssdk_fdmsregister_do_ping($res, $url);
 dpaymentssdk_fdmsregister_do_register($res);
 dpaymentssdk_fdmsregister_do_reset($res);
 dpaymentssdk_fdmsregister_do_servicediscovery($res, $url);

Remarks

The FDMSRegister class is a tool used to Register and Activate a merchant account with the Datawire VXN. This class communicates with the Datawire VXN transaction transport network, and allows you to set up your account so that credit card transactions made with the FDMSECommerce, FDMSRetail, and FDMSSettle classs will pass through Datawire and ultimately reach the First Data Merchant Services (FDMS) transaction processor. Before you can charge a single credit card, you must Register and Activate your FDMS account, and then run a ServiceDiscovery to find acceptable URLs, which you will ultimately use to send credit card authorizations.

The first thing you must do is Register your merchant account. First Data Merchant Services will provide you with a MerchantNumber and a MerchantTerminalNumber, which are required for registering with Datawire. If you are registering on the Rapid Connect platform you must also set the GroupId configuration setting. In addition, you will need to set the TransactionNumber with a unique value (the TransactionNumber should be incremented for each transaction you send to the Datawire VXN). The example below also sets the URL to point to the Datawire test server.

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" //FDMSRegister.Config("GroupId=FDMS_Assigned_GroupId"); //Rapid Connect Only FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register()

If the registration was successful, the DatawireStatus will contain "OK", and the DatawireId will contain the new Id which you must save and send with every subsequent transaction. The PrimaryDiscoveryURL and SecondaryDiscoveryURL properties will also be filled after a successful authorization. These URLs should be saved for later, and used to perform ServiceDiscovery.

After registering, you must immediately Activate the merchant. If you wait too long, your registration will time out, and you will have to contact Datawire to have them reset your account so that you may register again. When activating the merchant, the same properties are required as for the Register method, with the addition of the DatawireId property. Since the call to Register filled the DatawireId property with the correct value, all we need to do now is:

FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

After registering and activating the account, you may now move on to Service Discovery. The Register method will return both a PrimaryDiscoveryURL and a SecondaryDiscoveryURL. Use these URLs with the ServiceDiscovery method to retrieve a list of valid transaction URLs. For instance:

FDMSRegister.ServiceDiscovery("https://staging1.datawire.net/sd")

After a successful ServiceDiscovery the DatawireStatus will be "OK". The discovered URLs will be listed in the ServiceProviders array property. At this time, you should Ping each of these URLs and sort them in order of fastest to slowest response time. You will use the URL with the fastest response time to authorize transactions with FDMSRetail or FDMSECommerce. If the first URL stops responding, you should remove the URL and switch to the next URL in the list. The following example shows how to ping each of the ServiceProviders (you must save and sort the results yourself).

For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

If your list of servers becomes empty, perform ServiceDiscovery and the subsequent steps to re-populate the list of available servers.

You may now use the DatawireId and the Service Provider URLs retrieved by this class to submit transactions using the FDMSECommerce, FDMSRetail, and FDMSSettle classs.

Property List

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

Method List

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

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.

Config Settings

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

ApplicationId Property (DPaymentsSDK_FDMSRegister Class)

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();
public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 1 );
dpaymentssdk_fdmsregister_set($res, 1, $value );

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 SDK, and is used for credit card transactions. To provision a merchant on the SVDot Closed Loop Gift Card System, use "IBIZINTGRGIFTXML" instead. You will then be able to use the FDMSGiftCard class to make transactions.

To provision a merchant for the Rapid Connect platform, use "RAPIDCONNECTSRS" instead.

Note, you may be required by FDMS or Datawire to have a new ApplicationId assigned for the software you create with this class.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSRegister Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();
public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 2 );
dpaymentssdk_fdmsregister_set($res, 2, $value );

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

DatawireReturnCode Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getDatawireReturnCode();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 3 );

Default Value

''

Remarks

When a registration transaction has been successfully processed by the Datawire VXN, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

DatawireStatus Property (DPaymentsSDK_FDMSRegister Class)

Status of the communication with Datawire.

Object Oriented Interface

public function getDatawireStatus();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 4 );

Default Value

''

Remarks

When a registration transaction has been successfully processed by the Datawire VXN, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

FDMSPlatform Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getFDMSPlatform();
public function setFDMSPlatform($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 5 );
dpaymentssdk_fdmsregister_set($res, 5, $value );

Possible Values

FDMSREGISTER_FDMSPLATFORM_NORTH(0), 
FDMSREGISTER_FDMSPLATFORM_NASHVILLE(1), 
FDMSREGISTER_FDMSPLATFORM_OMAHA(2), 
FDMSREGISTER_FDMSPLATFORM_RAPID_CONNECT(3)

Default Value

0

Remarks

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

Data Type

Integer

MerchantNumber Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getMerchantNumber();
public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 6 );
dpaymentssdk_fdmsregister_set($res, 6, $value );

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

MerchantTerminalNumber Property (DPaymentsSDK_FDMSRegister Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();
public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 7 );
dpaymentssdk_fdmsregister_set($res, 7, $value );

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

PingResponseTime Property (DPaymentsSDK_FDMSRegister Class)

Returned after calling the Ping method.

Object Oriented Interface

public function getPingResponseTime();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 8 );

Default Value

0

Remarks

The PingResponseTime contains the total transaction time, in milliseconds, it took for the transaction to reach the Datawire server identified by the URL passed to the Ping method. This time includes only the time the transaction spent between pinged Datawire server and the FDMS host. This property is filled after calling the Ping method. For instance:

FDMSRegister.ServiceDiscovery("https://staging1.datawire.net/sd") For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

Note: This property does not apply to Rapid Connect implementations.

This property is read-only.

Data Type

Integer

PrimaryDiscoveryURL Property (DPaymentsSDK_FDMSRegister Class)

URL to use with the ServiceDiscovery method to retrieve a list of service provider URLs.

Object Oriented Interface

public function getPrimaryDiscoveryURL();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 9 );

Default Value

''

Remarks

For the North, Nashville, and Omaha platforms: This property is filled after a successful call to the Register method. This URL should be saved, as it will be needed to perform ServiceDiscovery after you Register and Activate your account. Service Discovery should be tried first with the PrimaryDiscoveryURL. If no response is received or you are unable to connect to the primary URL, you should then attempt Service Discovery with the SecondaryDiscoveryURL instead.

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

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 10 );
dpaymentssdk_fdmsregister_set($res, 10, $value );

Possible Values

FDMSREGISTER_PROXYAUTHSCHEME_BASIC(0), 
FDMSREGISTER_PROXYAUTHSCHEME_DIGEST(1), 
FDMSREGISTER_PROXYAUTHSCHEME_PROPRIETARY(2), 
FDMSREGISTER_PROXYAUTHSCHEME_NONE(3), 
FDMSREGISTER_PROXYAUTHSCHEME_NTLM(4), 
FDMSREGISTER_PROXYAUTHSCHEME_NEGOTIATE(5)

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 11 );
dpaymentssdk_fdmsregister_set($res, 11, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 12 );
dpaymentssdk_fdmsregister_set($res, 12, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 13 );
dpaymentssdk_fdmsregister_set($res, 13, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 14 );
dpaymentssdk_fdmsregister_set($res, 14, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 15 );
dpaymentssdk_fdmsregister_set($res, 15, $value );

Possible Values

FDMSREGISTER_PROXYSSL_AUTOMATIC(0), 
FDMSREGISTER_PROXYSSL_ALWAYS(1), 
FDMSREGISTER_PROXYSSL_NEVER(2), 
FDMSREGISTER_PROXYSSL_TUNNEL(3)

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 16 );
dpaymentssdk_fdmsregister_set($res, 16, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SecondaryDiscoveryURL Property (DPaymentsSDK_FDMSRegister Class)

URL to use with the ServiceDiscovery method to retrieve a list of service provider URLs.

Object Oriented Interface

public function getSecondaryDiscoveryURL();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 17 );

Default Value

''

Remarks

For the North, Nashville, and Omaha platforms: This property is filled after a successful call to the Register method. This URL should be saved, as it will be needed to perform ServiceDiscovery after you Register and Activate your account. Service Discovery should be tried first with the PrimaryDiscoveryURL. If no response is received or you are unable to connect to the primary URL, you should then attempt Service Discovery with the SecondaryDiscoveryURL instead.

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

Data Type

String

ServiceProvidersCount Property (DPaymentsSDK_FDMSRegister Class)

The number of records in the ServiceProviders array.

Object Oriented Interface

public function getServiceProvidersCount();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 18 );

Default Value

0

Remarks

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

Data Type

Integer

ServiceProviders Property (DPaymentsSDK_FDMSRegister Class)

Array containing a list of URLs which may be used to send credit card transactions to.

Object Oriented Interface

public function getServiceProviders($serviceprovidersindex);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 19 , $serviceprovidersindex);

Default Value

'0'

Remarks

For the North, Nashville, and Omaha platforms: This property is populated after a call to the ServiceDiscovery method, and contains a list of Service Provider URLs necessary to transport transactions from the application, through the Datawire VXN, then to the FDMS payment processor and back. You should Ping each of these URLs to determine which one has the shortest PingResponseTime, and use that URL for all subsequent credit card transactions.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

For the Rapid Connect platform: This property is populated after a call to the Register method and contains a list of Service Provider URLs necessary to transport transactions from the application, through the Datawire VXN, then to the FDMS payment processor and back.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_FDMSRegister Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 20 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (DPaymentsSDK_FDMSRegister Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 21 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (DPaymentsSDK_FDMSRegister Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 22 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 23 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 24 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 25 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (DPaymentsSDK_FDMSRegister Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 26 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (DPaymentsSDK_FDMSRegister Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 27 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (DPaymentsSDK_FDMSRegister Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 28 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 29 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (DPaymentsSDK_FDMSRegister Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 30 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 31 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 32 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (DPaymentsSDK_FDMSRegister Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 33 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (DPaymentsSDK_FDMSRegister Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 34 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (DPaymentsSDK_FDMSRegister Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 35 );
dpaymentssdk_fdmsregister_set($res, 35, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 36 );
dpaymentssdk_fdmsregister_set($res, 36, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (DPaymentsSDK_FDMSRegister Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 37 );
dpaymentssdk_fdmsregister_set($res, 37, $value );

Possible Values

FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
FDMSREGISTER_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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 property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 38 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_FDMSRegister Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 39 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (DPaymentsSDK_FDMSRegister Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 40 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (DPaymentsSDK_FDMSRegister Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 41 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (DPaymentsSDK_FDMSRegister Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 42 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (DPaymentsSDK_FDMSRegister Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 43 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (DPaymentsSDK_FDMSRegister Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 44 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (DPaymentsSDK_FDMSRegister Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 45 );
dpaymentssdk_fdmsregister_set($res, 45, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSRegister Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 46 );
dpaymentssdk_fdmsregister_set($res, 46, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (DPaymentsSDK_FDMSRegister Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 47 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (DPaymentsSDK_FDMSRegister Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 48 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (DPaymentsSDK_FDMSRegister Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 49 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 50 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 51 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 52 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (DPaymentsSDK_FDMSRegister Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 53 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (DPaymentsSDK_FDMSRegister Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 54 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (DPaymentsSDK_FDMSRegister Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 55 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 56 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (DPaymentsSDK_FDMSRegister Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 57 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 58 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 59 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (DPaymentsSDK_FDMSRegister Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 60 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (DPaymentsSDK_FDMSRegister Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 61 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (DPaymentsSDK_FDMSRegister Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 62 );
dpaymentssdk_fdmsregister_set($res, 62, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 63 );
dpaymentssdk_fdmsregister_set($res, 63, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_FDMSRegister Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 64 );
dpaymentssdk_fdmsregister_set($res, 64, $value );

Possible Values

FDMSREGISTER_SSLCERTSTORETYPE_USER(0), 
FDMSREGISTER_SSLCERTSTORETYPE_MACHINE(1), 
FDMSREGISTER_SSLCERTSTORETYPE_PFXFILE(2), 
FDMSREGISTER_SSLCERTSTORETYPE_PFXBLOB(3), 
FDMSREGISTER_SSLCERTSTORETYPE_JKSFILE(4), 
FDMSREGISTER_SSLCERTSTORETYPE_JKSBLOB(5), 
FDMSREGISTER_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
FDMSREGISTER_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
FDMSREGISTER_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
FDMSREGISTER_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
FDMSREGISTER_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
FDMSREGISTER_SSLCERTSTORETYPE_P7BFILE(11), 
FDMSREGISTER_SSLCERTSTORETYPE_P7BBLOB(12), 
FDMSREGISTER_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
FDMSREGISTER_SSLCERTSTORETYPE_PPKFILE(14), 
FDMSREGISTER_SSLCERTSTORETYPE_PPKBLOB(15), 
FDMSREGISTER_SSLCERTSTORETYPE_XMLFILE(16), 
FDMSREGISTER_SSLCERTSTORETYPE_XMLBLOB(17), 
FDMSREGISTER_SSLCERTSTORETYPE_JWKFILE(18), 
FDMSREGISTER_SSLCERTSTORETYPE_JWKBLOB(19), 
FDMSREGISTER_SSLCERTSTORETYPE_SECURITY_KEY(20), 
FDMSREGISTER_SSLCERTSTORETYPE_BCFKSFILE(21), 
FDMSREGISTER_SSLCERTSTORETYPE_BCFKSBLOB(22), 
FDMSREGISTER_SSLCERTSTORETYPE_PKCS11(23), 
FDMSREGISTER_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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 property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 65 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_FDMSRegister Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 66 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (DPaymentsSDK_FDMSRegister Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 67 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (DPaymentsSDK_FDMSRegister Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 68 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (DPaymentsSDK_FDMSRegister Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 69 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (DPaymentsSDK_FDMSRegister Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 70 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (DPaymentsSDK_FDMSRegister Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 71 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (DPaymentsSDK_FDMSRegister Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 72 );
dpaymentssdk_fdmsregister_set($res, 72, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (DPaymentsSDK_FDMSRegister Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 73 );
dpaymentssdk_fdmsregister_set($res, 73, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 74 );
dpaymentssdk_fdmsregister_set($res, 74, $value );

Possible Values

FDMSREGISTER_SSLPROVIDER_AUTOMATIC(0), 
FDMSREGISTER_SSLPROVIDER_PLATFORM(1), 
FDMSREGISTER_SSLPROVIDER_INTERNAL(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the 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:

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

SSLServerCertEffectiveDate Property (DPaymentsSDK_FDMSRegister Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 75 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (DPaymentsSDK_FDMSRegister Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 76 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (DPaymentsSDK_FDMSRegister Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 77 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 78 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 79 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 80 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (DPaymentsSDK_FDMSRegister Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 81 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (DPaymentsSDK_FDMSRegister Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 82 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (DPaymentsSDK_FDMSRegister Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 83 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 84 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (DPaymentsSDK_FDMSRegister Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 85 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 86 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 87 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (DPaymentsSDK_FDMSRegister Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 88 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (DPaymentsSDK_FDMSRegister Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 89 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (DPaymentsSDK_FDMSRegister Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 90 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 91 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (DPaymentsSDK_FDMSRegister Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 92 );

Possible Values

FDMSREGISTER_SSLSERVERCERTSTORETYPE_USER(0), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_MACHINE(1), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_PKCS11(23), 
FDMSREGISTER_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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 property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (DPaymentsSDK_FDMSRegister Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 93 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (DPaymentsSDK_FDMSRegister Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 94 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (DPaymentsSDK_FDMSRegister Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 95 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (DPaymentsSDK_FDMSRegister Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 96 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (DPaymentsSDK_FDMSRegister Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 97 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (DPaymentsSDK_FDMSRegister Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 98 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (DPaymentsSDK_FDMSRegister Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 99 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (DPaymentsSDK_FDMSRegister Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 100 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (DPaymentsSDK_FDMSRegister Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 101 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DPaymentsSDK_FDMSRegister Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 102 );
dpaymentssdk_fdmsregister_set($res, 102, $value );

Default Value

30

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

TransactionNumber Property (DPaymentsSDK_FDMSRegister Class)

Uniquely identifies the transaction.

Object Oriented Interface

public function getTransactionNumber();
public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 103 );
dpaymentssdk_fdmsregister_set($res, 103, $value );

Default Value

''

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

For all classs except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, and nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

Data Type

String

URL Property (DPaymentsSDK_FDMSRegister Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();
public function setURL($value);

Procedural Interface

dpaymentssdk_fdmsregister_get($res, 104 );
dpaymentssdk_fdmsregister_set($res, 104, $value );

Default Value

'https://support.datawire.net/production_expresso/SRS.do'

Remarks

This URL is used by the Register and Activate methods to provision the merchant. The following URLs are available for use:

For the Rapid Connect platform, URL will be populated after a successful ServiceDiscovery request.

Data Type

String

Activate Method (DPaymentsSDK_FDMSRegister Class)

Activates a merchant account on the Datawire VXN.

Object Oriented Interface

public function doActivate();

Procedural Interface

dpaymentssdk_fdmsregister_do_activate($res);

Remarks

After you have successfully registered, you will still not be able to send transactions using the Datawire VXN until you activate your account. For the security reasons, a merchant is required to activate within a limited time period after receiving a successful registration response. Otherwise, the Datawire VXN will deactivate the account and you will need to restart the registration process again.

North, Nashville, and Omaha:

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

Rapid Connect:

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

Config Method (DPaymentsSDK_FDMSRegister Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmsregister_do_config($res, $configurationstring);

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.

Interrupt Method (DPaymentsSDK_FDMSRegister Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmsregister_do_interrupt($res);

Remarks

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

Ping Method (DPaymentsSDK_FDMSRegister Class)

Used to find the fastest service provider to use to send credit card transactions.

Object Oriented Interface

public function doPing($url);

Procedural Interface

dpaymentssdk_fdmsregister_do_ping($res, $url);

Remarks

The Ping request is used to determine which one of the ServiceProviders URLs is the most efficient to use for transaction transport. The Ping request verifies that the ServiceProviders URLs are reachable and provides the average transaction time cost for each URL, returned in the PingResponseTime property. You should select the fastest ServiceProviders URL to be the active URL that you will use to process all transactions. You should maintain a list of the other ServiceProviders URLs in a queue from fastest to slowest, in the event that the fastest URL becomes unavailable.

A Ping should be sent for each of the ServiceProviders URLs after every 100 authorizations, to ensure that you're still using the fastest URL. A Ping should be run on the ServiceProviders URLs any time the application is first started.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

Note: This functionaly does not apply to Rapid Connect implementations.

Register Method (DPaymentsSDK_FDMSRegister Class)

Registers a merchant account on the Datawire VXN.

Object Oriented Interface

public function doRegister();

Procedural Interface

dpaymentssdk_fdmsregister_do_register($res);

Remarks

For the North, Nashville, and Omaha platforms: FDMS will supply you with a MerchantNumber, MerchantTerminalNumber, and Datawire will supply the URL to use to register your merchant. After setting the above properties, call the Register method. The Register method will send the registration request to Datawire, and will continue to poll the Datawire servers until a response is received. This may take several seconds, or even several minutes.

When the registration is complete, the registration response returns the merchant's DatawireId, and the PrimaryDiscoveryURL and SecondaryDiscoveryURL needed to perform ServiceDiscovery. Once received, these parameters must be saved permanently so that they can be reloaded and configured when necessary and are never lost due to power outages.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

For the Rapid Connect platform: ServiceDiscovery will need to be performed first. After a successful ServiceDiscovery call, URL will be populated with the URL required to provision your merchant account. Once TransactionNumber and ApplicationId are set, Register can be called. The Register method will send the registration request to Datawire, and will continue to poll the Datawire servers until a response is received. This may take several seconds, or even several minutes.

When the registration is complete, the registration response returns the merchant's DatawireId, and the PrimaryDiscoveryURL and SecondaryDiscoveryURL needed to process transactions. Once received, these parameters must be saved permanently so that they can be reloaded and configured when necessary and are never lost due to power outages.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

Reset Method (DPaymentsSDK_FDMSRegister Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsregister_do_reset($res);

Remarks

This method clears all properties to their default values.

ServiceDiscovery Method (DPaymentsSDK_FDMSRegister Class)

Retrieves transaction URLs from Datawire.

Object Oriented Interface

public function doServiceDiscovery($url);

Procedural Interface

dpaymentssdk_fdmsregister_do_servicediscovery($res, $url);

Remarks

Service Discovery is the means by which you retrieve the actual transaction URLs, used for making credit card authorizations and sending batch settlements.

For the North, Nashville, and Omaha platforms: The response to a successful call to the Register method will return a PrimaryDiscoveryURL and SecondaryDiscoveryURL. After the account has been activated, call the ServiceDiscovery method with either of these URLs as the URL parameter. A successful ServiceDiscovery will provide a list of Service Provider URL's necessary to transport transactions from the application through the Datawire VXN to the FDMS payment processor and back. This list of URL's returned will be stored in the ServiceProviders array property. You should Ping each of these URLs to determine which one has the shortest PingResponseTime, and use that URL for subsequent credit card transactions (note that you should re-Ping each of the URLs received in the ServiceProviders array every 100 transactions, and when first initializing your software).

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

For the Rapid Connect platform: ServiceDiscovery will be the first step in provisioning a merchant. FDMS will supply you with a MerchantNumber, MerchantTerminalNumber, and GroupId. After setting these properties, ServiceDiscovery should be called. The default URL, when URL parameter is set to "" (empty string), is "https://prod.dw.us.fdcnet.biz/sd/srsxml.rc". A successful ServiceDiscovery will provide the URL, accessible via URL, necessary to provision a merchant account.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

Connected Event (DPaymentsSDK_FDMSRegister Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

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

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 2, array($this, 'fireDataPacketIn'));

Parameter List

 'datapacket'

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

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 3, array($this, 'fireDataPacketOut'));

Parameter List

 'datapacket'

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

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_FDMSRegister Class)

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_fdmsregister_register_callback($res, 8, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (FDMSRegister Class)

FDMSRegister Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSRegister Class)

FDMSRegister Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors