FDMSRcDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcDetailRecord class is a tool used to create off-line Refund or Force/VoiceApproved transactions to be settled by the FDMSRcSettle class. The FDMSRcDetailRecord class may also be used to modify the XML aggregates returned by the FDMSRcRetail or FDMSRcECommerce class's GetDetailAggregate method.

Syntax

class dpaymentssdk.FDMSRcDetailRecord

Remarks

Creating off-line transactions means that there is no authorization of funds using the FDMSRcECommerce, or FDMSRcRetail classs. Instead, you must manually add these transactions to the settlement batch. The FDMSRcDetailRecord class can be used to create these transactions, which can then be added to the FDMSRcSettle class's DetailRecord array property.

To create an off-line Refund, first set the transaction_type to fttRefundCredit, and then set the industry_type and card_entry_data_source based on whether you have a card reader, and how your customer is authenticated. The following example shows how this should be set for MOTO:

FDMSRcDetailRecord.TransactionType = fttRefundCredit FDMSRcDetailRecord.IndustryType = fitRcMOTO FDMSRcDetailRecord.CardEntryDataSource = edsManualEntryNoCardReader

Next, set the card_number, card_exp_month, card_exp_year, total_authorized_amount, and settlement_amount. Note that since this is an off-line transaction, the total_authorized_amount MUST be zero.

FDMSRcDetailRecord.CardNumber = "371030089111114" FDMSRcDetailRecord.CardExpMonth = 12 FDMSRcDetailRecord.CardExpYear = 2025 FDMSRcDetailRecord.TotalAuthorizedAmount = "0" FDMSRcDetailRecord.SettlementAmount = "5000" ' $50.00

Finally, set the FDMSRcSettle class's DetailRecord array property with the value returned by the get_detail_aggregate method. You've just added a Refund to the settlement.

FDMSRcSettle.DetailRecordCount = 1 FDMSRcSettle.DetailRecordAggregate(0) = FDMSRcDetailRecord.GetDetailAggregate()

Forced/VoiceApproved transactions are similar to refunds, with the exception that a Forced transaction requires a Voice Authorization code obtained from your acquiring bank's call center. Generally, the purchase of large high-dollar items (cars, appliances, etc) will require the merchant to call and receive a voice authorization. Once this code is received, it should be set to the approval_code property. The following example shows a Force/VoiceApproved transaction in a Retail environment.

FDMSRcDetailRecord.TransactionType = fttVoiceApproved FDMSRcDetailRecord.IndustryType = fitRcRetail FDMSRcDetailRecord.CardEntryDataSource = edsTrack1 FDMSRcDetailRecord.CardNumber = "4444333322221111" FDMSRcDetailRecord.CardExpMonth = 12 FDMSRcDetailRecord.CardExpYear = 2025 FDMSRcDetailRecord.TotalAuthorizedAmount = "0" FDMSRcDetailRecord.SettlementAmount = "500000" '$5000.00 FDMSRcDetailRecord.ApprovalCode = "123456" FDMSRcSettle.DetailRecordCount = 1 FDMSRcSettle.DetailRecord(0) = FDMSRcDetailRecord.GetDetailAggregate()

In addition to creating off-line Refund and Force transactions, the FDMSRcDetailRecord class can be used to adjust the Detail Records returned from the FDMSRcECommerce and FDMSRcRetail classs. For instance, one reason to modify these detail records is to add Installment payment info (fitRcDirectMarketing or fitRcMOTO industry_type) to the detail record.

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:

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

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.

approval_code Property

Approval code of the Voice/Force transaction to be sent for settlement.

Syntax

def get_approval_code() -> str: ...
def set_approval_code(value: str) -> None: ...

approval_code = property(get_approval_code, set_approval_code)

Default Value

""

Remarks

This property should be set with the approval code the merchant gets over the phone for a Voice/Force transaction.

arrival_date Property

The arrival date of the guest.

Syntax

def get_arrival_date() -> str: ...
def set_arrival_date(value: str) -> None: ...

arrival_date = property(get_arrival_date, set_arrival_date)

Default Value

""

Remarks

Date the guest checked in, or the expected arrival date when authorizing a reservation. The date specified should be in the format "MMDDYY".

Note: The Arrival Date must be a date that precedes the Departure Date.

card_entry_data_source Property

This property identifies 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

Allowable values include: This property contains a 1-character code identifying the source of the customer data.

card_exp_month Property

Expiration month of the credit card specified in CardNumber .

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

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

card_exp_year Property

Expiration year of the credit card specified in CardNumber .

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

This field 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 cannot be specified.

cardholder_name Property

The name of the Cardholder.

Syntax

def get_cardholder_name() -> str: ...
def set_cardholder_name(value: str) -> None: ...

cardholder_name = property(get_cardholder_name, set_cardholder_name)

Default Value

""

Remarks

This property is used to specify the name of the cardholder.

card_number Property

Customer's credit card number from the original authorization request.

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

This field contains the customer's credit card number used in the original authorization request. This alphanumeric field can be a maximum of 22 characters long, excluding whitespace and dashes which are stripped out when the property is set.

cash_back Property

Amount of cash that was returned 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 should reflect the cash back amount from the original debit or EBT card sale. The value sent in the settlement MUST be identical to the amount approved in the sale.

departure_date Property

The departure date of the guest.

Syntax

def get_departure_date() -> str: ...
def set_departure_date(value: str) -> None: ...

departure_date = property(get_departure_date, set_departure_date)

Default Value

""

Remarks

Date the guest checked out, or the expected departure date when authorizing a reservation. The date specified should be in the format "MMDDYY".

Note: The Departure Date must be a date that is after the Arrival Date.

duration Property

Length of hotel stay in days.

Syntax

def get_duration() -> int: ...
def set_duration(value: int) -> None: ...

duration = property(get_duration, set_duration)

Default Value

1

Remarks

The number of days the guest stayed in the hotel, or the expected duration of stay when authorizing a reservation. This field must be between 1 and 99 days.

eci Property

Identifies the security level of the ECommerce transaction.

Syntax

def get_eci() -> str: ...
def set_eci(value: str) -> None: ...

eci = property(get_eci, set_eci)

Default Value

""

Remarks

This setting specifies the security level of the ECommerce transaction. In most cases this does not need to be changed. A common reason for modifying this value is when supplying 3-D secure values. Possible values are:

This is only applicable when industry_type is set to fitRcDirectMarketing or fitRcHotel.

extra_charges Property

List of extra charges for hotel transactions.

Syntax

def get_extra_charges() -> str: ...
def set_extra_charges(value: str) -> None: ...

extra_charges = property(get_extra_charges, set_extra_charges)

Default Value

""

Remarks

This property contains a six-character numeric value used to identify any additional ancillary charges that are booked to the cardholder's card after the transaction was completed. The merchant may enter one or more codes on each transaction being settled. If extra charges are being submitted, this field must contain value(s) as defined below.

For example, to indicate charges in both the gift shop and mini bar, extra_charges should equal "34".

This field is only applicable to Visa card transactions when industry_type is Hotel and will not be sent for any other industry types.

folio_number Property

The Folio or Room Agreement number assigned by the hotel.

Syntax

def get_folio_number() -> str: ...
def set_folio_number(value: str) -> None: ...

folio_number = property(get_folio_number, set_folio_number)

Default Value

""

Remarks

This is a 12 alphanumeric code assigned by the hotel during the transaction.

hotel_no_show Property

Indicates whether the guest did not show.

Syntax

def get_hotel_no_show() -> bool: ...
def set_hotel_no_show(value: bool) -> None: ...

hotel_no_show = property(get_hotel_no_show, set_hotel_no_show)

Default Value

FALSE

Remarks

This property can be set to 'True' to indicate that the guest did not show.

industry_type Property

The merchant's industry type.

Syntax

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

industry_type = property(get_industry_type, set_industry_type)

Default Value

0

Remarks

The merchant's industry type. Possible values are:

installment_count Property

Total number of installments (installment transactions only).

Syntax

def get_installment_count() -> int: ...
def set_installment_count(value: int) -> None: ...

installment_count = property(get_installment_count, set_installment_count)

Default Value

0

