FDMSECommerce Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSECommerce class is an advanced tool used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This class makes authorizing these types of transactions very easy.

Syntax

class dpaymentssdk.FDMSECommerce

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 FDMSECommerce class makes authorizing Card-Not-Present Mail Order and E-Commerce transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

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.

FDMSECommerce.MerchantNumber = "000000999990" 'Supplied by FDMS/Datawire FDMSECommerce.MerchantTerminalNumber = "555555" 'Supplied by FDMS/Datawire FDMSECommerce.DatawireId = "0000B47FFFFFFFFFFFFF" 'Retrieved with the FDMSRegister class.

Then, set the customer's address and zip code (The address and zip code will be checked by the FDMS processor to make sure it matches the customer's billing address).

FDMSECommerce.CustomerAddress = "123 Nowhere Ln." FDMSECommerce.CustomerZip = "90210"

Next, set properties that contain details about the transaction. The transaction_number should be incremented for every transaction you authorize. The transaction_amount must be set, and it should contain the amount to be charged, with an implied decimal point (ie: $1.00 is "100"). The transaction_type is dependent on whether the transaction is taking place over the phone, the Internet, or whether it's a Recurring or Installment payment.

FDMSECommerce.TransactionNumber = 1 FDMSECommerce.TransactionAmount = "100" FDMSECommerce.TransactionType = ttECommerce

Finally, submit the transaction by calling the authorize method. When the class receives a response, the result of the authorization will be available in several Response properties. The response_datawire_status and response_datawire_return_code indicate whether any errors occurred while passing the transaction through the Datawire VXN system. These two properties alone do not indicate a successful transaction, they only tell whether or not there were any problems transporting the authorization request and response through the Datawire system. If the transaction was successfully authorized by FDMS, then the response_capture_flag will be True, and the response_approval_code will contain an approval code that beings with "AP". (or "AL" for classs that support partially-approved/split-tender transactions).

FDMSECommerce.Authorize("4444333322221111", 9, 2020, "999");

In addition, the response_avs_result property will indicate whether the customer's billing address on file with his credit card company matches the information presented in the customer_address and customer_zip properties. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the get_detail_aggregate method to the FDMSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

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.

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.

card_type Property

Type of credit card being used in this transaction.

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the card_number is set, but it can also be changed manually. A list of valid card types is included below.

card_cvv_data Property

Three digit security code on back of card (optional).

Syntax

def get_card_cvv_data() -> str: ...
def set_card_cvv_data(value: str) -> None: ...

card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the card_cvv_data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, card_cvv_presence will be automatically set to cvpProvided. If set to empty string (""), card_cvv_presence will be automatically set to cvpNotProvided.

card_cvv_presence Property

Indicates the presence of the card verification value.

Syntax

def get_card_cvv_presence() -> int: ...
def set_card_cvv_presence(value: int) -> None: ...

card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of card_cvv_data.

The class will automatically set this value to cvpProvided when a card_cvv_data value is specified. You can explicitly specify the card_cvv_presence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

card_entry_data_source Property

This property contains a 1-character code identifying the source of the customer data.

Syntax

def get_card_entry_data_source() -> int: ...
def set_card_entry_data_source(value: int) -> None: ...

card_entry_data_source = property(get_card_entry_data_source, set_card_entry_data_source)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

card_exp_month Property

Expiration month of the credit card specified in Number .

Syntax

def get_card_exp_month() -> int: ...
def set_card_exp_month(value: int) -> None: ...

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

1

Remarks

Expiration month of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

card_exp_year Property

Expiration year of the credit card specified in Number .

Syntax

def get_card_exp_year() -> int: ...
def set_card_exp_year(value: int) -> None: ...

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

2000

Remarks

Expiration year of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

card_is_encrypted Property

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

def get_card_is_encrypted() -> bool: ...
def set_card_is_encrypted(value: bool) -> None: ...

card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)

Default Value

FALSE

Remarks

Determines whether data set to the card_number or card_magnetic_stripe fields is validated.

By default, when the card_number or card_magnetic_stripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and card_magnetic_stripe data will be parsed for the track specified by card_entry_data_source. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the card_number or card_magnetic_stripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the card_type may be affected, and the card number will not be verified.

card_magnetic_stripe Property

Track data read off of the card's magnetic stripe.

Syntax

def get_card_magnetic_stripe() -> str: ...
def set_card_magnetic_stripe(value: str) -> None: ...

card_magnetic_stripe = property(get_card_magnetic_stripe, set_card_magnetic_stripe)

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If card_entry_data_source is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the card_entry_data_source property to indicate which track you are sending.

The following example shows how to set the card_magnetic_stripe and card_entry_data_source properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

card_number Property

Customer's credit card number for the transaction.

Syntax

def get_card_number() -> str: ...
def set_card_number(value: str) -> None: ...

card_number = property(get_card_number, set_card_number)

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with card_magnetic_stripe data, this property should be left empty.

customer_address Property

The customer's billing address.

Syntax

def get_customer_address() -> str: ...
def set_customer_address(value: str) -> None: ...

customer_address = property(get_customer_address, set_customer_address)

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the customer_zip property.

The maximum length of this property is 20 characters.

If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

customer_zip Property

Customer's zip code (or postal code if outside of the USA).

Syntax

def get_customer_zip() -> str: ...
def set_customer_zip(value: str) -> None: ...

customer_zip = property(get_customer_zip, set_customer_zip)

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

The maximum length of this property is 10 characters.

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.

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

The merchant's industry type.

Syntax

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

industry_type = property(get_industry_type, set_industry_type)

Default Value

0

Remarks

The merchant's industry type. Possible values are:

NOTE: transaction_type of dmtMOTO(1) cannot be used in feitEcommerce(0) industry_type. Likewise transaction_type of dmtECommerce(0) cannot be used in feitMOTO(1) industry_type.

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

purchase_identifier Property

Optional purchase order number assigned by the merchant.

Syntax

def get_purchase_identifier() -> str: ...
def set_purchase_identifier(value: str) -> None: ...

purchase_identifier = property(get_purchase_identifier, set_purchase_identifier)

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and will be automatically left-justified, space-filled to 25 spaces. For American Express transactions, only use the first 9 spaces.

response_approval_code Property

Contains an authorization code when a transaction has been approved, or an error message if declined.

Syntax

def get_response_approval_code() -> str: ...

response_approval_code = property(get_response_approval_code, None)

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved, or an error message if declined.

This property contains an authorization code when a transaction has been approved. The code will begin with "AP" and will be 8 characters in length. If the transaction was partially approved, it will begin with "AL" (approved for lesser amount), and the actual amount approved will be contained in the response_authorized_amount property. If the transaction was declined response_approval_code will contain one of the response messages listed in the table below:

This property is read-only.

response_authorized_amount Property

When supporting partial authorizations, this is the amount actually charged to the credit card.

Syntax

def get_response_authorized_amount() -> str: ...

response_authorized_amount = property(get_response_authorized_amount, None)

Default Value

""

Remarks

When supporting partial authorizations, this is the amount actually charged to the credit card.

This is only used when supporting partial authorizations (currently only supported for healthcare transactions). If the response_approval_code begins with "AL" this property will contain the amount actually charged to the credit card. This will be less than the original TransactionAmount. You must collect the remainder via another form of payment, or Reverse the authorization if the customer does not have an additional form of payment.

This property is read-only.

response_avs_result Property

Contains the Address Verification System result code.

Syntax

def get_response_avs_result() -> str: ...

response_avs_result = property(get_response_avs_result, None)

Default Value

""

Remarks

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below.

Valid AVS Codes:

If supporting international transactions, four additional International Address Verification Service (IAVS) codes are introduced:

This property is read-only.

response_balance Property

Contains the remaining available balance left on the card.

Syntax

def get_response_balance() -> str: ...

response_balance = property(get_response_balance, None)

Default Value

""

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

This property is read-only.

response_capture_flag Property

Indicates whether the authorization was successful, and whether it can be settled.

Syntax

def get_response_capture_flag() -> bool: ...

response_capture_flag = property(get_response_capture_flag, None)

Default Value

FALSE

Remarks

Indicates whether the authorization was successful, and whether it can be settled.

After an authorization request, the response_capture_flag will be set to True if the request was successfully processed. This indicates that you may send the transaction on for batch settlement using the FDMSSettle class. If this property is False you should consider the transaction as Declined, and it may not be settled.

This property is read-only.

response_card_level_result Property

Two character card level results property returned in the response to Visa authorizations.

Syntax

def get_response_card_level_result() -> str: ...

response_card_level_result = property(get_response_card_level_result, None)

Default Value

""

Remarks

Two character card level results field returned in the response to Visa authorizations.

This property is read-only.

response_commercial_card Property

Indicates whether the credit card charged is a corporate commercial card.

Syntax

def get_response_commercial_card() -> int: ...

