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.

Class Name

DPaymentsSDK_FDMSRcDetailRecord

Procedural Interface

 dpaymentssdk_fdmsrcdetailrecord_open();
 dpaymentssdk_fdmsrcdetailrecord_close($res);
 dpaymentssdk_fdmsrcdetailrecord_register_callback($res, $id, $function);
 dpaymentssdk_fdmsrcdetailrecord_get_last_error($res);
 dpaymentssdk_fdmsrcdetailrecord_get_last_error_code($res);
 dpaymentssdk_fdmsrcdetailrecord_set($res, $id, $index, $value);
 dpaymentssdk_fdmsrcdetailrecord_get($res, $id, $index);
 dpaymentssdk_fdmsrcdetailrecord_do_config($res, $configurationstring);
 dpaymentssdk_fdmsrcdetailrecord_do_getdetailaggregate($res);
 dpaymentssdk_fdmsrcdetailrecord_do_parseaggregate($res, $aggregate);
 dpaymentssdk_fdmsrcdetailrecord_do_reset($res);

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 TransactionType to fttRefundCredit, and then set the IndustryType and CardEntryDataSource 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 CardNumber, CardExpMonth, CardExpYear, TotalAuthorizedAmount, and SettlementAmount. Note that since this is an off-line transaction, the TotalAuthorizedAmount 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 GetDetailAggregate 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 ApprovalCode 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 IndustryType) 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.

ApprovalCode Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getApprovalCode();


public function setApprovalCode($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 1 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 1, $value );

Default Value

''

Remarks

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

Data Type

String

ArrivalDate Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The arrival date of the guest.

Object Oriented Interface

public function getArrivalDate();


public function setArrivalDate($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 2 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 2, $value );

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.

Data Type

String

CardEntryDataSource Property (DPaymentsSDK_FDMSRcDetailRecord Class)

This property identifies the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 3 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 3, $value );

Default Value

0

Remarks

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

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Expiration month of the credit card specified in CardNumber .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 4 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 4, $value );

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.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Expiration year of the credit card specified in CardNumber .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 5 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 5, $value );

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.

Data Type

Integer

CardholderName Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The name of the Cardholder.

Object Oriented Interface

public function getCardholderName();


public function setCardholderName($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 6 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 6, $value );

Default Value

''

Remarks

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

Data Type

String

CardNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 7 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 7, $value );

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.

Data Type

String

CashBack Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Amount of cash that was returned to the customer.

Object Oriented Interface

public function getCashBack();


public function setCashBack($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 8 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 8, $value );

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.

Data Type

String

DepartureDate Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The departure date of the guest.

Object Oriented Interface

public function getDepartureDate();


public function setDepartureDate($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 9 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 9, $value );

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.

Data Type

String

Duration Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Length of hotel stay in days.

Object Oriented Interface

public function getDuration();


public function setDuration($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 10 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 10, $value );

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.

Data Type

Integer

ECI Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Identifies the security level of the ECommerce transaction.

Object Oriented Interface

public function getECI();


public function setECI($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 11 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 11, $value );

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 IndustryType is set to fitRcDirectMarketing or fitRcHotel.

Data Type

String

ExtraCharges Property (DPaymentsSDK_FDMSRcDetailRecord Class)

List of extra charges for hotel transactions.

Object Oriented Interface

public function getExtraCharges();


public function setExtraCharges($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 12 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 12, $value );

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, ExtraCharges should equal "34".

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

Data Type

String

FolioNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The Folio or Room Agreement number assigned by the hotel.

Object Oriented Interface

public function getFolioNumber();


public function setFolioNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 13 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 13, $value );

Default Value

''

Remarks

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

Data Type

String

HotelNoShow Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Indicates whether the guest did not show.

Object Oriented Interface

public function getHotelNoShow();


public function setHotelNoShow($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 14 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 14, $value );

Default Value

false

Remarks

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

Data Type

Boolean

IndustryType Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 15 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 15, $value );

Default Value

0

Remarks

The merchant's industry type. Possible values are:

Data Type

Integer

InstallmentCount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Total number of installments (installment transactions only).

Object Oriented Interface

public function getInstallmentCount();


public function setInstallmentCount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 16 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 16, $value );

Default Value

0

Remarks

This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber 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()

Data Type

Integer

InstallmentNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Current installment number (installment transactions only).

Object Oriented Interface

public function getInstallmentNumber();


public function setInstallmentNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 17 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 17, $value );

Default Value

0

Remarks

This property is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber 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()

Data Type

Integer

Level2CustomerReferenceNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2CustomerReferenceNumber();


public function setLevel2CustomerReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 18 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 18, $value );

Default Value

''

Remarks

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

If Level2TaxAmount is specified this property is required.

The value may be up to 17 characters in length.

Data Type

String

Level2DestinationCountryCode Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2DestinationCountryCode();


public function setLevel2DestinationCountryCode($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 19 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 19, $value );

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.

Data Type

String

Level2DestinationPostalCode Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2DestinationPostalCode();


public function setLevel2DestinationPostalCode($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 20 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 20, $value );

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 Level2ShipFromPostalCode when the customer takes possession of the items at the merchant location.

The value may be up to 9 characters.

Data Type

String

Level2DiscountAmount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

This property contains the discount amount for the purchase.

Object Oriented Interface

public function getLevel2DiscountAmount();


public function setLevel2DiscountAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 21 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 21, $value );

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.

Data Type

String

Level2DutyAmount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

This property contains the duty amount for this purchase.

Object Oriented Interface

public function getLevel2DutyAmount();


public function setLevel2DutyAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 22 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 22, $value );

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.

