FDMSDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSDetailRecord class is a tool used to create off-line Credit or Force transactions to be settled by the FDMSSETTLE class. The FDMSDetailRecord class may also be used to modify the XML aggregates returned by the FDMSRETAIL or FDMSECOMMERCE class's GetDetailAggregate method.

Syntax

class dpaymentssdk.FDMSDetailRecord

Remarks

Credit and Force transactions are off-line transactions. This means that there is no authorization of funds using the FDMSECommerce, FDMSRetail classs. Instead, you must manually add these transactions to the settlement batch. The FDMSDetailRecord class can be used to create these transactions, which can then be added to the FDMSSettle class's DetailRecord array property.

To create a Credit, first set the transaction_type to fttCredit, and then set the industry_type. card_entry_data_source, and direct_marketing_type based on whether you have a card reader, and how your customer is authenticated. The following example shows how this should be set for Direct Marketing:

FDMSDetailRecord.TransactionType = fttCredit FDMSDetailRecord.IndustryType = fitDirectMarketing FDMSDetailRecord.CardEntryDataSource = edsManualEntryNoCardReader FDMSDetailRecord.DirectMarketingType = dmECommerce

Next, set the card_number, card_exp_month, card_exp_year, settlement_amount, and the current transaction_date and transaction_time. Since this example is a Direct Marketing transaction, we're also adding the purchase_identifier. Note that since this is an off-line transaction, the authorized_amount MUST be either zero or empty string.

FDMSDetailRecord.CardNumber = "4444333322221111" FDMSDetailRecord.CardExpMonth = 3 FDMSDetailRecord.CardExpYear = 2019 FDMSDetailRecord.AuthorizedAmount = "0" FDMSDetailRecord.SettlementAmount = "5000" '$50.00 FDMSDetailRecord.TransTime = "123456" ' Current time (12:34:56) FDMSDetailRecord.TransDate = "040506" ' Current date (MMDDYY) FDMSDetailRecord.PurchaseIdentifier = "123456"

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

FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

Forced transactions are similar to credits, 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 response_approval_code property. The following example shows a Force transaction in a Retail environment.

FDMSDetailRecord.TransactionType = fttForce FDMSDetailRecord.IndustryType = fitRetail FDMSDetailRecord.CardEntryDataSource = edsTrack1 FDMSDetailRecord.CardNumber = "4444333322221111" FDMSDetailRecord.CardExpMonth = 3 FDMSDetailRecord.CardExpYear = 2019 FDMSDetailRecord.AuthorizedAmount = "0" FDMSDetailRecord.SettlementAmount = "500000" '$5000.00 FDMSDetailRecord.TransTime = "123456" ' Current time (12:34:56) FDMSDetailRecord.TransDate = "040506" ' Current date (MMDDYY) FDMSDetailRecord.ResponseApprovalCode = "123456" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecord(0) = FDMSDetailRecord.GetDetailAggregate()

In addition to creating Credit and Force transactions, the FDMSDetailRecord class can be used to adjust the Detail Records returned from the FDMSECommerce and FDMSRetail classs. The most common reasons to modify these detail records are to add a gratuity (tip) to a charge (fitResturant industry_type), or to add a PurchaseIdentifier or Installment payment info (fitDirectMarketing industry_type) to the detail record.

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

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

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

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.

authorized_amount Property

Original amount authorized before any reversals.

Syntax

def get_authorized_amount() -> str: ...
def set_authorized_amount(value: str) -> None: ...

authorized_amount = property(get_authorized_amount, set_authorized_amount)

Default Value

"0"

Remarks

This field contains the transaction amount from the original authorization request message. 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 gratuity) this property should still reflect the original unchanged amount from the initial authorization request.

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.

card_level_results Property

Card Level result code returned only for Visa transactions.

Syntax

def get_card_level_results() -> str: ...
def set_card_level_results(value: str) -> None: ...

card_level_results = property(get_card_level_results, set_card_level_results)

Default Value

""

Remarks

This property contains a two-character code created by Visa during the authorization process. If the transaction being settled was authorized online, this field must contain the value returned in the authorization response. If the transaction is a credit or was otherwise processed offline, this field should be defaulted to "" (empty string) or two spaces.

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.

debit_receipt Property

Merchant-generated number that identifies the debit or EBT transaction.

Syntax

def get_debit_receipt() -> str: ...
def set_debit_receipt(value: str) -> None: ...

debit_receipt = property(get_debit_receipt, set_debit_receipt)

Default Value

""

Remarks

A merchant must generate a ReceiptNumber for debit and EBT transactions made with the FDMSDebit and FDMSBenefit classs. This receipt number must be passed to the settlement unmodified in this debit_receipt property.

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

The following types of transactions are supported by this class:

The value of this property will be ignored when the industry_type is anything other than fitDirectMarketing.

eci Property

Electronic Commerce Indicator from the original authorization request.

Syntax

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

eci = property(get_eci, set_eci)

Default Value

""

Remarks

This field should be identical to the ECI property from the original authorization request. This property is used only for eCommerce and Direct Marketing (card not present) transactions, and is ignored for all Card Present (Retail) transactions.

gratuity Property

Gratuity amount for settling restaurant industry transactions.

Syntax

def get_gratuity() -> str: ...
def set_gratuity(value: str) -> None: ...

gratuity = property(get_gratuity, set_gratuity)

Default Value

""

Remarks

This 5 character numeric field contains the gratuity (tip) amount of the transaction being settled. This amount is only sent when the CFDMSSettle class's industry_type is set to "Restaurant".

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.

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 FDMSECommerce class.

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

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

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 FDMSECommerce class.

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

FDMSECommerce.TransactionType = dmtInstallment FDMSECommerce.TransactionAmount = "1995" FDMSECommerce.Authorize() FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate() FDMSDetailRecord.InstallmentCount = 3 FDMSDetailRecord.InstallmentNumber = 1 FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

