FDMSOmahaDetailRecord Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DPaymentsSDK_FDMSOmahaDetailRecord

Procedural Interface

 dpaymentssdk_fdmsomahadetailrecord_open();
 dpaymentssdk_fdmsomahadetailrecord_close($res);
 dpaymentssdk_fdmsomahadetailrecord_register_callback($res, $id, $function);
 dpaymentssdk_fdmsomahadetailrecord_get_last_error($res);
 dpaymentssdk_fdmsomahadetailrecord_get_last_error_code($res);
 dpaymentssdk_fdmsomahadetailrecord_set($res, $id, $index, $value);
 dpaymentssdk_fdmsomahadetailrecord_get($res, $id, $index);
 dpaymentssdk_fdmsomahadetailrecord_do_config($res, $configurationstring);
 dpaymentssdk_fdmsomahadetailrecord_do_getdetailaggregate($res);
 dpaymentssdk_fdmsomahadetailrecord_do_parseaggregate($res, $aggregate);
 dpaymentssdk_fdmsomahadetailrecord_do_reset($res);

Remarks

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

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

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

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

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

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

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

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

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

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AuthCode Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Authorization Code returned from the server.

Object Oriented Interface

public function getAuthCode();


public function setAuthCode($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 1 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 1, $value );

Default Value

''

Remarks

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

Data Type

String

AuthorizedAmount Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Original amount authorized before any reversals.

Object Oriented Interface

public function getAuthorizedAmount();

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 2 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

AVSResult Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getAVSResult();


public function setAVSResult($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 3 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 3, $value );

Default Value

''

Remarks

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

Valid AVS Codes:

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

Data Type

String

BatchNumber Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getBatchNumber();


public function setBatchNumber($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 4 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 4, $value );

Default Value

0

Remarks

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

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

Valid values: 0-9

Data Type

Integer

BeverageAmount Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

The amount of the restaurant beverage purchase.

Object Oriented Interface

public function getBeverageAmount();


public function setBeverageAmount($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 5 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 5, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

CardType Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 6 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 6, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 7 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 7, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 8 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 8, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 9 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 9, $value );

Default Value

0

Remarks

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

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 10 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 10, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 11 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 11, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 12 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 12, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

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

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 13 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 13, $value );

Default Value

''

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 14 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 14, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

CustomerAddress Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

The customer's street number of the billing address.

Object Oriented Interface

public function getCustomerAddress();


public function setCustomerAddress($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 15 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 15, $value );

Default Value

''

Remarks

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

The maximum length of this configuration setting is 5 characters.

Data Type

String

CustomerCode Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Merchant-assigned customer code.

Object Oriented Interface

public function getCustomerCode();


public function setCustomerCode($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 16 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 16, $value );

Default Value

''

Remarks

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

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

Data Type

String

CustomerZipCode Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getCustomerZipCode();


public function setCustomerZipCode($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 17 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 17, $value );

Default Value

''

Remarks

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

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

Data Type

String

DeviceId Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

POS Device Identification.

Object Oriented Interface

public function getDeviceId();


public function setDeviceId($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 18 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 18, $value );

Default Value

''

Remarks

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

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

The maximum length of this property is 4 characters.

Data Type

String

DirectMarketingType Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Specifies the type of transaction to process.

Object Oriented Interface

public function getDirectMarketingType();


public function setDirectMarketingType($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 19 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 19, $value );

Default Value

0

Remarks

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

The following types of transactions are supported by this class:

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

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

Data Type

Integer

FoodAmount Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

The amount of the restaurant food purchase.

Object Oriented Interface

public function getFoodAmount();


public function setFoodAmount($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 20 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 20, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

IndustryType Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Code which indicates the industry the merchant is engaged in.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 21 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 21, $value );

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.

Data Type

Integer

InvoiceNumber Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Merchant-defined invoice number.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 22 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 22, $value );

Default Value

''

Remarks

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

The maximum length of this property is 8 characters.

Data Type

String

OperatorID Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getOperatorID();


public function setOperatorID($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 23 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 23, $value );

Default Value

''

Remarks

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

The maximum length for this field is 4.

Data Type

String

OrderNumber Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Merchant-defined number identifying the purchase or service.

Object Oriented Interface

public function getOrderNumber();


public function setOrderNumber($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 24 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 24, $value );

Default Value

''

Remarks

This property is used to specify an order number to identify the purchase or service.

The maximum length is 25 characters.

Data Type

String

SettlementAmount Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

The amount that the customer will be charged.

Object Oriented Interface

public function getSettlementAmount();


public function setSettlementAmount($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 25 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 25, $value );

Default Value

''

Remarks

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

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

Data Type

String

ShipToZipCode Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getShipToZipCode();


public function setShipToZipCode($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 26 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 26, $value );

Default Value

''

Remarks

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

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

Data Type

String

TaxAmount Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getTaxAmount();


public function setTaxAmount($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 27 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 27, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

TipAmount Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function getTipAmount();


public function setTipAmount($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 28 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 28, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TPPID Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Third Party Processor Identifier assigned by FDMS.

Object Oriented Interface

public function getTPPID();


public function setTPPID($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 29 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 29, $value );

Default Value

'V4D001'

Remarks

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

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

A VisaIdentifier is also required for Visa transactions.

Data Type

String

TransactionId Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getTransactionId();


public function setTransactionId($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 30 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 30, $value );

Default Value

''

Remarks

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

Data Type

String

TransactionNumber Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

The transaction number for the current transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 31 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 31, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

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

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

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

Data Type

Integer

TransactionType Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Indicates transaction type for this detail record.

Object Oriented Interface

public function getTransactionType();


public function setTransactionType($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 32 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 32, $value );

Default Value

0

Remarks

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

Data Type

Integer

VisaIdentifier Property (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Additional merchant identification field used when authorizing Visa transactions.

Object Oriented Interface

public function getVisaIdentifier();


public function setVisaIdentifier($value);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_get($res, 33 );


dpaymentssdk_fdmsomahadetailrecord_set($res, 33, $value );

Default Value

''

Remarks

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

Data Type

String

Config Method (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_do_config($res, $configurationstring);

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.

GetDetailAggregate Method (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_do_getdetailaggregate($res);

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 ResponseCaptureFlag 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

ParseAggregate Method (DPaymentsSDK_FDMSOmahaDetailRecord Class)

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

Object Oriented Interface

public function doParseAggregate($aggregate);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_do_parseaggregate($res, $aggregate);

Remarks

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

Reset Method (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_FDMSOmahaDetailRecord Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmsomahadetailrecord_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Config Settings (FDMSOmahaDetailRecord Class)

FDMSOmahaDetailRecord Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSOmahaDetailRecord Class)

FDMSOmahaDetailRecord Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors