FDMSOmahaDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSOmahaDetailRecord class is a tool used to create off-line transactions (Captures, Refunds, Revisions, and Voids) to be settled by the FDMSOmahaBatchMgr class.

Syntax

class dpaymentssdk.FDMSOmahaDetailRecord

Remarks

Captures (for Auth Only transactions), Refunds, Voids, and Revisions are all off-line transactions. This means that there is no live response from the server for the transaction. Instead you will add the transactions to the FDMSOmahaBatchMgr component to be sent when the batch is closed.

To capture an AuthOnly transaction, first parse the aggregate obtained from the auth only transaction. FDMSOmahaDetailRecord.ParseAggregate(FDMSOmahaRetail1.GetDetailAggregate())

Once the aggregate is parsed, you must then set the batch_number, transaction_number, and transaction_type. FDMSOmahaDetailRecord.BatchNumber = 1 FDMSOmahaDetailRecord.TransactionNumber = 1 FDMSOmahaDetailRecord.TransactionType = ttCapture

Finally, the aggregate can be added to the FDMSOmahaBatchMgr component to be sent when the batch is closed. FDMSOmahaBatchMgr.DetailRecordCount = 1; FDMSOmahaBatchMgr.DetailRecordAggregate[0] = FDMSOmahaDetailRecord.GetDetailAggregate()

Void and Revision transactions are performed very much like Capture transactions. First, the aggregate is added to the FDMSOmahaDetailRecord component. The TransactionType can then be set to either ottVoid or ottRevise. For revision transactions, you can update the transaction details (such as settlement_amount). Note that neither of these transaction types allow you to set batch_number or transaction_number as they have already been assigned to the transaction when it was marked for capture (after a Sale transaction or after a Capture transaction).

A common revision request is adding a tip_amount to charge. Below is an example of adding a tip_amount to a restaurant transaction. FDMSOmahaDetailRecord.ParseAggregate(FDMSOmahaRestaurant1.GetDetailAggregate()) FDMSOmahaDetailRecord.TipAmount = "5.00" //The SettlementAmount must include the sum of the TipAmount and the original SettlementAmount //If the transaction was originally for $10.00 and a $5.00 tip is added the new //SettlementAmount should be "15.00" FDMSOmahaDetailRecord.SettlementAmount = "15.00" FDMSOmahaBatchMgr.DetailRecordCount = 1; FDMSOmahaBatchMgr.DetailRecordAggregate[0] = FDMSOmahaDetailRecord.GetDetailAggregate()

A Credit Card Refund is not based on a prior transaction. Instead, the FDMSOmahaDetailRecord class is used to construct a completely new aggregate. To perform a Credit Card Refund, first set the industry_type to the desired industry and set transaction_type to ttRefund. The below example is for a Retail transaction. FDMSOmahaDetailRecord.IndustryType = itRetail FDMSOmahaDetailRecord.TransactionType = ttRefund

Next, set the card and transaction data along with the amount of the refund (via settlement_amount). FDMSOmahaDetailRecord.CardEntryDataSource = edsManualEntryTrack1Capable FDMSOmahaDetailRecord.CardNumber = "4444333322221111" FDMSOmahaDetailRecord.CardExpMonth = 1 FDMSOmahaDetailRecord.CardExpYear = 2013 FDMSOmahaDetailRecord.BatchNumber = 1 FDMSOmahaDetailRecord.TransactionNumber = 2 FDMSOmahaDetailRecord.SettlementAmount = "1.00"

Finally, the aggregate can be added to the FDMSOmahaBatchMgr component to be sent when the batch is closed. FDMSOmahaBatchMgr.DetailRecordCount = 1; FDMSOmahaBatchMgr.DetailRecordAggregate[0] = FDMSOmahaDetailRecord.GetDetailAggregate()

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.

auth_code Property

Authorization Code returned from the server.

Syntax

def get_auth_code() -> str: ...
def set_auth_code(value: str) -> None: ...

auth_code = property(get_auth_code, set_auth_code)

Default Value

""

Remarks

This field contains the Authorization Code returned from the server after a successful authorization.

authorized_amount Property

Original amount authorized before any reversals.

Syntax

def get_authorized_amount() -> str: ...

authorized_amount = property(get_authorized_amount, None)

