FDMSLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSLevel3 class is a tool used to create Level 3 Corporate Purchasing Card addendum aggregates, which can then be passed to the FDMSSETTLE class and settled.

Syntax

class dpaymentssdk.FDMSLevel3

Remarks

This Level3Extension class creates Level 3 addendum data, which can be sent in the settlement to achieve a better interchange rate when accepting corporate purchasing cards. The Level 3 addendum allows the merchant to send very detailed information about every item that was purchased by the card holder, as well as tax and shipping information.

This class creates a different addendum aggregate based on the card_type. Visa and MasterCard addendums differ slightly, and therefore a slightly different set of properties are required for each.

List of valid Line Item properties for Visa:

• line_item_quantity (required)
• item_quantity_exponent (optional)
• line_item_unit_cost (required)
• line_item_commodity_code (optional)
• line_item_description (optional)
• line_item_discount_amount (optional)
• line_item_product_code (optional)
• line_item_tax_amount (optional)
• line_item_tax_rate (optional)
• line_item_total (optional)
• line_item_units (optional)
• item_national_tax_amount (optional)
• item_other_tax_amount (optional)

List of valid Line Item properties for Mastercard:

• line_item_description (required)
• line_item_product_code (required)
• line_item_quantity (required)
• item_quantity_exponent (required)
• line_item_units (required)
• line_item_unit_cost (optional)
• line_item_total (required)
• line_item_discount_amount (optional)
• line_item_tax_included (required)
• line_item_tax_rate (required)
• line_item_tax_amount (required)
• line_item_tax_type (required)

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

A Level 3 addendum for the fctMasterCard card_type is constructed similarly:

NOTE: You must send both a Level 2 addendum and a Level 3 addendum together in the same DetailAddendum. Level 3 data cannot be processed without a corresponding Level2 aggregate (however, you can send Level 2 data without Level 3 data).

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.

card_type Property

The card type for which a Level 2 or Level 3 addendum will be created.

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

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

line_item_count Property

The number of records in the Item arrays.

Syntax

def get_line_item_count() -> int: ...
def set_line_item_count(value: int) -> None: ...