response_commercial_card = property(get_response_commercial_card, None)

Default Value

0

Remarks

Indicates whether the credit card charged is a corporate commercial card.

Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data in the settlement when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Commercial card transactions settled with Level 2 or Level 3 data must include tax amounts to receive the best interchange rate.

This property is read-only.

response_cvv_result Property

Contains the returned CVV result code (if CVV data was sent in the request).

Syntax

def get_response_cvv_result() -> str: ...

response_cvv_result = property(get_response_cvv_result, None)

Default Value

""

Remarks

Contains the returned CVV result code (if CVV data was sent in the request).

If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. The following is a list of current result codes:

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.

response_returned_aci Property

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

def get_response_returned_aci() -> str: ...

response_returned_aci = property(get_response_returned_aci, None)

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the response_transaction_id or response_validation_code fields.

The following is a list of all returned ACI values. Please note that many of these return values result from features not available in any of the currently supported Industry Types.

This property is read-only.

response_transaction_date Property

Local transaction date returned from the server in MMDDYY format.

Syntax

def get_response_transaction_date() -> str: ...

response_transaction_date = property(get_response_transaction_date, None)

Default Value

""

Remarks

Local transaction date returned from the server in MMDDYY format.

This six digit field contains a local transaction date calculated by the authorization center. This field should be recorded and submitted in the Batch Settlement.

This property is read-only.

response_transaction_id Property

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

def get_response_transaction_id() -> str: ...

response_transaction_id = property(get_response_transaction_id, None)

Default Value

""

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

This property is read-only.

response_validation_code Property

Additional information generated by the card issuer.

Syntax

def get_response_validation_code() -> str: ...

response_validation_code = property(get_response_validation_code, None)

Default Value

""

Remarks

Additional information generated by the card issuer.

This four character field may contain specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.

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

tppid Property

Third Party Processor Identifier assigned by FDMS.

Syntax

def get_tppid() -> str: ...
def set_tppid(value: str) -> None: ...

tppid = property(get_tppid, set_tppid)

Default Value

"V4D001"

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 his own TPPID from FDMS. If there are multiple third parties involved in the transaction flow, additional TPPID's are required. These may be added by setting the tppid property with a comma-delimited list. The first entry should always be the servicer that sends the transaction to FDMS. Each subsequent servicer should be identified where they are in the chain. There can be a maximum of three entries in this list.

The default value for 4D Payments, Inc. on the North and Nashville platforms is "V4D001".

Note: This value will be reset to the default value when fdms_platform is set.

A visa_identifier is also required for Visa transactions.

transaction_amount Property

Purchase amount to be authorized.

Syntax

def get_transaction_amount() -> str: ...
def set_transaction_amount(value: str) -> None: ...

transaction_amount = property(get_transaction_amount, set_transaction_amount)

Default Value

""

Remarks

This property contains the transaction amount to be authorized.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

transaction_number Property

Uniquely identifies the transaction.

Syntax

def get_transaction_number() -> str: ...
def set_transaction_number(value: str) -> None: ...

transaction_number = property(get_transaction_number, set_transaction_number)

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.

transaction_type Property

Specifies the type of transaction to process.

Syntax

def get_transaction_type() -> int: ...
def set_transaction_type(value: int) -> None: ...

transaction_type = property(get_transaction_type, set_transaction_type)

Default Value

0

Remarks

The following types of transactions are supported by this class:

All of these transactions are card-not-present transactions. If you wish to authorize card-present transactions, you must use the FDMSRetail class.

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

NOTE: For Recurring and Installment transactions you need to set the SubmissionType configuration setting to indicate if this is a first or subsequent submission.

NOTE: transaction_types of dmtECommerce(0) and dmtMOTO(1) should match the industry_type accordingly.

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.

visa_identifier Property

Additional merchant identification field used when authorizing Visa transactions.

Syntax

def get_visa_identifier() -> str: ...
def set_visa_identifier(value: str) -> None: ...

visa_identifier = property(get_visa_identifier, set_visa_identifier)

Default Value

""

Remarks

In conjunction with Visa regulatory change(s), First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). Each 19-byte Visa Agent Identifier in the chain is composed of the following pieces:

A VisaIdentifier (Agent Identification Service - AUAR) is required for Visa transactions. A VisaIdentifier value is assigned by Visa as part of their Trusted Agent Program (TAP). Therefore it is suggested that you contact your FDMS certification analyst as they should be able to provide you with further information and put you in contact with the required party at Visa. Unfortunately more specific information on this matter cannot be provided as we do not handle live customer data and thus are not required to register in this particular program. However below is some additional information in regards to the requirements of a Visa Identifier.

Any merchant that transmits, processes, or stores cardholder data on server(s) that you own, manage, or operate on behalf of your clients (who are other merchant account holders) must meet the PCI Data Security Standard and follow additional steps to register as a service provider. Applicable services commonly include webhosting, software as a service, or collecting payment on behalf of a client. Any company providing these services must register with Visa's Third Party Agent (TAP) program.

You can register for the Visa Third Party Agent Program at http://usa.visa.com/merchants/risk_management/third-party-registration.html

If you find that you are not required to register with this program you can send the following value for VisaIdentifier: 0B 000000000000

authorize Method

Sends an authorization request.

Syntax

def authorize() -> None: ...

Remarks

This method sends an authorization request to the Datawire System, which will forward the request on to the FDMS processor. If the authorization request was successful, the response_capture_flag property will be True, and the response_approval_code will contain an approval code.

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement class. For example:

FDMSEcommerce.CardNumber = "4444333322221111" FDMSEcommerce.ExpMonth = 12 FDMSEcommerce.ExpYear = 2015 FDMSECommerce.Authorize() If (FDMSECommerce.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate[0] = FDMSECommerce.GetDetailAggregate() End If

Important Note: You must ping your list of service provider URLs and update the url property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's service_discovery method).

avs_and_cvv_only Method

Performs an AVS/CVV only check using the specified Card data.

Syntax

def avs_and_cvv_only() -> None: ...

Remarks

This methods allows you to perform an AVS/CVV only request for verification purposes using the specified card data. This does not authorize any funds on the card and only performs an AVS and CVV check. The transaction_amount must be 0 for this transaction.

FDMSECommerce.CardNumber = "4444333322221111" FDMSECommerce.CardExpMonth = 9 FDMSECommerce.CardExpYear = 2015 FDMSECommerce.CardCVVData = "999" FDMSECommerce.CustomerAddress = "123 Nowhere Ln" FDMSECommerce.CustomerZip = "90210" FDMSECommerce.TransactionAmount = "0" FDMSECommerce.AVSAndCVVOnly()

balance_inquiry Method

Performs a Balance Inquiry Request using the specified Card data.

Syntax

def balance_inquiry() -> None: ...

Remarks

This methods allows you to perform a Balance Inquiry Request using the specified card data. The balance amount will be returned via response_balance. Note that Balance Inquiries do not place a hold on a cardholder's funds and are not captured.

FDMSECommerce.CardNumber = "4444333322221111" FDMSECommerce.CardExpMonth = 9 FDMSECommerce.CardExpYear = 2015 FDMSECommerce.BalanceInquiry()

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.

get_detail_aggregate Method

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

def get_detail_aggregate() -> str: ...

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the response_capture_flag is false) the method fails with an error.

An example of how this method is used is shown below:

FDMSRetail.AuthorizeTrack1() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1 FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate() End If

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.

on_connected Event

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

Syntax

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

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

# In class FDMSECommerce:
@property
def on_connected() -> Callable[[FDMSECommerceConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[FDMSECommerceConnectedEventParams], 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 FDMSECommerceDataPacketInEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class FDMSECommerce:
@property
def on_data_packet_in() -> Callable[[FDMSECommerceDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[FDMSECommerceDataPacketInEventParams], 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 FDMSECommerceDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class FDMSECommerce:
@property
def on_data_packet_out() -> Callable[[FDMSECommerceDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[FDMSECommerceDataPacketOutEventParams], 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 FDMSECommerceDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class FDMSECommerce:
@property
def on_disconnected() -> Callable[[FDMSECommerceDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[FDMSECommerceDisconnectedEventParams], 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 FDMSECommerceErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class FDMSECommerce:
@property
def on_error() -> Callable[[FDMSECommerceErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FDMSECommerceErrorEventParams], 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 FDMSECommerceSSLServerAuthenticationEventParams(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 FDMSECommerce:
@property
def on_ssl_server_authentication() -> Callable[[FDMSECommerceSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FDMSECommerceSSLServerAuthenticationEventParams], 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 FDMSECommerceSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class FDMSECommerce:
@property
def on_ssl_status() -> Callable[[FDMSECommerceSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[FDMSECommerceSSLStatusEventParams], 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 FDMSECommerceStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

FDMSECommerce Config Settings

FDMSECommerce 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

FDMSECommerce Errors

FDMSECommerce 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