Remarks

This property is used when charging installment payments. The installment_count indicates the total number of installments to be charged to the customer, and the installment_number indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSRcEcommerce class.

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:

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

installment_number Property

Current installment number (installment transactions only).

Syntax

def get_installment_number() -> int: ...
def set_installment_number(value: int) -> None: ...

installment_number = property(get_installment_number, set_installment_number)

Default Value

0

Remarks

This property is used when charging installment payments. The installment_count indicates the total number of installments to be charged to the customer, and the installment_number indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSRcEcommerce class.

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:

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

level_2_customer_reference_number Property

The reference number or order number to be reported as part of the Purchase Card data.

Syntax

def get_level_2_customer_reference_number() -> str: ...
def set_level_2_customer_reference_number(value: str) -> None: ...

level_2_customer_reference_number = property(get_level_2_customer_reference_number, set_level_2_customer_reference_number)

Default Value

""

Remarks

The reference number or order number to be reported as part of the Purchase Card data.

If level_2_tax_amount is specified this property is required.

The value may be up to 17 characters in length.

level_2_destination_country_code Property

This property represents the country code of the location the items in this purchase are being delivered to.

Syntax

def get_level_2_destination_country_code() -> str: ...
def set_level_2_destination_country_code(value: str) -> None: ...

level_2_destination_country_code = property(get_level_2_destination_country_code, set_level_2_destination_country_code)

Default Value

""

Remarks

This field represents the country code of the location the items in this purchase are being delivered to.

This value is the ISO 3166 three digit numeric identifier.

level_2_destination_postal_code Property

This property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

Syntax

def get_level_2_destination_postal_code() -> str: ...
def set_level_2_destination_postal_code(value: str) -> None: ...

level_2_destination_postal_code = property(get_level_2_destination_postal_code, set_level_2_destination_postal_code)

Default Value

""

Remarks

This property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

This property is required for American Express purchase card transactions. This is the same as the level_2_ship_from_postal_code when the customer takes possession of the items at the merchant location.

The value may be up to 9 characters.

level_2_discount_amount Property

This property contains the discount amount for the purchase.

Syntax

def get_level_2_discount_amount() -> str: ...
def set_level_2_discount_amount(value: str) -> None: ...

level_2_discount_amount = property(get_level_2_discount_amount, set_level_2_discount_amount)

Default Value

""

Remarks

This property contains the discount amount for the purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a discount has been applied.

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.

level_2_duty_amount Property

This property contains the duty amount for this purchase.

Syntax

def get_level_2_duty_amount() -> str: ...
def set_level_2_duty_amount(value: str) -> None: ...

level_2_duty_amount = property(get_level_2_duty_amount, set_level_2_duty_amount)

Default Value

""

Remarks

This property contains the duty amount for this purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a duty amount has been applied.

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.

level_2_freight_amount Property

This property contains the amount for freight included in this purchase.

Syntax

def get_level_2_freight_amount() -> str: ...
def set_level_2_freight_amount(value: str) -> None: ...

level_2_freight_amount = property(get_level_2_freight_amount, set_level_2_freight_amount)

Default Value

""

Remarks

This property contains the amount for freight included in this purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a freight amount has been applied.

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.

level_2_merchant_tax_id Property

This property should contain the Tax Id collected by the merchant for this transaction.

Syntax

def get_level_2_merchant_tax_id() -> str: ...
def set_level_2_merchant_tax_id(value: str) -> None: ...

level_2_merchant_tax_id = property(get_level_2_merchant_tax_id, set_level_2_merchant_tax_id)

Default Value

""

Remarks

This property should contain the Tax Id collected by the merchant for this transaction.

This property is required for MasterCard purchase card transactions.

The value may be up to 15 characters in length.

level_2_product_description Property

This property should contain a description of an item purchased with this card.

Syntax

def get_level_2_product_description() -> str: ...
def set_level_2_product_description(value: str) -> None: ...

level_2_product_description = property(get_level_2_product_description, set_level_2_product_description)

Default Value

""

Remarks

This property should contain a description of an item purchased with this card.

This property is required for American Express purchase card transactions and not applicable to other card types.

The value may be up to 40 characters in length.

level_2_purchase_identifier Property

This property represents the data used by the merchant or customer to identify the purchase.

Syntax

def get_level_2_purchase_identifier() -> str: ...
def set_level_2_purchase_identifier(value: str) -> None: ...

level_2_purchase_identifier = property(get_level_2_purchase_identifier, set_level_2_purchase_identifier)

Default Value

""

Remarks

This property represents the data used by the merchant or customer to identify the purchase. This can be a SKU, code, or reference number.

This property is required for Visa, MasterCard, and American Express purchase card transactions.

The value may be up to 25 characters in length.

level_2_ship_from_postal_code Property

The postal or zip code the item(s) in this purchase are to be shipped from.

Syntax

def get_level_2_ship_from_postal_code() -> str: ...
def set_level_2_ship_from_postal_code(value: str) -> None: ...

level_2_ship_from_postal_code = property(get_level_2_ship_from_postal_code, set_level_2_ship_from_postal_code)

Default Value

""

Remarks

The postal or zip code the item(s) in this purchase are to be shipped from.

The value may be up to 9 characters.

level_2_tax_amount Property

This property contains the portion of the transaction amount that represents the tax.

Syntax

def get_level_2_tax_amount() -> str: ...
def set_level_2_tax_amount(value: str) -> None: ...

level_2_tax_amount = property(get_level_2_tax_amount, set_level_2_tax_amount)

Default Value

""

Remarks

This property contains the portion of the transaction amount that represents the tax.

This property is required when level_2_tax_indicator is set to 2 (tiProvided).

For Visa this is the amount of state or provincial tax included in the transaction_amount. The tax amount must be within 0.1 % and 22% of the pre-tax transaction amount.

For MasterCard the total amount of sales tax on the total purchase must be between 0.1% and 30 % of the total pre-tax transaction amount; zeros indicate that the card acceptor is capable of transmitting the tax amount and the tax amount is zero.

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.

level_2_tax_indicator Property

This property indicates the taxable status of the transaction.

Syntax

def get_level_2_tax_indicator() -> int: ...
def set_level_2_tax_indicator(value: int) -> None: ...

level_2_tax_indicator = property(get_level_2_tax_indicator, set_level_2_tax_indicator)

Default Value

0

Remarks

This field indicates the taxable status of the transaction. Possible values are:

lodging_charge_type Property

Type of charge made at a hotel.

Syntax

def get_lodging_charge_type() -> int: ...
def set_lodging_charge_type(value: int) -> None: ...

lodging_charge_type = property(get_lodging_charge_type, set_lodging_charge_type)

Default Value

0

Remarks

This property contains an indicator used to identify a hotel charge type. It must contain one of the values defined below:

• lctLodging (0)
• lctRestaurant (1)
• lctGiftShop (2)

Note, this property is only applicable when using the Hotel industry_type.

lodging_phone_number Property

Phone number of the property the customer stayed at.

Syntax

def get_lodging_phone_number() -> str: ...
def set_lodging_phone_number(value: str) -> None: ...

lodging_phone_number = property(get_lodging_phone_number, set_lodging_phone_number)

Default Value

""

Remarks

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

Note, this property is only applicable when using the Hotel industry_type.

lodging_reference_number Property

A reference number assigned by the hotel/lodging establishment.

Syntax

def get_lodging_reference_number() -> str: ...
def set_lodging_reference_number(value: str) -> None: ...

lodging_reference_number = property(get_lodging_reference_number, set_lodging_reference_number)

Default Value

""

Remarks

This is a 9 character identifier assigned by the hotel/lodging for the transaction.

merchant_service_phone Property

The merchant's phone number, used to assist cardholders.

Syntax

def get_merchant_service_phone() -> str: ...
def set_merchant_service_phone(value: str) -> None: ...

merchant_service_phone = property(get_merchant_service_phone, set_merchant_service_phone)

Default Value

""

Remarks

This property specifies a 10 digit phone number which cardholders can call for assistance.

This value is required for fitRcMOTO transactions. It is recommended but not required for fitRcDirectMarketing and fitRcHotel transactions.

merchant_url Property

The URL of the site performing the ECommerce transaction.

Syntax

def get_merchant_url() -> str: ...
def set_merchant_url(value: str) -> None: ...

merchant_url = property(get_merchant_url, set_merchant_url)

Default Value

""

Remarks

This property specifies the URL of the merchant's site.

For Visa and Discover transactions this value is limited to 13 characters. For all other card types this value is limited to 32 characters.

This is only applicable when the industry_type is set to fitRcDirectMarketing or fitRcHotel.

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.

program_indicator Property

Indicates the reason for the charge in a hotel transaction.

Syntax

def get_program_indicator() -> int: ...
def set_program_indicator(value: int) -> None: ...

program_indicator = property(get_program_indicator, set_program_indicator)

Default Value

1

Remarks

This is used to specify the program indicator for a hotel/lodging transaction. This property is not applicable for Mastercards.

Valid Values:

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 10 bytes value. The value must be unique within a day for a given merchant id and terminal id. The Reference Number entered in the DetailRecord should be the same as the Reference Number submitted in the original transaction.

room_number Property

The Room Number assigned by the hotel.

Syntax

def get_room_number() -> str: ...
def set_room_number(value: str) -> None: ...

room_number = property(get_room_number, set_room_number)

Default Value

""

Remarks

This is a 6 character room number code assigned by the hotel during the transaction.

room_rate Property

The daily room rate in a hotel transaction.

Syntax

def get_room_rate() -> str: ...
def set_room_rate(value: str) -> None: ...

room_rate = property(get_room_rate, set_room_rate)

Default Value

""

Remarks

This property contains the daily rate for one room at the lodging property.

room_tax Property

The daily room tax amount.

Syntax

def get_room_tax() -> str: ...
def set_room_tax(value: str) -> None: ...

room_tax = property(get_room_tax, set_room_tax)

Default Value

""

Remarks

This property contains the daily Room Tax for lodging.

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

"0"

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

This field must always be greater than zero.

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.

stan Property

The merchant assigned System Trace Audit Number(STAN).

Syntax

def get_stan() -> str: ...
def set_stan(value: str) -> None: ...

stan = property(get_stan, set_stan)

Default Value

""

Remarks

This property represents a six digit number assigned by the merchant to uniquely reference the transaction. This number must be unique within a day per Merchant ID and Terminal ID.

Valid values are from 000001 to 999999 inclusive.

total_authorized_amount Property

Sum total of all the original authorization and all subsequent incremental authorizations.

Syntax

def get_total_authorized_amount() -> str: ...
def set_total_authorized_amount(value: str) -> None: ...

total_authorized_amount = property(get_total_authorized_amount, set_total_authorized_amount)

Default Value

""

Remarks

When supporting incremental authorizations, you must manually keep track of the sum of all authorizations made for a single transaction (all based on the same transaction id). This total must be added to the total_authorized_amount property of the detail record associated with the first authorization. Only one detail record should be submitted no matter how many incremental authorizations are attached to the transaction.

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 explains the Transaction Types in detail:

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 a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode.

Syntax

def get_detail_aggregate() -> str: ...

Remarks

This method will return a detail aggregate representing the transaction. After calling auth_only or sale call this method to obtain a detail aggregate. The aggregate will be required when calling capture or reverse.

When using Terminal Capture Settlement Mode this aggregate must be passed to the FDMSRcSettle 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 FDMSRcDetailrecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

To set the aggregate before calling capture reverse or send_settlement call set_detail_aggregate. Save this aggregate in a secure location.

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 FDMSRcRetail or FDMSRcECommerce class, parses it, and then fills all the properties of the FDMSRcDetailrecord class. While normally you can pass the results of the get_detail_aggregate method call directly to the FDMSRcSettle class, sometimes it is necessary to adjust the contents of the XML aggregate first.

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

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

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

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

FDMSRcDetailRecord Config Settings

Base Config Settings

FDMSRcDetailRecord Errors

FDMSRcDetailRecord Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	592   Invalid or unparseable aggregate.
	593   Verification of post data failed: Invalid mix of properties for the current method call.
	605   Invalid CardType.