Default Value

""

Remarks

This field contains the transaction amount from the original authorization request message. If a partial authorization occurred, this field will contain the partially authorized amount.

If any additional authorizations have been made, or the settlement_amount is different than the originally authorized amount (due to items out of stock or adding a tip_amount) this property should still reflect the original unchanged amount from the initial authorization request.

This property is read-only.

avs_result Property

Contains the Address Verification System result code.

Syntax

def get_avs_result() -> str: ...
def set_avs_result(value: str) -> None: ...

avs_result = property(get_avs_result, set_avs_result)

Default Value

""

Remarks

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

Valid AVS Codes:

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

batch_number Property

Number identifying the batch (assigned by the POS device).

Syntax

def get_batch_number() -> int: ...
def set_batch_number(value: int) -> None: ...

batch_number = property(get_batch_number, set_batch_number)

Default Value

0

Remarks

This property is used to specify the number identifying the batch that the transaction will be processed in.

This is a consecutive numbering system assigned by the POS application that identifies a batch of transactions. The batch number must increment each time a batch is successfully closed. When the batch number reaches 9, it is the responsibility of the application to recycle the batch number to 0. The Host will allow a variety of sequencing of the batch number, but you cannot have the same batch number in consecutive batches. For example: The application can close batch 2 and open the next batch with number 5, but you cannot close batch 2 then re-open batch 2 without a different batch number in between. If you should receive a message of "INV BATCH SEQ", this usually indicates the current batch number is the same as the previous batch number closed or there is a batch still open on the Host and the application is trying to process a transaction with a different batch number. If a batch is left open for more than 45 days, (45 days from the open date, not last activity date), the system will automatically purge the batch and it will not be retrievable.

Valid values: 0-9

beverage_amount Property

The amount of the restaurant beverage purchase.

Syntax

def get_beverage_amount() -> str: ...
def set_beverage_amount(value: str) -> None: ...

beverage_amount = property(get_beverage_amount, set_beverage_amount)

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$.cc) of the restaurant beverage purchase (other miscellaneous amount can also be included).

Note: This is a reporting field only. Therefore the beverage_amount must be accounted for within transaction_amount.

Note: The decimal point is required to be specified within the amount.

card_type Property

Type of credit card being used in this transaction.

Syntax

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

card_type = property(get_card_type, set_card_type)

Default Value

0

Remarks

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

card_cvv_data Property

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

Syntax

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

card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)

Default Value

""

Remarks

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

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

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

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

card_cvv_presence Property

Indicates the presence of the card verification value.

Syntax

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

card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of card_cvv_data.

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

Available values are:

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

card_entry_data_source Property

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

Syntax

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

card_entry_data_source = property(get_card_entry_data_source, set_card_entry_data_source)

Default Value

0

Remarks

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

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

card_exp_month Property

Expiration month of the credit card specified in Number .

Syntax

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

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

1

Remarks

Expiration month of the credit card specified in card_number.

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

card_exp_year Property

Expiration year of the credit card specified in Number .

Syntax

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

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

2000

Remarks

Expiration year of the credit card specified in card_number.

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

card_is_encrypted Property

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

Syntax

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

card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)

Default Value

FALSE

Remarks

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

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

card_magnetic_stripe Property

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

Syntax

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

card_magnetic_stripe = property(get_card_magnetic_stripe, set_card_magnetic_stripe)

Default Value

""

Remarks

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

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

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

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

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

card_number Property

Customer's credit card number for the transaction.

Syntax

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

card_number = property(get_card_number, set_card_number)

Default Value

""

Remarks

Customer's credit card number for the transaction.

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

customer_address Property

The customer's street number of the billing address.

Syntax

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

customer_address = property(get_customer_address, set_customer_address)

Default Value

""

Remarks

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

The maximum length of this configuration setting is 5 characters.

customer_code Property

Merchant-assigned customer code.

Syntax

def get_customer_code() -> str: ...
def set_customer_code(value: str) -> None: ...

customer_code = property(get_customer_code, set_customer_code)

Default Value

""

Remarks

This property is used to specify a merchant-assigned code identifying the customer of the transaction.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

customer_zip_code Property

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

Syntax

