FDMSSettle Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class dpaymentssdk.FDMSSettle

Remarks

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

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

Sending a Batch Settlement with this class is easy. First, you must register and activate your account with Datawire. Datawire will provide you with a merchant_number and merchant_terminal_number, but you'll need to use the FDMSRegister class to activate the merchant and receive a datawire_id. Once you acquire the datawire_id and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the merchant_number and merchant_terminal_number with the values supplied by FDMS and Datawire, and the datawire_id with the value retrieved by the FDMSRegister class after activating your merchant account. Set the url property with one of the URLs you retrieved during Service Discovery.

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

Additionally, set the industry_type and the batch_sequence_number.

FDMSSettle.IndustryType = fitDirectMarketing FDMSSettle.BatchSequenceNumber = "4127"

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

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

Finally, call the send_settlement method.

FDMSSettle.SendSettlement()

If the settlement is successful, the response_batch_status will contain "OK" and the response_batch_number will contain a number which can be used to identify the batch in the future. If the batch was not successful the class fails with an error that indicates the problem. If any individual record in the batch fails, information concerning that record will appear in the on_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 detail_record_aggregate property. However, it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.

To void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. If you wish to explicitly void the transaction, use the FDMSDetailRecord class to modify the transaction aggregate and set the TransactionType property to fttVoid. Credits and forced transactions may also be created using the FDMSDetailRecord class and settled in the same manner as regular transactions.

To add Level 2 and Level 3 data to the settled transactions, use the FDMSLevel2 and FDMSLevel3 classs to create addendum aggregates, and then add them to the detail_record_addendum for the corresponding transaction stored in detail_record_aggregate.

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

Property List

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

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.

api_version Property

Identifies the application version number.

Syntax

def get_api_version() -> str: ...
def set_api_version(value: str) -> None: ...

api_version = property(get_api_version, set_api_version)

Default Value

"016XX0"

Remarks

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

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

application_id Property

Identifies the merchant application to the Datawire System.

Syntax

def get_application_id() -> str: ...
def set_application_id(value: str) -> None: ...

application_id = property(get_application_id, set_application_id)

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 merchant_terminal_number and datawire_id as connection credentials.

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

batch_sequence_number Property

Starting sequence number for the transactions in this batch.

Syntax

def get_batch_sequence_number() -> str: ...
def set_batch_sequence_number(value: str) -> None: ...

batch_sequence_number = property(get_batch_sequence_number, set_batch_sequence_number)

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

datawire_id Property

Identifies the merchant to the Datawire System.

Syntax

def get_datawire_id() -> str: ...
def set_datawire_id(value: str) -> None: ...

datawire_id = property(get_datawire_id, set_datawire_id)

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.

detail_record_count Property

The number of records in the DetailRecord arrays.

Syntax

def get_detail_record_count() -> int: ...
def set_detail_record_count(value: int) -> None: ...