Data Type

String

Level2FreightAmount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2FreightAmount();


public function setLevel2FreightAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 23 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 23, $value );

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.

Data Type

String

Level2MerchantTaxId Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2MerchantTaxId();


public function setLevel2MerchantTaxId($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 24 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 24, $value );

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.

Data Type

String

Level2ProductDescription Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2ProductDescription();


public function setLevel2ProductDescription($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 25 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 25, $value );

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.

Data Type

String

Level2PurchaseIdentifier Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2PurchaseIdentifier();


public function setLevel2PurchaseIdentifier($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 26 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 26, $value );

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.

Data Type

String

Level2ShipFromPostalCode Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2ShipFromPostalCode();


public function setLevel2ShipFromPostalCode($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 27 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 27, $value );

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.

Data Type

String

Level2TaxAmount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getLevel2TaxAmount();


public function setLevel2TaxAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 28 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 28, $value );

Default Value

''

Remarks

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

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

For Visa this is the amount of state or provincial tax included in the TransactionAmount. 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.

Data Type

String

Level2TaxIndicator Property (DPaymentsSDK_FDMSRcDetailRecord Class)

This property indicates the taxable status of the transaction.

Object Oriented Interface

public function getLevel2TaxIndicator();


public function setLevel2TaxIndicator($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 29 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 29, $value );

Default Value

0

Remarks

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

Data Type

Integer

LodgingChargeType Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Type of charge made at a hotel.

Object Oriented Interface

public function getLodgingChargeType();


public function setLodgingChargeType($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 30 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 30, $value );

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

Data Type

Integer

LodgingPhoneNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Phone number of the property the customer stayed at.

Object Oriented Interface

public function getLodgingPhoneNumber();


public function setLodgingPhoneNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 31 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 31, $value );

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

Data Type

String

LodgingReferenceNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

A reference number assigned by the hotel/lodging establishment.

Object Oriented Interface

public function getLodgingReferenceNumber();


public function setLodgingReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 32 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 32, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantServicePhone Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getMerchantServicePhone();


public function setMerchantServicePhone($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 33 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 33, $value );

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.

Data Type

String

MerchantURL Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The URL of the site performing the ECommerce transaction.

Object Oriented Interface

public function getMerchantURL();


public function setMerchantURL($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 34 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 34, $value );

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 IndustryType is set to fitRcDirectMarketing or fitRcHotel.

Data Type

String

OrderNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

A merchant assigned order number to uniquely reference the transaction.

Object Oriented Interface

public function getOrderNumber();


public function setOrderNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 35 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 35, $value );

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.

Data Type

String

ProgramIndicator Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Indicates the reason for the charge in a hotel transaction.

Object Oriented Interface

public function getProgramIndicator();


public function setProgramIndicator($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 36 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 36, $value );

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:

Data Type

Integer

ReferenceNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.

Object Oriented Interface

public function getReferenceNumber();


public function setReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 37 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 37, $value );

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.

Data Type

String

RoomNumber Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The Room Number assigned by the hotel.

Object Oriented Interface

public function getRoomNumber();


public function setRoomNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 38 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 38, $value );

Default Value

''

Remarks

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

Data Type

String

RoomRate Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The daily room rate in a hotel transaction.

Object Oriented Interface

public function getRoomRate();


public function setRoomRate($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 39 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 39, $value );

Default Value

''

Remarks

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

Data Type

String

RoomTax Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The daily room tax amount.

Object Oriented Interface

public function getRoomTax();


public function setRoomTax($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 40 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 40, $value );

Default Value

''

Remarks

This property contains the daily Room Tax for lodging.

Data Type

String

SettlementAmount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The amount that the customer will be charged.

Object Oriented Interface

public function getSettlementAmount();


public function setSettlementAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 41 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 41, $value );

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 TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

STAN Property (DPaymentsSDK_FDMSRcDetailRecord Class)

The merchant assigned System Trace Audit Number(STAN).

Object Oriented Interface

public function getSTAN();


public function setSTAN($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 42 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 42, $value );

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.

Data Type

String

TotalAuthorizedAmount Property (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function getTotalAuthorizedAmount();


public function setTotalAuthorizedAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 43 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 43, $value );

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

Data Type

String

TransactionType Property (DPaymentsSDK_FDMSRcDetailRecord Class)

Indicates transaction type for this detail record.

Object Oriented Interface

public function getTransactionType();


public function setTransactionType($value);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_get($res, 44 );


dpaymentssdk_fdmsrcdetailrecord_set($res, 44, $value );

Default Value

0

Remarks

This property indicates the type of transaction that is being settled. The following table explains the Transaction Types in detail:

Data Type

Integer

Config Method (DPaymentsSDK_FDMSRcDetailRecord Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_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_FDMSRcDetailRecord Class)

Returns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode.

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_do_getdetailaggregate($res);

Remarks

This method will return a detail aggregate representing the transaction. After calling AuthOnly 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 SendSettlement call SetDetailAggregate. Save this aggregate in a secure location.

ParseAggregate Method (DPaymentsSDK_FDMSRcDetailRecord Class)

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

Object Oriented Interface

public function doParseAggregate($aggregate);

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_do_parseaggregate($res, $aggregate);

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 GetDetailAggregate method call directly to the FDMSRcSettle class, sometimes it is necessary to adjust the contents of the XML aggregate first.

Reset Method (DPaymentsSDK_FDMSRcDetailRecord Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsrcdetailrecord_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_FDMSRcDetailRecord Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

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.

Config Settings (FDMSRcDetailRecord Class)

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

Trappable Errors (FDMSRcDetailRecord Class)

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.