def get_customer_zip_code() -> str: ...
def set_customer_zip_code(value: str) -> None: ...

customer_zip_code = property(get_customer_zip_code, set_customer_zip_code)

Default Value

""

Remarks

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

This field is optional and has a maximum length of 9 characters.

device_id Property

POS Device Identification.

Syntax

def get_device_id() -> str: ...
def set_device_id(value: str) -> None: ...

device_id = property(get_device_id, set_device_id)

Default Value

""

Remarks

Merchant-assigned code identifying the device at the merchant's location.

This field is required if there is one merchant_number assigned to more than one terminal at a merchant's location.

The maximum length of this property is 4 characters.

direct_marketing_type Property

Specifies the type of transaction to process.

Syntax

def get_direct_marketing_type() -> int: ...
def set_direct_marketing_type(value: int) -> None: ...

direct_marketing_type = property(get_direct_marketing_type, set_direct_marketing_type)

Default Value

0

Remarks

This property is used to specify the type of direct marketing transaction you wish to process.

The following types of transactions are supported by this class:

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

Note: For Installment payments, Omaha does not support specifying the Installment Number and Installment Count. Therefore it is up to the merchant to maintain this information internally. Thus the only additional requirement to send an Installment payment is to set direct_marketing_type to dmInstallment.

food_amount Property

The amount of the restaurant food purchase.

Syntax

def get_food_amount() -> str: ...
def set_food_amount(value: str) -> None: ...

food_amount = property(get_food_amount, set_food_amount)

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$$$.cc) of the restaurant food purchase.

Note: This is a reporting field only. Therefore the food_amount must be accounted for within transaction_amount.

Note: The decimal point is required to be specified within the amount.

industry_type Property

Code which indicates the industry the merchant is engaged in.

Syntax

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

industry_type = property(get_industry_type, set_industry_type)

Default Value

1

Remarks

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

invoice_number Property

Merchant-defined invoice number.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

This property is used to specify an invoice number as defined by the merchant.

The maximum length of this property is 8 characters.

operator_id Property

Merchant-assigned operator code identifying the operator who entered the transaction.

Syntax

def get_operator_id() -> str: ...
def set_operator_id(value: str) -> None: ...

operator_id = property(get_operator_id, set_operator_id)

Default Value

""

Remarks

This property is used to specify the ID of the operator (such as a cashier or server) who entered the transaction.

The maximum length for this field is 4.

order_number Property

Merchant-defined number identifying the purchase or service.

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 is used to specify an order number to identify the purchase or service.

The maximum length is 25 characters.

settlement_amount Property

The amount that the customer will be charged.

Syntax

def get_settlement_amount() -> str: ...
def set_settlement_amount(value: str) -> None: ...

settlement_amount = property(get_settlement_amount, set_settlement_amount)

Default Value

""

Remarks

This field contains the final settlement amount of the transaction. In most cases, this is the TransactionAmount from the original authorization request. However, you may settle a lesser amount (ie: Partial shipment or backordered stock). If using the Restaurant industry_type, you may also increase the settlement_amount by adding any tip_amount (if present).

Note: The decimal point is required to be specified within the amount.

ship_to_zip_code Property

The zip code where the purchased items will be shipped to.

Syntax

def get_ship_to_zip_code() -> str: ...
def set_ship_to_zip_code(value: str) -> None: ...

ship_to_zip_code = property(get_ship_to_zip_code, set_ship_to_zip_code)

Default Value

""

Remarks

This property is used to specify the zip code where the purchased items will be shipped to.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

tax_amount Property

Dollar-and-cent amount of tax for the purchase.

Syntax

def get_tax_amount() -> str: ...
def set_tax_amount(value: str) -> None: ...

tax_amount = property(get_tax_amount, set_tax_amount)

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$.cc) of the tax for the purchase.

Note: This is a reporting field only. Therefore the tax_amount must be accounted for within transaction_amount.

Note: The decimal point is required to be specified within the amount.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

tip_amount Property

The amount of the tip given at a restaurant for the purchase.

Syntax

def get_tip_amount() -> str: ...
def set_tip_amount(value: str) -> None: ...

tip_amount = property(get_tip_amount, set_tip_amount)

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$.cc) of the tip given at a restaurant for the purchase.