detail_record_count = property(get_detail_record_count, set_detail_record_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• detail_record_addendum
• detail_record_aggregate

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

detail_record_addendum Property

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

Syntax

def get_detail_record_addendum(detail_record_index: int) -> str: ...
def set_detail_record_addendum(detail_record_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

For example:

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

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

The detail_record_index parameter specifies the index of the item in the array. The size of the array is controlled by the detail_record_count property.

detail_record_aggregate Property

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

Syntax

def get_detail_record_aggregate(detail_record_index: int) -> str: ...
def set_detail_record_aggregate(detail_record_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

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

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

For example, to add a gratuity to a charge:

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

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

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

The detail_record_index parameter specifies the index of the item in the array. The size of the array is controlled by the detail_record_count property.

fdms_platform Property

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

Syntax

def get_fdms_platform() -> int: ...
def set_fdms_platform(value: int) -> None: ...

fdms_platform = property(get_fdms_platform, set_fdms_platform)

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.

industry_type Property

Code which indicates the industry the merchant is engaged in.

Syntax

def get_industry_type() -> int: ...
def set_industry_type(value: int) -> None: ...

industry_type = property(get_industry_type, set_industry_type)

Default Value

1

Remarks

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

merchant_number Property

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

Syntax

def get_merchant_number() -> str: ...
def set_merchant_number(value: str) -> None: ...

merchant_number = property(get_merchant_number, set_merchant_number)

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 merchant_terminal_number and datawire_id as connection credentials.

merchant_service_number Property

Merchant's customer service phone number.

Syntax

def get_merchant_service_number() -> str: ...
def set_merchant_service_number(value: str) -> None: ...

merchant_service_number = property(get_merchant_service_number, set_merchant_service_number)

Default Value

""

Remarks

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

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

merchant_terminal_number Property

Used to identify a unique terminal within a merchant location.

Syntax

def get_merchant_terminal_number() -> str: ...
def set_merchant_terminal_number(value: str) -> None: ...

merchant_terminal_number = property(get_merchant_terminal_number, set_merchant_terminal_number)

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 merchant_number and datawire_id as connection credentials.

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

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 proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

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.

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

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

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

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:

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

response_batch_number Property

FDMS-generated Id of the batch settlement.

Syntax

def get_response_batch_number() -> str: ...

response_batch_number = property(get_response_batch_number, None)

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.

response_batch_status Property

Indicates success or failure of the entire settlement.

Syntax

def get_response_batch_status() -> str: ...

response_batch_status = property(get_response_batch_status, None)

Default Value

""

Remarks

Indicates success or failure of the entire settlement.

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

This property is read-only.

response_datawire_return_code Property

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

Syntax

def get_response_datawire_return_code() -> str: ...

response_datawire_return_code = property(get_response_datawire_return_code, None)

Default Value

""

Remarks

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

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the response_datawire_status will be "OK" and the response_datawire_return_code 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 response_capture_flag and response_approval_code properties contain the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

response_datawire_status Property

Status of the communication with Datawire.

Syntax

def get_response_datawire_status() -> str: ...

response_datawire_status = property(get_response_datawire_status, None)

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 response_datawire_status will be "OK" and the response_datawire_return_code 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 response_capture_flag and response_approval_code properties contains the actual FDMS Transaction Result that was returned.

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

This property is read-only.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

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:

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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

url Property

Location of the Datawire server to which transactions are sent.

Syntax

def get_url() -> str: ...
def set_url(value: str) -> None: ...

url = property(get_url, set_url)

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.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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

Interrupts the current action.

Syntax

def interrupt() -> None: ...

Remarks

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

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

send_settlement Method

Begins a Batch Settlement transaction with the transaction server.

Syntax

def send_settlement() -> None: ...

Remarks

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

on_connected Event

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

Syntax

class FDMSSettleConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class FDMSSettle:
@property
def on_connected() -> Callable[[FDMSSettleConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[FDMSSettleConnectedEventParams], None]) -> None: ...

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.

on_data_packet_in Event

Fired when receiving a data packet from the transaction server.

Syntax

class FDMSSettleDataPacketInEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class FDMSSettle:
@property
def on_data_packet_in() -> Callable[[FDMSSettleDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[FDMSSettleDataPacketInEventParams], None]) -> None: ...

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.

on_data_packet_out Event

Fired when sending a data packet to the transaction server.

Syntax

class FDMSSettleDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class FDMSSettle:
@property
def on_data_packet_out() -> Callable[[FDMSSettleDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[FDMSSettleDataPacketOutEventParams], None]) -> None: ...

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.

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class FDMSSettleDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class FDMSSettle:
@property
def on_disconnected() -> Callable[[FDMSSettleDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[FDMSSettleDisconnectedEventParams], None]) -> None: ...

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.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class FDMSSettleErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class FDMSSettle:
@property
def on_error() -> Callable[[FDMSSettleErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FDMSSettleErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class FDMSSettleSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class FDMSSettle:
@property
def on_ssl_server_authentication() -> Callable[[FDMSSettleSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FDMSSettleSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class FDMSSettleSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class FDMSSettle:
@property
def on_ssl_status() -> Callable[[FDMSSettleSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[FDMSSettleSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_status Event

Shows the progress of the FDMS/Datawire connection.

Syntax

class FDMSSettleStatusEventParams(object):
  @property
  def message() -> str: ...

# In class FDMSSettle:
@property
def on_status() -> Callable[[FDMSSettleStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[FDMSSettleStatusEventParams], None]) -> None: ...

Remarks

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

FDMSSettle Config Settings

FDMSSettle Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

FDMSSettle Errors

FDMSSettle 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