FDMSRcSettle Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DPaymentsSDK_FDMSRcSettle

Procedural Interface

 dpaymentssdk_fdmsrcsettle_open();
 dpaymentssdk_fdmsrcsettle_close($res);
 dpaymentssdk_fdmsrcsettle_register_callback($res, $id, $function);
 dpaymentssdk_fdmsrcsettle_get_last_error($res);
 dpaymentssdk_fdmsrcsettle_get_last_error_code($res);
 dpaymentssdk_fdmsrcsettle_set($res, $id, $index, $value);
 dpaymentssdk_fdmsrcsettle_get($res, $id, $index);
 dpaymentssdk_fdmsrcsettle_do_config($res, $configurationstring);
 dpaymentssdk_fdmsrcsettle_do_interrupt($res);
 dpaymentssdk_fdmsrcsettle_do_reset($res);
 dpaymentssdk_fdmsrcsettle_do_sendsettlement($res);

Remarks

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

The FDMSRcSettle class is used to settle all transactions previously authorized by the FDMSRcECommerce or FDMSRcRetail class. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the FDMSRcSettle class the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.

Sending a Batch Settlement with this component is easy. First, you must register and activate your account with Datawire. FDMS Rapid Connect will provide you with a MerchantId, MerchantTerminalNumber, and GroupId but you'll need to use the FDMSRegister class to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through ServiceDiscovery, you may begin to authorize transactions.

To authorize a credit, debit, ebt, or FSA/HSA card set the TPPID, MerchantId, MerchantTerminalNumber, and GroupId properties with the values supplied by FDMS Rapid Connect. Set the DatawireId property with the value retrieved by the FDMSRegister class after activating your merchant account. Set the URL property with one of the URLs you retrieved during ServiceDiscovery.

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

Additionally, set the IndustryType, BatchSequenceNumber, and BatchTicketNumber.

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

At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailRecordAggregate array property. First set the DetailRecordCount to the total number of transactions you wish to settle. Each index in the DetailRecordAggregate array property must be set with the XML aggregate returned from the FDMSRcRetail, FDMSRcECommerce, or FDMSRcDetailrecord class's GetDetailAggregate method.

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

Finally, call the SendSettlement method.

FDMSRcSettle.SendSettlement()

If the settlement is successful, the ResponseText will contain "APPROVAL", the ResponseCode will contain "000", and the ResponseBatchId will contain a number (FDMS-generated Id) which can be used to identify the batch in the future. If the batch was not successful the class fails with an error that indicates the problem. If any individual record in the batch fails, information concerning that record will appear in the Error event when the response to that particular record is received.

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

To void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. Refunds and Forced/Voice Approved transactions may also be created using the FDMSRcDetailrecord class and settled in the same manner as regular transactions.

Note that the IndustryType from the FDMSRcSettle class MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.

Property List

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

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

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();


public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 1 );


dpaymentssdk_fdmsrcsettle_set($res, 1, $value );

Default Value

'NSOFTDIRECTPXML'

Remarks

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

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

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

Data Type

String

BatchSequenceNumber Property (DPaymentsSDK_FDMSRcSettle Class)

Starting sequence number for the transactions in this batch.

Object Oriented Interface

public function getBatchSequenceNumber();


public function setBatchSequenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 2 );


dpaymentssdk_fdmsrcsettle_set($res, 2, $value );

Default Value

''

Remarks

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

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

Data Type

String

BatchTicketNumber Property (DPaymentsSDK_FDMSRcSettle Class)

The merchant assigned Batch Ticket Number.

Object Oriented Interface

public function getBatchTicketNumber();


public function setBatchTicketNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 3 );


dpaymentssdk_fdmsrcsettle_set($res, 3, $value );

Default Value

''

Remarks

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

The value may be up to 10 alphanumeric characters.

Data Type

String

CloseBatchSTAN Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getCloseBatchSTAN();


public function setCloseBatchSTAN($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 4 );


dpaymentssdk_fdmsrcsettle_set($res, 4, $value );

Default Value

''

Remarks

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

Valid values are from 000001 to 999999 inclusive.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSRcSettle Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();


public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 5 );


dpaymentssdk_fdmsrcsettle_set($res, 5, $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

DetailRecordCount Property (DPaymentsSDK_FDMSRcSettle Class)

The number of records in the DetailRecord arrays.

Object Oriented Interface

public function getDetailRecordCount();


public function setDetailRecordCount($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 6 );


dpaymentssdk_fdmsrcsettle_set($res, 6, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DetailRecordAggregate

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

This property is not available at design time.

Data Type

Integer

DetailRecordAggregate Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getDetailRecordAggregate($detailrecordindex);


public function setDetailRecordAggregate($detailrecordindex, $value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 7 , $detailrecordindex);


dpaymentssdk_fdmsrcsettle_set($res, 7, $value , $detailrecordindex);

Default Value

''

Remarks

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

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the FDMSRcECommerce, FDMSRcRetail, FDMSRcHealthCare, FDMSRcBenefit, FDMSRcDebit, or FDMSRcDetailrecord class's GetDetailAggregate method. For instance:

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

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

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

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()

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

This property is not available at design time.

Data Type

String

GroupId Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getGroupId();


public function setGroupId($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 8 );


dpaymentssdk_fdmsrcsettle_set($res, 8, $value );

Default Value

''

Remarks

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

Data Type

String

IndustryType Property (DPaymentsSDK_FDMSRcSettle Class)

The merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 9 );


dpaymentssdk_fdmsrcsettle_set($res, 9, $value );

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Data Type

Integer

MerchantId Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getMerchantId();


public function setMerchantId($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 10 );


dpaymentssdk_fdmsrcsettle_set($res, 10, $value );

Default Value

''

Remarks

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

This property is required.

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_FDMSRcSettle Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();


public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 11 );