Note: This is a reporting field only. Therefore the tip_amount must be accounted for within transaction_amount.

Note: The decimal point is required to be specified within the amount.

tppid Property

Third Party Processor Identifier assigned by FDMS.

Syntax

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

tppid = property(get_tppid, set_tppid)

Default Value

"V4D001"

Remarks

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

The default value for 4D Payments, Inc. on the Omaha platform is "V4D001".

A visa_identifier is also required for Visa transactions.

transaction_id Property

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

def get_transaction_id() -> str: ...
def set_transaction_id(value: str) -> None: ...

transaction_id = property(get_transaction_id, set_transaction_id)

Default Value

""

Remarks

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

transaction_number Property

The transaction number for the current transaction.

Syntax

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

transaction_number = property(get_transaction_number, set_transaction_number)

Default Value

0

Remarks

This property is used to specify the transaction number for the current transaction. The valid values are 0 - 999. A transaction_number of 0 is only used and MUST be used for AuthOnly transactions, thus all other transaction types must have a transaction_number of 1 or greater. The maximum value of transaction_number is 999 (note: closing a batch requires an item number and thus the actual number of transactions in a batch is 998).

If a transaction is unsuccessful the transaction_number should be re-used.

For Credit Card transactions, the transaction_number starts at 1 (provided it is not an AuthOnly transaction) and must increment with each successful transaction.

For Debit/EBT Card transactions, the transaction_number starts at 999 and must decrement with each successful transaction.

Note transaction_numbers for Credit Card and Debit/EBT cards *cannot* overlap and must be unique. Additionally, there must be an open transaction_number for the close batch transaction. For example, you can have 1-454 for Credit Card transactions and 456-999 for Debit/EBT cards but transaction_number 455 must be left available for the close batch transaction.

Item numbers do NOT have to be processed in sequence (i.e. 1, 2, 3, etc.). However, when a batch is closed all transactions up to the transaction_number specified to close the batch must be accounted for. For example; if a batch is closed using transaction_number 5, transactions 1, 2, 3, and 4 MUST be accounted for. Additionally, if the batch is closed using an transaction_number that is not one more than the number of items in the batch, the Host will delete all records over the close transaction_number. For example; if a batch is closed using transaction_number 5, transaction records 5, 6, 7, etc. will be automatically deleted by the system.

Each transaction that posts to the Host with an transaction_number must keep that transaction_number until the batch is closed. Note: the Host accepts two or more transactions with the same transaction_number, but the last transaction will overwrite any previous transactions. For example, if a sale is performed for transaction_number 1 and then a credit is performed, only the credit will post to the cardholder's account (it will be as if the sale transaction never happened, with the exception of the reserved funds).

This property is not applicable for the ottRevise and ottVoid transaction types. Thus when get_detail_aggregate is called, the returned aggregate will contain the transaction_number specified within the original transaction.

Below is a table of the various transaction types and how transaction_number should be handled for Credit Card transactions. Note that the below table is only applicable to Credit Card transactions.

Debit/EBT cards are always performed online and thus each successful transaction should have their own unique transaction_number that starts at 999 and decrements by 1 for each success transaction performed.

transaction_type Property

Indicates transaction type for this detail record.

Syntax

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

transaction_type = property(get_transaction_type, set_transaction_type)

Default Value

0

Remarks

This property indicates the type of transaction that is being settled. The following table lists the industry types supported by this class.

visa_identifier Property

Additional merchant identification field used when authorizing Visa transactions.

Syntax

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

visa_identifier = property(get_visa_identifier, set_visa_identifier)

Default Value

""

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_detail_aggregate Method

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

Syntax

def get_detail_aggregate() -> str: ...

Remarks

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

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

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

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

parse_aggregate Method

Parses the aggregate returned from another class's GetDetailAggregate method.

Syntax

def parse_aggregate(aggregate: str) -> None: ...

Remarks

This method takes the XML aggregate returned from the FDMSOmahaRetail, FDMSOmahaRestaurant, or FDMSOmahaECommerce class, parses it, and then fills all the properties of the OmahaDetailRecord class.

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FDMSOmahaDetailRecord Config Settings

FDMSOmahaDetailRecord Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

FDMSOmahaDetailRecord Errors

FDMSOmahaDetailRecord Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors