FDMSRcDebit Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcDebit class is an advanced tool used to authorize debit cards in a Retail environment, where the customer is purchasing products or services in person. This class makes authorizing debit card transactions with a customer PIN very easy.

Syntax

class dpaymentssdk.FDMSRcDebit

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 FDMSRcDebit class makes authorizing debit transactions (where the customer is present and inputs his/her PIN number) 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 sending transactions are outlined below:

Datawire Setup

First, you must register and activate your account with Datawire. FDMS Rapid Connect will provide you with the following values:

• merchant_id
• merchant_terminal_number
• group_id

The FDMSRegister class must be used 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. For instance:

 
 Copy
FDMSRegister.FDMSPlatform = FdmsregisterFDMSPlatforms.fpRapidConnect;
FDMSRegister.MerchantNumber = "000000999990";
FDMSRegister.MerchantTerminalNumber = "555555";
FDMSRegister.Config("GroupId=20001"); //Required for Rapid Connect

FDMSRegister.TransactionNumber = "1"; //any unique number will do.
FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do";
FDMSRegister.Register(); 
FDMSRegister.TransactionNumber = FDMSRegister.TransactionNumber + 1;
FDMSRegister.Activate();
FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL);
for (int i = 0; i < FDMSRegister.ServiceProviders.Length; i++) {
  FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]);
  Console.WriteLine(FDMSRegister.ServiceProviders[i] + " = " + FDMSRegister.PingResponseTime);
}

To authorize a credit, debit, ebt or FSA/HSA card set the merchant_id, merchant_terminal_number, and group_id properties with the values supplied by FDMS Rapid Connect. Set the datawire_id property with the value retrieved by the FDMSRegister class after activating your merchant account. Set the url property with one of the URLs you retrieved during service_discovery.

Transaction Processing

To begin processing transactions first set the required merchant values. For instance:

 
 Copy
debit.TPPID = "AAA000";
debit.MerchantTerminalNumber = "00000001";
debit.MerchantId = "1234";
debit.GroupId = "20001";
debit.DatawireId = "00011122233344455566";
debit.ApplicationId = "RAPIDCONNECTVXN";
debit.URL = "https://stg.dw.us.fdcnet.biz/rc";

Next specify transaction specific information. These values uniquely identify the transaction to Datawire and FDMS.

 
 Copy
debit.STAN = "112";
debit.TransactionNumber = "1234";
debit.ReferenceNumber = "1212";
debit.OrderNumber = "123";

 
 Copy
debit.Card.MagneticStripe = "4003010001234572=17041011234567440";
debit.EncryptedPIN = "7BD8948B328B21E5";
debit.KSN = "876543210F008400029";

debit.TransactionAmount = "1200"; //$12.00

Finally, submit the transaction by calling the sale method.

 
 Copy
debit.Sale();

The response_code property indicates the result of the transaction. A code of 000 indicates success. For all other values please see the Response Codes section. Additional Response properties such as response_approval_code, response_authorized_amount, response_text, response_avs_result, response_cvv_result, and more, provide further details about the transaction response.

To perform subsequent operations on a transaction, such as calling reverse to reverse a sale, or calling capture to capture a previous auth_only transaction the get_detail_aggregate method must be used to get details about the original transaction. This aggregate must be stored securely, it will contain cardholder information that is required for subsequent transactions. For instance:

 
 Copy
debit.Sale();

//Save the detail aggregate to use with Reverse
string aggregate = debit.GetDetailAggregate();

//The aggregate must then be stored securely.
//At a later time the aggregate is retrieved in order to perform a reversal.

//Reverse
debit = new Fdmsrcdebit();
...

//Specify the detail aggregate from the original transaction
debit.SetDetailAggregate(aggregate);

debit.ReversalTransactionType = FdmsrcdebitReversalTransactionTypes.frttSale;
debit.ReversalType = FdmsrcdebitReversalTypes.fdrtFullReversal;
debit.Reverse();

Transaction Types

In addition to a basic sale transaction, additional transaction types exist for other common operations. Not all transaction types are applicable for all classs. Check the method list for applicable transaction types.