dpaymentssdk_fdmsrcsettle_set($res, 11, $value );

Default Value

''

Remarks

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

This property is required.

Data Type

String

OpenBatchSTAN Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getOpenBatchSTAN();


public function setOpenBatchSTAN($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 12 );


dpaymentssdk_fdmsrcsettle_set($res, 12, $value );

Default Value

''

Remarks

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

Valid values are from 000001 to 999999 inclusive.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 13 );


dpaymentssdk_fdmsrcsettle_set($res, 13, $value );

Default Value

0

Remarks

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

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

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

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

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the 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_FDMSRcSettle Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 14 );


dpaymentssdk_fdmsrcsettle_set($res, 14, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 15 );


dpaymentssdk_fdmsrcsettle_set($res, 15, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSRcSettle Class)

This property contains 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_fdmsrcsettle_get($res, 16 );


dpaymentssdk_fdmsrcsettle_set($res, 16, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSRcSettle 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_fdmsrcsettle_get($res, 17 );


dpaymentssdk_fdmsrcsettle_set($res, 17, $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_FDMSRcSettle Class)

This property determines 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_fdmsrcsettle_get($res, 18 );


dpaymentssdk_fdmsrcsettle_set($res, 18, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 19 );


dpaymentssdk_fdmsrcsettle_set($res, 19, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ResponseBatchId Property (DPaymentsSDK_FDMSRcSettle Class)

FDMS-generated Id of the batch settlement.

Object Oriented Interface

public function getResponseBatchId();

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 20 );

Default Value

'0'

Remarks

FDMS-generated Id of the batch settlement.

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

This property is read-only.

Data Type

String

ResponseCode Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 21 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getResponseDatawireReturnCode();

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 22 );

Default Value

''

Remarks

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

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

The ResponseApprovalCode contains the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (DPaymentsSDK_FDMSRcSettle Class)

Status of the communication with Datawire.

Object Oriented Interface

public function getResponseDatawireStatus();

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 23 );

Default Value

''

Remarks

Status of the communication with Datawire.

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

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

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

This property is read-only.

Data Type

String

ResponseText Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 24 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSRcSettle Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 26 );


dpaymentssdk_fdmsrcsettle_set($res, 26, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_FDMSRcSettle Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 54 );


dpaymentssdk_fdmsrcsettle_set($res, 54, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 70 );


dpaymentssdk_fdmsrcsettle_set($res, 70, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_FDMSRcSettle 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_fdmsrcsettle_get($res, 71 );


dpaymentssdk_fdmsrcsettle_set($res, 71, $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_FDMSRcSettle Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 72 );


dpaymentssdk_fdmsrcsettle_set($res, 72, $value );

Default Value

0

Remarks

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

SSLCertSubject Property (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 73 );


dpaymentssdk_fdmsrcsettle_set($res, 73, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DPaymentsSDK_FDMSRcSettle Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 81 );


dpaymentssdk_fdmsrcsettle_set($res, 81, $value );

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:

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

SSLServerCertEncoded Property (DPaymentsSDK_FDMSRcSettle Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 83 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DPaymentsSDK_FDMSRcSettle Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 110 );


dpaymentssdk_fdmsrcsettle_set($res, 110, $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

TPPID Property (DPaymentsSDK_FDMSRcSettle Class)

Third Party Processor Identifier assigned by FDMS.

Object Oriented Interface

public function getTPPID();


public function setTPPID($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 111 );


dpaymentssdk_fdmsrcsettle_set($res, 111, $value );

Default Value

''

Remarks

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

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

A VisaIdentifier is also required for Visa transactions.

Data Type

String

URL Property (DPaymentsSDK_FDMSRcSettle Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

dpaymentssdk_fdmsrcsettle_get($res, 112 );


dpaymentssdk_fdmsrcsettle_set($res, 112, $value );

Default Value

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

Remarks

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

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

Data Type

String

Config Method (DPaymentsSDK_FDMSRcSettle Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmsrcsettle_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_FDMSRcSettle Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsrcsettle_do_reset($res);

Remarks

This method clears all properties to their default values.

SendSettlement Method (DPaymentsSDK_FDMSRcSettle Class)

Begins a Batch Settlement transaction with the transaction server.

Object Oriented Interface

public function doSendSettlement();

Procedural Interface

dpaymentssdk_fdmsrcsettle_do_sendsettlement($res);

Remarks

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

Connected Event (DPaymentsSDK_FDMSRcSettle Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

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

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

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

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_fdmsrcsettle_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 (FDMSRcSettle Class)

FDMSRcSettle Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSRcSettle Class)

FDMSRcSettle 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