purchase_identifier Property

Optional purchase order number assigned by the merchant.

Syntax

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

purchase_identifier = property(get_purchase_identifier, set_purchase_identifier)

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and has a maximum length of 25 characters. For American Express transactions, only use the first 9 spaces.

response_approval_code Property

Response Approval Code from the original authorization response.

Syntax

def get_response_approval_code() -> str: ...
def set_response_approval_code(value: str) -> None: ...

response_approval_code = property(get_response_approval_code, set_response_approval_code)

Default Value

""

Remarks

This field contains the authorization code obtained from the original authorization response. If the transaction is a credit or other non-approved transaction type, this property must be empty.

response_avs_result Property

Address Verification Code from the original authorization response.

Syntax

def get_response_avs_result() -> str: ...
def set_response_avs_result(value: str) -> None: ...

response_avs_result = property(get_response_avs_result, set_response_avs_result)

Default Value

"0"

Remarks

This field contains a one character Address Verification (result) Code. This field contains the value returned in the original authorization response message. If the transaction is a credit or was otherwise processed off-line, this field should be defaulted to "0".

response_returned_aci Property

Authorization Characteristics Indicator from the original authorization response.

Syntax

def get_response_returned_aci() -> str: ...
def set_response_returned_aci(value: str) -> None: ...

response_returned_aci = property(get_response_returned_aci, set_response_returned_aci)

Default Value

""

Remarks

This field contains a one character returned Authorization Characteristics Indicator. This indicator provides information on conditions or characteristics of the authorization code. If the transaction being settled was authorized on-line, this field must contain the value returned in that authorization response. If the transaction is a credit or was otherwise processed off-line, this field should be defaulted to SPACE.

server_id Property

Specifies the employee that served the customer. Used for restaurants only.

Syntax

def get_server_id() -> str: ...
def set_server_id(value: str) -> None: ...

server_id = property(get_server_id, set_server_id)

Default Value

""

Remarks

This property pertains to restaurant transactions, and should be set with a merchant-assigned server Id code. This code identifies the employee which served the customer at the restaurant. This property is required for restaurant transactions, and is ignored for all other industry types. The maximum length for this property is 3.

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). If using the Restaurant industry_type, you may also increase the settlement_amount by adding any gratuity (if present).

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.

ticket_number Property

Ticket (receipt) number for this transaction.

Syntax

def get_ticket_number() -> str: ...
def set_ticket_number(value: str) -> None: ...

ticket_number = property(get_ticket_number, set_ticket_number)

Default Value

""

Remarks

This property contains the Ticket number or Receipt of Charge (ROC) for this transaction. This may be optionally sent for any industry_type, but it is required for Restaurant transactions that include a gratuity.

The maximum length of this property is 10 digits.

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

transaction_date Property

Local Transaction Date (in MMDDYY format) from the original authorization response.

Syntax

def get_transaction_date() -> str: ...
def set_transaction_date(value: str) -> None: ...

transaction_date = property(get_transaction_date, set_transaction_date)

Default Value

"010100"

Remarks

This six digit field contains a local transaction date associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value returned in the original authorization response message. If the transaction was processed off-line, this field must contain a Point of Sale (POS) device generated date. This field must appear in MMDDYY format.

transaction_id Property

Transaction Identifier from the original authorization response.

Syntax

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

transaction_id = property(get_transaction_id, set_transaction_id)

Default Value

"000000000000000"

Remarks

This 15-character field contains a Transaction Identifier associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value (if returned) from the original authorization response message. If a value was not returned in the authorization response or the transaction was processed off-line, this field must be defaulted to zeros.

transaction_time Property

Local transaction time from the original authorization response.

Syntax

def get_transaction_time() -> str: ...
def set_transaction_time(value: str) -> None: ...

transaction_time = property(get_transaction_time, set_transaction_time)

Default Value

"000000"

Remarks

This six digit field contains a local transaction time associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value generated by the FDMSECommerce or FDMSRetail class at the time of the sale. If the transaction was processed off-line, this field must contain a Point of Sale (POS) device generated time. This field must appear in HHMMSS format.

NOTE: This property is only applicable when settling a debit or EBT transaction, or a credit card transaction that includes Level 2 data, and may be ignored if such data is not being sent.

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:

Note: The fttSale and fttVoid transaction_types require a previous authorization to work on. fttForce and fttCredit, however, are offline transactions. This means there is no original authorization to work from. The transaction is created solely with this class's properties and is settled without ever having been authorized. Just fill out the properties and sent the FDMSSettle class's DetailAggregate array property with the results from the FDMSDetailRecord's get_detail_aggregate method. The remaining debit, food stamp, and cash benefit transactions may not be edited, voided, or otherwise modified before settlement. The detail aggregates should be set directly to the FDMSSettle class's DetailAggregate array property, and should never be manipulated with the FDMSDetailRecord class.

validation_code Property

Validation Code from the original authorization response.

Syntax

def get_validation_code() -> str: ...
def set_validation_code(value: str) -> None: ...

validation_code = property(get_validation_code, set_validation_code)

Default Value

""

Remarks

This field contains a four character Transaction Identifier associated with the transaction being settled. If the transaction was authorized on-line, this field must contain the value (if returned) from the original authorization response message. If a value was not returned in the authorization response or the transaction was processed off-line, this field must be empty.

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

For example, to add a gratuity to a charge:

FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate()) FDMSDetailRecord.Gratuity = "500" FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()

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

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

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

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

FDMSDetailRecord Config Settings

Base Config Settings

FDMSDetailRecord Errors

FDMSDetailRecord Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	592   Invalid or unparseable aggregate.
	605   Invalid CardType.