Note: FDMS Rapid Connect is a host capture system. No explicit calls are needed to settle or otherwise manage the batch.

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 identifies the application that has generated and is sending the transaction. This is a 15 character alphanumeric code that identifies each application and is provided by the Datawire Secure Transport Vendor Integration Team

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

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

installment_description property

The merchant's description of an Installment Bill Payment Transaction.

Syntax

def get_installment_description() -> str: ...
def set_installment_description(value: str) -> None: ...

installment_description = property(get_installment_description, set_installment_description)

Default Value

""

Remarks

The merchant's description of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 15 characters.

installment_invoice_number property

The Invoice Number of an Installment Bill Payment Transaction.

Syntax

def get_installment_invoice_number() -> str: ...
def set_installment_invoice_number(value: str) -> None: ...

installment_invoice_number = property(get_installment_invoice_number, set_installment_invoice_number)

Default Value

""

Remarks

The Invoice Number of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 12 characters.

installment_type property

The type of the Installment payment.

Syntax

def get_installment_type() -> int: ...
def set_installment_type(value: int) -> None: ...

installment_type = property(get_installment_type, set_installment_type)

Possible Values

0   # Unspecified
1   # Merchant
2   # ThirdParty
3   # Issuer

Default Value

0

Remarks

The type of the Installment payment.

This field is required for all Discover, Diners (including JCB - US Domestic) Installment transactions transactionindicator value 3 (tiInstallment) and it is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

merchant_advice_code property

This property contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

Syntax

def get_merchant_advice_code() -> str: ...

merchant_advice_code = property(get_merchant_advice_code, None)

Default Value

""

Remarks

This field contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

The following values are defined:

This property is read-only.

mit_amount property

The amount of the Recurring or Installment payment.

Syntax

def get_mit_amount() -> str: ...
def set_mit_amount(value: str) -> None: ...

mit_amount = property(get_mit_amount, set_mit_amount)

Default Value

""

Remarks

The amount of the Recurring or Installment payment.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

mit_amount_type property

Identifies the type of the Recurring or Installment Payment amount.

Syntax

def get_mit_amount_type() -> int: ...
def set_mit_amount_type(value: int) -> None: ...

mit_amount_type = property(get_mit_amount_type, set_mit_amount_type)

Possible Values

0   # Unspecified
1   # Fixed
2   # Variable

Default Value

0

Remarks

Identifies the type of the Recurring or Installment Payment amount.

The following values are defined:

mit_frequency property

This property indicates the frequency of a Recurring or Installment payment.

Syntax

def get_mit_frequency() -> int: ...
def set_mit_frequency(value: int) -> None: ...

mit_frequency = property(get_mit_frequency, set_mit_frequency)

Possible Values

0   # Unspecified
1   # Daily
2   # Weekly
3   # Biweekly
4   # Monthly
5   # Quarterly
6   # Biannually
7   # Annually
8   # Unscheduled
9   # TenDays
10   # TwiceWeekly
11   # EveryTwoMonths
12   # Trimester

Default Value

0

Remarks

This field indicates the frequency of a Recurring or Installment payment.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

When the Card Type is 'Discover', 'JCB', or 'Diners', the valid values are 1, 2, 3, 4, 5, 6, 7, or 8.

For Visa Recurring transactions, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12.

For Visa Installment transactions, valid values are 2, 3, or 4.

mit_payment_currency property

Contains the Installment Payment Currency represented as a 3 digit value.

Syntax

def get_mit_payment_currency() -> str: ...
def set_mit_payment_currency(value: str) -> None: ...

mit_payment_currency = property(get_mit_payment_currency, set_mit_payment_currency)

Default Value

"840"

Remarks

Contains the Installment Payment Currency represented as a 3 digit value.

This field is only applicable when Card Type is 'Visa'. For US Dollars, use "840".

mit_recurring_payment_type property

This property contains the type of Recurring Payment.

Syntax

def get_mit_recurring_payment_type() -> int: ...
def set_mit_recurring_payment_type(value: int) -> None: ...

mit_recurring_payment_type = property(get_mit_recurring_payment_type, set_mit_recurring_payment_type)