line_item_count = property(get_line_item_count, set_line_item_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• item_commodity_code
• item_description
• item_discount_amount
• item_national_tax_amount
• item_other_tax_amount
• item_product_code
• item_quantity
• item_quantity_exponent
• item_tax_amount
• item_tax_included
• item_tax_rate
• item_tax_type
• item_total
• item_unit_cost
• item_units

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

item_commodity_code Property

Code indicating the type of goods or services sold.

Syntax

def get_item_commodity_code(item_index: int) -> str: ...
def set_item_commodity_code(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Code indicating the type of goods or services sold.

This property should contain an international description code of the overall goods or services being supplied. The acquirer bank or processor should provide the merchant an updated listing of currently defined codes.

The maximum length of this property is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_description Property

Description of the item.

Syntax

def get_item_description(item_index: int) -> str: ...
def set_item_description(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Description of the item.

This property contains an alphanumeric description of the item(s) being supplied.

The maximum length of this property is 26 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_discount_amount Property

Amount of the discount for each line item (if any).

Syntax

def get_item_discount_amount(item_index: int) -> str: ...
def set_item_discount_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Amount of the discount for each line item (if any).

This property contains the amount of any discount applied by the merchant to this line item. This property should be empty (or zero) if the item_unit_cost reflects a discount price or if no line item discount applies.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_national_tax_amount Property

National tax amount included in the transaction amount.

Syntax

def get_item_national_tax_amount(item_index: int) -> str: ...
def set_item_national_tax_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

National tax amount included in the transaction amount.

This optional property is applicable to Visa International. It contains the amount of national tax that is included in the transaction amount. This value must be expressed in the same currency as the source amount.

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

The maximum length of this property is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_other_tax_amount Property

City or county tax amount.

Syntax

def get_item_other_tax_amount(item_index: int) -> str: ...
def set_item_other_tax_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

City or county tax amount.

This optional property is applicable to International merchants only. It is used when city or multiple county taxes need to be broken out separately.

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

The maximum length of this property is 12 characters.

This property is only used for Visa Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_product_code Property

Product code of the item purchased.

Syntax

def get_item_product_code(item_index: int) -> str: ...
def set_item_product_code(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Product code of the item purchased.

This property contains a code assigned to the product by the merchant. This may be a UPC or any other code with which the merchant wishes to identify an individual product. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_quantity Property

Quantity of items in this Line Item.

Syntax

def get_item_quantity(item_index: int) -> int: ...
def set_item_quantity(item_index: int, value: int) -> None: ...

Default Value

0

Remarks

Quantity of items in this Line Item.

This property contains the quantity of items being purchased, in whole numbers. This amount is to be presented with an implied decimal point. The position of the implied decimal is set using the item_quantity_exponent property.

For example, quantity 1.25 must be represented as 125 with item_quantity_exponent being set to 2.

Note: The maximum length of this field for Mastercard is 5 digits.

For example, if your customer purchased 3 T-Shirts at $13.99 each, then: FDMSLevel3.LineItemsCount = 1 FDMSLevel3.LineItemsQuantity[0] = 3 FDMSLevel3.LineItemsUnitCost[0] = "1399" FDMSLevel3.LineItemsUnits[0] = "each" FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97 All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_quantity_exponent Property

QuantityExponent of items in this Line Item.

Syntax

def get_item_quantity_exponent(item_index: int) -> str: ...
def set_item_quantity_exponent(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

QuantityExponent of items in this Line Item.

This property determines the position of the implied decimal point in the quantity of items puchased, in whole numbers.

For Visa transactions, the valid values for this property are between 0-4.

For MasterCard transactions, the valid values are between 0-5.

For example, if your customer purchased 3 T-Shirts at $13.99 each, then: FDMSLevel3.LineItemsCount = 1 FDMSLevel3.LineItemsQuantity[0] = 3 FDMSLevel3.LineItemsUnitCost[0] = "1399" FDMSLevel3.LineItemsUnits[0] = "each" FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97 All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_amount Property

Tax on this individual item.

Syntax

def get_item_tax_amount(item_index: int) -> str: ...
def set_item_tax_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tax on this individual item.

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the purchased item.

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

Note: The maximum length of this property is 12 characters for Visa and 9 characters for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_included Property

Net/Gross Indicator.

Syntax

def get_item_tax_included(item_index: int) -> bool: ...
def set_item_tax_included(item_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Net/Gross Indicator.

If this property is True, the item_total already contains the item_tax_amount. If False, the item_tax_amount has not yet been added to the item_total. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_rate Property

Tax rate used to calculate the TaxAmount .

Syntax

def get_item_tax_rate(item_index: int) -> str: ...
def set_item_tax_rate(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tax rate used to calculate the item_tax_amount.

This property contains the tax rate used to calculate the item_tax_amount. This property has a two-digit implied decimal position, and the maximum length is 4 characters for Visa and 5 digits for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_tax_type Property

Type of tax charged in TaxAmount .

Syntax

def get_item_tax_type(item_index: int) -> int: ...
def set_item_tax_type(item_index: int, value: int) -> None: ...

Default Value

0

Remarks

Type of tax charged in item_tax_amount.

This property designates the type of value-added taxes (VAT) that are being charged in item_tax_amount All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_total Property

Total cost of this line item.

Syntax

def get_item_total(item_index: int) -> str: ...
def set_item_total(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as item_unit_cost multiplied by item_quantity, with any item_tax_amount and item_discount_amount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: FDMSLevel3.LineItemsCount = 1 FDMSLevel3.LineItemsQuantity[0] = 3 FDMSLevel3.LineItemsUnitCost[0] = "1399" FDMSLevel3.LineItemsUnits[0] = "each" FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_unit_cost Property

Cost of each individual item.

Syntax

def get_item_unit_cost(item_index: int) -> str: ...
def set_item_unit_cost(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Cost of each individual item.

This property contains the cost of each item in this Line Item. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: FDMSLevel3.LineItemsCount = 1 FDMSLevel3.LineItemsQuantity[0] = 3 FDMSLevel3.LineItemsUnitCost[0] = "1399" FDMSLevel3.LineItemsUnits[0] = "each" FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

item_units Property

Unit of measure for this Line Item.

Syntax

def get_item_units(item_index: int) -> str: ...
def set_item_units(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Unit of measure for this Line Item.

This property contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the item_unit_cost is calculated. If you're selling rope by the foot, the item_units might be "feet". If you're selling chemicals, it might be by the "ounce". For example, if your customer purchased 3 T-Shirts at $13.99 each, then: FDMSLevel3.LineItemsCount = 1 FDMSLevel3.LineItemsQuantity[0] = 3 FDMSLevel3.LineItemsUnitCost[0] = "1399" FDMSLevel3.LineItemsUnits[0] = "each" FDMSLevel3.LineItemsTotal[0] = "4197" '$13.99 x 3 = $41.97

The maximum length of this property is 12 characters for Visa Cards and 3 characters for MasterCard.

Some examples from the list of valid values for MasterCard are:

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

merchant_tax_id Property

Merchant's tax Id number assigned by the taxing authority.

Syntax

def get_merchant_tax_id() -> str: ...
def set_merchant_tax_id(value: str) -> None: ...

merchant_tax_id = property(get_merchant_tax_id, set_merchant_tax_id)

Default Value

""

Remarks

This property contains the VAT identification number of the merchant from whom the goods or services were purchased.

The maximum length of this property is 20 characters.

This property is only used for Visa Corporate Purchasing Cards.

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_addendum Method

Returns a Level 3 Purchasing card addendum based on the specified CardType .

Syntax

def get_addendum() -> str: ...

Remarks

The type of addendum created by this class depends upon the value of the card_type property. Different addendums are created when the card_type is set to fctVisa or fctMasterCard, and different properties are required for the two different card_types.

List of valid Line Item properties for Visa:

• line_item_quantity (required)
• item_quantity_exponent (optional)
• line_item_unit_cost (required)
• line_item_commodity_code (optional)
• line_item_description (optional)
• line_item_discount_amount (optional)
• line_item_product_code (optional)
• line_item_tax_amount (optional)
• line_item_tax_rate (optional)
• line_item_total (optional)
• line_item_units (optional)
• item_national_tax_amount (optional)
• item_other_tax_amount (optional)

List of valid Line Item properties for Mastercard:

• line_item_description (required)
• line_item_product_code (required)
• line_item_quantity (required)
• item_quantity_exponent (required)
• line_item_units (required)
• line_item_unit_cost (optional)
• line_item_total (required)
• line_item_discount_amount (optional)
• line_item_tax_included (required)
• line_item_tax_rate (required)
• line_item_tax_amount (required)
• line_item_tax_type (required)

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

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 FDMSLevel3ErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class FDMSLevel3:
@property
def on_error() -> Callable[[FDMSLevel3ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FDMSLevel3ErrorEventParams], 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.

FDMSLevel3 Config Settings

The class accepts one or more of the following configuration settings. Configuration 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.

Base Config Settings

FDMSLevel3 Errors

FDMSLevel3 Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	605   Invalid CardType.