Possible Values

0   # Unspecified
1   # Registration
2   # Subsequent
3   # Modification
4   # Cancellation

Default Value

0

Remarks

This field contains the type of Recurring Payment.

This field is only applicable when Card Type is 'Visa'. The following values are defined:

mit_registration_ref_num property

This property contains a unique Reference Number for the Recurring Payment transaction.

Syntax

def get_mit_registration_ref_num() -> str: ...
def set_mit_registration_ref_num(value: str) -> None: ...

mit_registration_ref_num = property(get_mit_registration_ref_num, set_mit_registration_ref_num)

Default Value

""

Remarks

This field contains a unique Reference Number for the Recurring Payment transaction.

This field is only applicable when Card Type is 'Visa'.

The maximum length of this field is 35 characters.

mit_sequence_indicator property

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

Syntax

def get_mit_sequence_indicator() -> int: ...
def set_mit_sequence_indicator(value: int) -> None: ...

mit_sequence_indicator = property(get_mit_sequence_indicator, set_mit_sequence_indicator)

Default Value

0

Remarks

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

This field should be populated in ascending order and is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

Valid values for this field are numbers from 0 to 99.

mit_total_payment_amount property

This property contains the Total Installment Amount.

Syntax

def get_mit_total_payment_amount() -> str: ...
def set_mit_total_payment_amount(value: str) -> None: ...

mit_total_payment_amount = property(get_mit_total_payment_amount, set_mit_total_payment_amount)

Default Value

""

Remarks

This field contains the Total Installment Amount.

This field is only applicable for Visa Installment transactions. Note : The total amount cannot exceed USD 500,000.

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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

mit_total_payment_count property

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

Syntax

def get_mit_total_payment_count() -> str: ...
def set_mit_total_payment_count(value: str) -> None: ...

mit_total_payment_count = property(get_mit_total_payment_count, set_mit_total_payment_count)

Default Value

""

Remarks

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'. For Discover, the valid values should be from 02 to 99, UD and UC. For Visa, the valid values should be from 01 to 99. Note: For Visa recurring payments, value of '99' means that recurring payments are authorized until canceled or that the Number of Recurring Payments is not defined.

When this field is sent for Visa or Discover (including JCB - US Domestic Only and Diners), the Bill Payment Transaction Indicator must be present with the value of 'Recurring' or 'Installment'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field can only be sent when the Installment Type field contains the value of 'Merchant' or 'ThirdParty'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field must be sent for ALL Installment transactions for a series of payments, and the original CIT transaction must be initiated with 3DS.

The maximum length of this field is 2 characters.

mit_unique_id property

This property is used to uniquely identify each of the Recurring or Installment Payment.

Syntax

def get_mit_unique_id() -> str: ...
def set_mit_unique_id(value: str) -> None: ...

mit_unique_id = property(get_mit_unique_id, set_mit_unique_id)

Default Value

""

Remarks

This field is used to uniquely identify each of the Recurring or Installment Payment. This ID is used to reference authorization transactions.

This field is only applicable when Card Type is 'Discover', 'JCB' or 'Diners'.

The maximum length of this field is 14 characters.

mit_validation_flag property

Indicates the validation source for the validity of a transaction.

Syntax

def get_mit_validation_flag() -> int: ...
def set_mit_validation_flag(value: int) -> None: ...

mit_validation_flag = property(get_mit_validation_flag, set_mit_validation_flag)

Possible Values

0   # Unspecified
1   # Validated
2   # NotValidated

Default Value

0

Remarks

Indicates the validation source for the validity of a transaction.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

The following values are defined:

mit_validation_ref property

This property contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

Syntax

def get_mit_validation_ref() -> str: ...
def set_mit_validation_ref(value: str) -> None: ...

mit_validation_ref = property(get_mit_validation_ref, set_mit_validation_ref)

Default Value

""

Remarks

This field contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

This field is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

The maximum length of this field is 20 characters.

transaction_indicator property

Specifies the type of Bill Payment being made.

Syntax

def get_transaction_indicator() -> int: ...
def set_transaction_indicator(value: int) -> None: ...

transaction_indicator = property(get_transaction_indicator, set_transaction_indicator)

Possible Values

0   # Unspecified
1   # SingleTransaction
2   # Recurring
3   # Installment
4   # DeferredBilling

Default Value

0

Remarks

Specifies the type of Bill Payment being made.

This property contains the type of bill payment being made. This is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

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

 
 Copy
  FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment
  FDMSRcECommerce.TransactionAmount = "1995"
  FDMSRcECommerce.AuthOnly()

  FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate())
  FDMSRcDetailRecord.InstallmentCount = 3
  FDMSRcDetailRecord.InstallmentNumber = 1
  
  FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()
  

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)

Possible Values

0   # Unknown
1   # Visa
2   # MasterCard
3   # AMEX
4   # Discover
5   # Diners
6   # JCB
7   # VisaElectron
8   # Maestro
10   # Laser

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 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 cvvdata 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, cvvpresence will be automatically set to cvpProvided. If set to empty string (""), cvvpresence 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)

Possible Values

0   # NotProvided
1   # Provided
2   # Illegible
3   # NotOnCard

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of cvvdata.

The class will automatically set this value to cvpProvided when a cvvdata value is specified. You can explicitly specify the cvvpresence 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)

Possible Values

0   # Track1
1   # Track2
2   # ManualEntryTrack1Capable
3   # ManualEntryTrack2Capable
4   # ManualEntryNoCardReader
5   # Track1Contactless
6   # Track2Contactless
7   # ManualEntryContactlessCapable
8   # IVR
9   # Kiosk

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 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 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 number or magneticstripe fields is validated.

By default, when the number or magneticstripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and magneticstripe data will be parsed for the track specified by entrydatasource. 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 number or magneticstripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the cardtype 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 entrydatasource 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 entrydatasource property to indicate which track you are sending.

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

 
 Copy
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 magneticstripe data, this property should be left empty.

cash_back property

Optional cash back amount to return to the customer.

Syntax

def get_cash_back() -> str: ...
def set_cash_back(value: str) -> None: ...

cash_back = property(get_cash_back, set_cash_back)

Default Value

""

Remarks

This property specifies the amount of CashBack requested. This property is valid for Debit, EBT, and Credit (Discover Only) transactions.

Note: The CashBack amount for Discover cannot be greater than $100.00 and must be less than the purchase amount. For example, if the purchase is $50.00, the maximum CashBack amount is $50.00.

For cash back transactions, the transaction_amount must contain the sum total of the purchase amount PLUS the cash_back amount. If the purchase is for $10 and the customer requests $20 cash back, cash_back should be set to "2000" and transaction_amount must contain "3000".

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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

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.

emv_data property

The EMV Data returned from a Pin Pad after reading an EMV card.

Syntax

def get_emv_data() -> str: ...
def set_emv_data(value: str) -> None: ...

emv_data = property(get_emv_data, set_emv_data)

Default Value

""

Remarks

This configuration setting takes the entire TLV (tag-length-value) response received from a Pin Pad after reading an EMV card. The class will send this data in an authorization request.

Retail EMV Example

 
 Copy
Fdmsrcretail fdmsrcretail = new Fdmsrcretail();
fdmsrcretail.IndustryType = FdmsrcretailIndustryTypes.fritRetail;
 
fdmsrcretail.TPPID = "AAA000";
fdmsrcretail.MerchantTerminalNumber = "00000001";
fdmsrcretail.MerchantId = "1234";
fdmsrcretail.GroupId = "20001";
fdmsrcretail.DatawireId = "00011122233344455566";
fdmsrcretail.VisaIdentifier = "01000000000000";
fdmsrcretail.ApplicationId = "RAPIDCONNECTVXN";
fdmsrcretail.URL = "https://stg.dw.us.fdcnet.biz/rc";
 
fdmsrcretail.STAN = "112";
fdmsrcretail.TransactionNumber = "120013";
fdmsrcretail.ReferenceNumber = "123456";
fdmsrcretail.OrderNumber = "12000503";
 
fdmsrcretail.Card.MagneticStripe = "4761739001010010=15122011143804489";
fdmsrcretail.Card.EntryDataSource = EntryDataSources.edsTrack2;
fdmsrcretail.TransactionAmount = "250";
fdmsrcretail.EMVData = "9F4005F000F0A0019F...F7906123456789012";
fdmsrcretail.Sale();

encrypted_pin property

DUKPT DES encrypted pin block, retrieved from a PIN pad.

Syntax

def get_encrypted_pin() -> str: ...
def set_encrypted_pin(value: str) -> None: ...

encrypted_pin = property(get_encrypted_pin, set_encrypted_pin)

Default Value

""

Remarks

A 16-byte encrypted PIN and associated ksn are required for all debit sale and credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device.

This value is required for all transactions except Full Reversals.

Debit Sale Example

 
 Copy
debit.TPPID = "AAA000";
debit.MerchantTerminalNumber = "00000001";
debit.MerchantId = "1234";
debit.GroupId = "20001";
debit.DatawireId = "00011122233344455566";
debit.ApplicationId = "RAPIDCONNECTVXN";
debit.URL = "https://stg.dw.us.fdcnet.biz/rc";

debit.STAN = "112";
debit.TransactionNumber = "1234";
debit.ReferenceNumber = "1212";
debit.OrderNumber = "123";

debit.Card.MagneticStripe = "4003010001234572=17041011234567440";
debit.EncryptedPIN = "7BD8948B328B21E5";
debit.KSN = "876543210F008400029";

debit.TransactionAmount = "1200";
debit.Sale();

group_id property

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

Syntax

def get_group_id() -> str: ...
def set_group_id(value: str) -> None: ...

group_id = property(get_group_id, set_group_id)

Default Value

""

Remarks

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

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)

Possible Values

0   # Retail
1   # Restaurant

Default Value

0

Remarks

The merchant's industry type. Possible values are:

ksn property

Clear-text Key Sequence Number retrieved from a PIN pad.

Syntax

def get_ksn() -> str: ...
def set_ksn(value: str) -> None: ...

ksn = property(get_ksn, set_ksn)

Default Value

""

Remarks

A 19 or 20-byte Key Sequence Number (KSN) and associated encrypted_pin are required for all debit sale and credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device. A 20-byte Key Sequence Number consists of a 1-byte pad character ('F'), a 9-byte Base Derivation Key Id (BDK ID), a 5-byte device Id, and a 5-byte transaction counter. If this property is set with a Key Sequence Number less than 20 bytes in length, the class will pad it on the left with 'F' characters.

This value is required for all transactions except Full Reversals.

Debit Sale Example

 
 Copy
debit.TPPID = "AAA000";
debit.MerchantTerminalNumber = "00000001";
debit.MerchantId = "1234";
debit.GroupId = "20001";
debit.DatawireId = "00011122233344455566";
debit.ApplicationId = "RAPIDCONNECTVXN";
debit.URL = "https://stg.dw.us.fdcnet.biz/rc";

debit.STAN = "112";
debit.TransactionNumber = "1234";
debit.ReferenceNumber = "1212";
debit.OrderNumber = "123";

debit.Card.MagneticStripe = "4003010001234572=17041011234567440";
debit.EncryptedPIN = "7BD8948B328B21E5";
debit.KSN = "876543210F008400029";

debit.TransactionAmount = "1200";
debit.Sale();

merchant_id property

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

Syntax

def get_merchant_id() -> str: ...
def set_merchant_id(value: str) -> None: ...

merchant_id = property(get_merchant_id, set_merchant_id)

Default Value

""

Remarks

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

This property is required.

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 assigned by FDMS to uniquely identify a terminal within a merchant location. The value is numeric and may be up to 8 digits in length.

This property is required.

order_number property

A merchant assigned order number to uniquely reference the transaction.

Syntax

def get_order_number() -> str: ...
def set_order_number(value: str) -> None: ...

order_number = property(get_order_number, set_order_number)

Default Value

""

Remarks

This property holds a merchant assigned order number that uniquely identifies the transaction. This must hold a numeric value up to 8 digits in length. This value cannot be all zeros.

This value is required for ECommerce and MOTO transactions. This value is optional for Retail transactions.

proxy_auth_scheme property

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

Possible Values

0   # Basic
1   # Digest
2   # Proprietary
3   # None
4   # Ntlm
5   # Negotiate

Default Value

0

Remarks

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

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

By default, authscheme is authBasic (0), and if the user and password properties are set, the class will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of user and password.

proxy_auto_detect property

Whether 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

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

proxy_password property

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

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

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

If authscheme is set to Digest Authentication, the user and password properties are used to respond to the Digest Authentication challenge from the server.

If authscheme is set to NTLM Authentication, the user and password properties are used to authenticate through NTLM negotiation.

proxy_port property

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

The Transmission Control Protocol (TCP) port for the proxy server (default 80). See the description of the 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 server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

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

proxy_ssl property

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)

Possible Values

0   # Automatic
1   # Always
2   # Never
3   # Tunnel

Default Value

0

Remarks

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

proxy_user property

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

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

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

If authscheme is set to Digest Authentication, the user and password properties are used to respond to the Digest Authentication challenge from the server.

If authscheme is set to NTLM Authentication, the user and password properties are used to authenticate through NTLM negotiation.

reference_number property

A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.

Syntax

def get_reference_number() -> str: ...
def set_reference_number(value: str) -> None: ...

reference_number = property(get_reference_number, set_reference_number)

Default Value

""

Remarks

This value is a merchant assigned 12 digit value. The value must be unique within a day for a given merchant id and terminal id. When performing a capture or reverse transaction this must be the same as the original transaction.

response_approval_code property

The Approval Code returned from the server after a successful authorization.

Syntax

def get_response_approval_code() -> str: ...

response_approval_code = property(get_response_approval_code, None)

Default Value

""

Remarks

The Approval Code returned from the server after a successful authorization.

This value holds the approval code returned by the authorizer. This value will contain up to 8 characters. Only alphanumeric characters and spaces will be returned.

This property is read-only.

response_authorized_amount property

The amount actually charged to the card.

Syntax

def get_response_authorized_amount() -> str: ...

response_authorized_amount = property(get_response_authorized_amount, None)

Default Value

""

Remarks

The amount actually charged to the card.

This value holds the amount charged to the card. In the case of a partial authorization this will be different than the amount specified in 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 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 positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

This property is read-only.

response_authorizing_network_id property

This property indicates the network Id as returned by the host, if available.

Syntax

def get_response_authorizing_network_id() -> str: ...

response_authorizing_network_id = property(get_response_authorizing_network_id, None)

Default Value

""

Remarks

This field indicates the network Id as returned by the host, if available.

This value is up to 3 alphanumeric characters.

This property is read-only.

response_authorizing_network_name property

This property indicates the authorizing network name as returned by the host, when available.

Syntax

def get_response_authorizing_network_name() -> str: ...

response_authorizing_network_name = property(get_response_authorizing_network_name, None)

Default Value

""

Remarks

This field indicates the authorizing network name as returned by the host, when available.

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. This property is populated if a value is present in the response. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. Possible AVS codes are listed in the table below.

Visa Card AVS Codes

MasterCard AVS Codes

Amex AVS Codes

Discover or JCB

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

This property is only applicable to Visa card.

Syntax

def get_response_card_level_result() -> str: ...

response_card_level_result = property(get_response_card_level_result, None)

Default Value

""

Remarks

This property is only applicable to Visa card. This property holds a two character value returned by Visa to designate the type of card product used to process the transaction.

This property is read-only.

response_code property

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

Syntax

def get_response_code() -> str: ...

response_code = property(get_response_code, None)

Default Value

""

Remarks

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

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

This property is read-only.

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)

Possible Values

0   # NotCommercial
1   # PurchaseCard
2   # CorporateCard
3   # BusinessCard
4   # Unknown

Default Value

0

Remarks

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

This is only applicable to Visa cards. Visa Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data when calling capture when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Tax amounts should be included with the Level2 or Level3 data when calling capture in order 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. This property is populated if a value is present in the response. 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 datawirestatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the datawirestatus will be "OK" and the datawirereturncode will be "000". These two 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 approvalcode contains the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

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 datawirestatus will be "OK" and the datawirereturncode 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 approvalcode 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_emv_data property

Contains the EMV data returns in the response (if any).

Syntax

def get_response_emv_data() -> str: ...

response_emv_data = property(get_response_emv_data, None)

Default Value

""

Remarks

Contains the EMV data returns in the response (if any).

This property is only applicable to Retail and Debit transactions.

This property is read-only.

response_pos_data property

This property holds transaction specific information returned by the issuer (if any).

Syntax

def get_response_pos_data() -> str: ...

response_pos_data = property(get_response_pos_data, None)

Default Value

""

Remarks

This property holds transaction specific information returned by the issuer (if any). This is only applicable to MasterCard, Discover, and AmEx card transactions.

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) for Visa transactions. This value provides information concerning the transaction's Customer Payment Service (CPS) qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value.

Possible returned ACI values are:

This property is read-only.

response_routing_indicator property

Indicates whether the transaction was processed as Credit or Debit.

Syntax

def get_response_routing_indicator() -> str: ...

response_routing_indicator = property(get_response_routing_indicator, None)

Default Value

""

Remarks

Indicates whether the transaction was processed as Credit or Debit. Possible values are:

This property is read-only.

response_settlement_date property

The date the transaction will be settled in the format MMDD.

Syntax

def get_response_settlement_date() -> str: ...

response_settlement_date = property(get_response_settlement_date, None)

Default Value

""

Remarks

The date the transaction will be settled in the format MMDD.

This property is read-only.

response_text property

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

Syntax

def get_response_text() -> str: ...

response_text = property(get_response_text, None)

Default Value

""

Remarks

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

This property is read-only.

response_transaction_date property

The transaction date returned from the server in yyyyMMddHHmmss format.

Syntax

def get_response_transaction_date() -> str: ...

response_transaction_date = property(get_response_transaction_date, None)

Default Value

""

Remarks

The transaction date returned from the server in yyyyMMddHHmmss format.

This 15 digit field contains the transaction date and time returned by the Rapid Connect system. This is not a local datetime, it is the time according the Rapid Connect system.

This property is read-only.

response_transaction_id property

Card issuer's Transaction Reference Number.

Syntax

def get_response_transaction_id() -> str: ...

response_transaction_id = property(get_response_transaction_id, None)

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet data, American Express Transaction Id, or Discover Network Result Indicator (NRID). If returned in the response, this property should be printed on the receipt.

This property is read-only.

reversal_transaction_type property

The type of transaction to reverse.

Syntax

def get_reversal_transaction_type() -> int: ...
def set_reversal_transaction_type(value: int) -> None: ...

reversal_transaction_type = property(get_reversal_transaction_type, set_reversal_transaction_type)

Possible Values

0   # AuthOnly
1   # Capture
2   # Credit
3   # Sale

Default Value

0

Remarks

This property specifies the type of transaction to reverse. Possible values are:

reversal_type property

The type of reversal.

Syntax

def get_reversal_type() -> int: ...
def set_reversal_type(value: int) -> None: ...

reversal_type = property(get_reversal_type, set_reversal_type)

Possible Values

0   # FullReversal
1   # TimeoutReversal

Default Value

0

Remarks

This property specifies the type of reversal. Possible values are:

Timeout Reversals are applicable to the following transaction types:

• auth_only
• capture
• credit
• sale

Full Reversals are applicable to the following transaction types:

• auth_only
• sale

settlement_mode property

Indicates whether the class uses Host Capture (0) or Terminal Capture (1) system.

Syntax

def get_settlement_mode() -> int: ...
def set_settlement_mode(value: int) -> None: ...

settlement_mode = property(get_settlement_mode, set_settlement_mode)

Possible Values

0   # HostCapture
1   # TerminalCapture

Default Value

0

Remarks

Possible values are:

Host-Capture means that you authorize your transactions using the auth_only or sale methods, and you process refunds and capture outstanding authorizations with the credit and capture methods. FDMS Rapid Connect handles all batch management.

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging industry_type, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types may be processed in Terminal Capture mode. However, Hotel/Lodging transactions MUST be authorized and settled in Terminal Capture mode. Attempting to authorize a Hotel/Lodging transaction with the Host Capture mode will cause the class fails with an error.

ssl_accept_server_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_fingerprint property

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

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 property

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

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 property

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

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_issuer property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key_container property

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

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_algorithm property

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

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_length property

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

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_accept_server_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The storetype property denotes the type of the certificate store specified by store. If the store is password-protected, specify the password in storepassword.

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

Designations of certificate stores are platform dependent.

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

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

ssl_accept_server_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_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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_accept_server_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Possible Values

0   # User
1   # Machine
2   # PFXFile
3   # PFXBlob
4   # JKSFile
5   # JKSBlob
6   # PEMKeyFile
7   # PEMKeyBlob
8   # PublicKeyFile
9   # PublicKeyBlob
10   # SSHPublicKeyBlob
11   # P7BFile
12   # P7BBlob
13   # SSHPublicKeyFile
14   # PPKFile
15   # PPKBlob
16   # XMLFile
17   # XMLBlob
18   # JWKFile
19   # JWKBlob
20   # SecurityKey
21   # BCFKSFile
22   # BCFKSBlob
23   # PKCS11
99   # Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

ssl_accept_server_cert_subject_alt_names property

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

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_usage property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of usageflags.

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

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

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

This property is read-only.

ssl_accept_server_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the usage property for a text representation of usageflags.

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

This property is read-only.

ssl_accept_server_cert_version property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_accept_server_cert_encoded property

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

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

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

ssl_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_fingerprint property

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

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_fingerprint_sha1 property

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

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_fingerprint_sha256 property

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

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_issuer property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_cert_private_key_container property

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

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_algorithm property

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

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_length property

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

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_store property

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

The name of the certificate store for the client certificate.

The storetype property denotes the type of the certificate store specified by store. If the store is password-protected, specify the password in storepassword.

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

Designations of certificate stores are platform dependent.

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

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

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

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)

Possible Values

0   # User
1   # Machine
2   # PFXFile
3   # PFXBlob
4   # JKSFile
5   # JKSBlob
6   # PEMKeyFile
7   # PEMKeyBlob
8   # PublicKeyFile
9   # PublicKeyBlob
10   # SSHPublicKeyBlob
11   # P7BFile
12   # P7BBlob
13   # SSHPublicKeyFile
14   # PPKFile
15   # PPKBlob
16   # XMLFile
17   # XMLBlob
18   # JWKFile
19   # JWKBlob
20   # SecurityKey
21   # BCFKSFile
22   # BCFKSBlob
23   # PKCS11
99   # Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

ssl_cert_subject_alt_names property

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

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_usage property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of usageflags.

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

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

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

This property is read-only.

ssl_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the usage property for a text representation of usageflags.

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

This property is read-only.

ssl_cert_version property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_subject property

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

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_cert_encoded property

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

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

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

ssl_provider property

The Secure Sockets Layer/Transport Layer Security (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)

Possible Values

0   # Automatic
1   # Platform
2   # Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

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

ssl_server_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_fingerprint property

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

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_fingerprint_sha1 property

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

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_fingerprint_sha256 property

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

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_issuer property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_server_cert_private_key_container property

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

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_algorithm property

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

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_length property

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

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_server_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The storetype property denotes the type of the certificate store specified by store. If the store is password-protected, specify the password in storepassword.

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

ssl_server_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_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Possible Values

0   # User
1   # Machine
2   # PFXFile
3   # PFXBlob
4   # JKSFile
5   # JKSBlob
6   # PEMKeyFile
7   # PEMKeyBlob
8   # PublicKeyFile
9   # PublicKeyBlob
10   # SSHPublicKeyBlob
11   # P7BFile
12   # P7BBlob
13   # SSHPublicKeyFile
14   # PPKFile
15   # PPKBlob
16   # XMLFile
17   # XMLBlob
18   # JWKFile
19   # JWKBlob
20   # SecurityKey
21   # BCFKSFile
22   # BCFKSBlob
23   # PKCS11
99   # Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);