FDMSRcDetailRecord Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPaymentsSDK.Fdmsrcdetailrecord

Remarks

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

To create an off-line Refund, first set the 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ApprovalCode Property (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public var approvalCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=approvalCode,setter=setApprovalCode:) NSString* approvalCode;

- (NSString*)approvalCode;
- (void)setApprovalCode :(NSString*)newApprovalCode;

Default Value

""

Remarks

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

ArrivalDate Property (FDMSRcDetailRecord Module)

The arrival date of the guest.

Syntax

• Swift
• Objective-C

public var arrivalDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=arrivalDate,setter=setArrivalDate:) NSString* arrivalDate;

- (NSString*)arrivalDate;
- (void)setArrivalDate :(NSString*)newArrivalDate;

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.

CardEntryDataSource Property (FDMSRcDetailRecord Module)

This property identifies the source of the customer data.

Syntax

• Swift
• Objective-C

public var cardEntryDataSource: FdmsrcdetailrecordCardEntryDataSources {
  get {...}
  set {...}
}

public enum FdmsrcdetailrecordCardEntryDataSources: Int32 {
  case edsTrack1 = 0
  case edsTrack2 = 1
  case edsManualEntryTrack1Capable = 2
  case edsManualEntryTrack2Capable = 3
  case edsManualEntryNoCardReader = 4
  case edsTrack1Contactless = 5
  case edsTrack2Contactless = 6
  case edsManualEntryContactlessCapable = 7
  case edsIVR = 8
  case edsKiosk = 9
}

@property (nonatomic,readwrite,assign,getter=cardEntryDataSource,setter=setCardEntryDataSource:) int cardEntryDataSource;

- (int)cardEntryDataSource;
- (void)setCardEntryDataSource :(int)newCardEntryDataSource;

Default Value

0

Remarks

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

CardExpMonth Property (FDMSRcDetailRecord Module)

Expiration month of the credit card specified in CardNumber .

Syntax

• Swift
• Objective-C

public var cardExpMonth: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardExpMonth,setter=setCardExpMonth:) int cardExpMonth;

- (int)cardExpMonth;
- (void)setCardExpMonth :(int)newCardExpMonth;

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.

CardExpYear Property (FDMSRcDetailRecord Module)

Expiration year of the credit card specified in CardNumber .

Syntax

• Swift
• Objective-C

public var cardExpYear: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardExpYear,setter=setCardExpYear:) int cardExpYear;

- (int)cardExpYear;
- (void)setCardExpYear :(int)newCardExpYear;

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.

CardholderName Property (FDMSRcDetailRecord Module)

The name of the Cardholder.

Syntax

• Swift
• Objective-C

public var cardholderName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardholderName,setter=setCardholderName:) NSString* cardholderName;

- (NSString*)cardholderName;
- (void)setCardholderName :(NSString*)newCardholderName;

Default Value

""

Remarks

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

CardNumber Property (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public var cardNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardNumber,setter=setCardNumber:) NSString* cardNumber;

- (NSString*)cardNumber;
- (void)setCardNumber :(NSString*)newCardNumber;

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.

CashBack Property (FDMSRcDetailRecord Module)

Amount of cash that was returned to the customer.

Syntax

• Swift
• Objective-C

public var cashBack: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cashBack,setter=setCashBack:) NSString* cashBack;

- (NSString*)cashBack;
- (void)setCashBack :(NSString*)newCashBack;

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.

DepartureDate Property (FDMSRcDetailRecord Module)

The departure date of the guest.

Syntax

• Swift
• Objective-C

public var departureDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=departureDate,setter=setDepartureDate:) NSString* departureDate;

- (NSString*)departureDate;
- (void)setDepartureDate :(NSString*)newDepartureDate;

Default Value

""

Remarks

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

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

Duration Property (FDMSRcDetailRecord Module)

Length of hotel stay in days.

Syntax

• Swift
• Objective-C

public var duration: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=duration,setter=setDuration:) int duration;

- (int)duration;
- (void)setDuration :(int)newDuration;

Default Value

1

Remarks

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

ECI Property (FDMSRcDetailRecord Module)

Identifies the security level of the ECommerce transaction.

Syntax

• Swift
• Objective-C

public var eci: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=ECI,setter=setECI:) NSString* ECI;

- (NSString*)ECI;
- (void)setECI :(NSString*)newECI;

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:

ExtraCharges Property (FDMSRcDetailRecord Module)

List of extra charges for hotel transactions.

Syntax

• Swift
• Objective-C

public var extraCharges: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=extraCharges,setter=setExtraCharges:) NSString* extraCharges;

- (NSString*)extraCharges;
- (void)setExtraCharges :(NSString*)newExtraCharges;

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.

FolioNumber Property (FDMSRcDetailRecord Module)

The Folio or Room Agreement number assigned by the hotel.

Syntax

• Swift
• Objective-C

public var folioNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=folioNumber,setter=setFolioNumber:) NSString* folioNumber;

- (NSString*)folioNumber;
- (void)setFolioNumber :(NSString*)newFolioNumber;

Default Value

""

Remarks

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

HotelNoShow Property (FDMSRcDetailRecord Module)

Indicates whether the guest did not show.

Syntax

• Swift
• Objective-C

public var hotelNoShow: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=hotelNoShow,setter=setHotelNoShow:) BOOL hotelNoShow;

- (BOOL)hotelNoShow;
- (void)setHotelNoShow :(BOOL)newHotelNoShow;

Default Value

False

Remarks

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

IndustryType Property (FDMSRcDetailRecord Module)

The merchant's industry type.

Syntax

• Swift
• Objective-C

public var industryType: FdmsrcdetailrecordIndustryTypes {
  get {...}
  set {...}
}

public enum FdmsrcdetailrecordIndustryTypes: Int32 {
  case fitRcUnknown = 0
  case fitRcRetail = 1
  case fitRcRestaurant = 2
  case fitRcGroceryStore = 3
  case fitRcDirectMarketing = 4
  case fitRcHotel = 5
  case fitRcMOTO = 6
}

@property (nonatomic,readwrite,assign,getter=industryType,setter=setIndustryType:) int industryType;

- (int)industryType;
- (void)setIndustryType :(int)newIndustryType;

Default Value

0

Remarks

The merchant's industry type. Possible values are:

InstallmentCount Property (FDMSRcDetailRecord Module)

Total number of installments (installment transactions only).

Syntax

• Swift
• Objective-C

public var installmentCount: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=installmentCount,setter=setInstallmentCount:) int installmentCount;

- (int)installmentCount;
- (void)setInstallmentCount :(int)newInstallmentCount;

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

InstallmentNumber Property (FDMSRcDetailRecord Module)

Current installment number (installment transactions only).

Syntax

• Swift
• Objective-C

public var installmentNumber: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=installmentNumber,setter=setInstallmentNumber:) int installmentNumber;

- (int)installmentNumber;
- (void)setInstallmentNumber :(int)newInstallmentNumber;

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

Level2 Property (FDMSRcDetailRecord Module)

Specifies Level 2 (purchasing card information).

Syntax

• Swift
• Objective-C

public var level2: FDMSRcLevel2 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=level2CustomerReferenceNumber,setter=setLevel2CustomerReferenceNumber:) NSString* level2CustomerReferenceNumber;

- (NSString*)level2CustomerReferenceNumber;
- (void)setLevel2CustomerReferenceNumber :(NSString*)newLevel2CustomerReferenceNumber;

@property (nonatomic,readwrite,assign,getter=level2DestinationCountryCode,setter=setLevel2DestinationCountryCode:) NSString* level2DestinationCountryCode;

- (NSString*)level2DestinationCountryCode;
- (void)setLevel2DestinationCountryCode :(NSString*)newLevel2DestinationCountryCode;

@property (nonatomic,readwrite,assign,getter=level2DestinationPostalCode,setter=setLevel2DestinationPostalCode:) NSString* level2DestinationPostalCode;

- (NSString*)level2DestinationPostalCode;
- (void)setLevel2DestinationPostalCode :(NSString*)newLevel2DestinationPostalCode;

@property (nonatomic,readwrite,assign,getter=level2DiscountAmount,setter=setLevel2DiscountAmount:) NSString* level2DiscountAmount;

- (NSString*)level2DiscountAmount;
- (void)setLevel2DiscountAmount :(NSString*)newLevel2DiscountAmount;

@property (nonatomic,readwrite,assign,getter=level2DutyAmount,setter=setLevel2DutyAmount:) NSString* level2DutyAmount;

- (NSString*)level2DutyAmount;
- (void)setLevel2DutyAmount :(NSString*)newLevel2DutyAmount;

@property (nonatomic,readwrite,assign,getter=level2FreightAmount,setter=setLevel2FreightAmount:) NSString* level2FreightAmount;

- (NSString*)level2FreightAmount;
- (void)setLevel2FreightAmount :(NSString*)newLevel2FreightAmount;

@property (nonatomic,readwrite,assign,getter=level2MerchantTaxId,setter=setLevel2MerchantTaxId:) NSString* level2MerchantTaxId;

- (NSString*)level2MerchantTaxId;
- (void)setLevel2MerchantTaxId :(NSString*)newLevel2MerchantTaxId;

@property (nonatomic,readwrite,assign,getter=level2ProductDescription,setter=setLevel2ProductDescription:) NSString* level2ProductDescription;

- (NSString*)level2ProductDescription;
- (void)setLevel2ProductDescription :(NSString*)newLevel2ProductDescription;

@property (nonatomic,readwrite,assign,getter=level2PurchaseIdentifier,setter=setLevel2PurchaseIdentifier:) NSString* level2PurchaseIdentifier;

- (NSString*)level2PurchaseIdentifier;
- (void)setLevel2PurchaseIdentifier :(NSString*)newLevel2PurchaseIdentifier;

@property (nonatomic,readwrite,assign,getter=level2ShipFromPostalCode,setter=setLevel2ShipFromPostalCode:) NSString* level2ShipFromPostalCode;

- (NSString*)level2ShipFromPostalCode;
- (void)setLevel2ShipFromPostalCode :(NSString*)newLevel2ShipFromPostalCode;

@property (nonatomic,readwrite,assign,getter=level2TaxAmount,setter=setLevel2TaxAmount:) NSString* level2TaxAmount;

- (NSString*)level2TaxAmount;
- (void)setLevel2TaxAmount :(NSString*)newLevel2TaxAmount;

@property (nonatomic,readwrite,assign,getter=level2TaxIndicator,setter=setLevel2TaxIndicator:) int level2TaxIndicator;

- (int)level2TaxIndicator;
- (void)setLevel2TaxIndicator :(int)newLevel2TaxIndicator;

 

Default Value

0

Remarks

This property specifies Level 2 (purchasing card information).

The values required for Level 2 transaction depend on the card type. The following tables indicate which properties are valid for what card type:

American Express

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DestinationPostalCode (required)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2ProductDescription (required)
• Level2PurchaseIdentifier (required)
• Level2MerchantTaxId
• Level2ShipFromPostalCode
• Level2TaxAmount
• Level2TaxIndicator

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode
• Level2MerchantTaxId

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2MerchantTaxId (required)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode

LodgingChargeType Property (FDMSRcDetailRecord Module)

Type of charge made at a hotel.

Syntax

• Swift
• Objective-C

public var lodgingChargeType: FdmsrcdetailrecordLodgingChargeTypes {
  get {...}
  set {...}
}

public enum FdmsrcdetailrecordLodgingChargeTypes: Int32 {
  case lctLodging = 0
  case lctRestaurant = 1
  case lctGiftShop = 2
}

@property (nonatomic,readwrite,assign,getter=lodgingChargeType,setter=setLodgingChargeType:) int lodgingChargeType;

- (int)lodgingChargeType;
- (void)setLodgingChargeType :(int)newLodgingChargeType;

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.

LodgingPhoneNumber Property (FDMSRcDetailRecord Module)

Phone number of the property the customer stayed at.

Syntax

• Swift
• Objective-C

public var lodgingPhoneNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=lodgingPhoneNumber,setter=setLodgingPhoneNumber:) NSString* lodgingPhoneNumber;

- (NSString*)lodgingPhoneNumber;
- (void)setLodgingPhoneNumber :(NSString*)newLodgingPhoneNumber;

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.

LodgingReferenceNumber Property (FDMSRcDetailRecord Module)

A reference number assigned by the hotel/lodging establishment.

Syntax

• Swift
• Objective-C

public var lodgingReferenceNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=lodgingReferenceNumber,setter=setLodgingReferenceNumber:) NSString* lodgingReferenceNumber;

- (NSString*)lodgingReferenceNumber;
- (void)setLodgingReferenceNumber :(NSString*)newLodgingReferenceNumber;

Default Value

""

Remarks

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

MerchantServicePhone Property (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public var merchantServicePhone: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantServicePhone,setter=setMerchantServicePhone:) NSString* merchantServicePhone;

- (NSString*)merchantServicePhone;
- (void)setMerchantServicePhone :(NSString*)newMerchantServicePhone;

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.

MerchantURL Property (FDMSRcDetailRecord Module)

The URL of the site performing the ECommerce transaction.

Syntax

• Swift
• Objective-C

public var merchantURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantURL,setter=setMerchantURL:) NSString* merchantURL;

- (NSString*)merchantURL;
- (void)setMerchantURL :(NSString*)newMerchantURL;

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.

OrderNumber Property (FDMSRcDetailRecord Module)

A merchant assigned order number to uniquely reference the transaction.

Syntax

• Swift
• Objective-C

public var orderNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=orderNumber,setter=setOrderNumber:) NSString* orderNumber;

- (NSString*)orderNumber;
- (void)setOrderNumber :(NSString*)newOrderNumber;

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.

ProgramIndicator Property (FDMSRcDetailRecord Module)

Indicates the reason for the charge in a hotel transaction.

Syntax

• Swift
• Objective-C

public var programIndicator: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=programIndicator,setter=setProgramIndicator:) int programIndicator;

- (int)programIndicator;
- (void)setProgramIndicator :(int)newProgramIndicator;

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:

ReferenceNumber Property (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public var referenceNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=referenceNumber,setter=setReferenceNumber:) NSString* referenceNumber;

- (NSString*)referenceNumber;
- (void)setReferenceNumber :(NSString*)newReferenceNumber;

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.

RoomNumber Property (FDMSRcDetailRecord Module)

The Room Number assigned by the hotel.

Syntax

• Swift
• Objective-C

public var roomNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=roomNumber,setter=setRoomNumber:) NSString* roomNumber;

- (NSString*)roomNumber;
- (void)setRoomNumber :(NSString*)newRoomNumber;

Default Value

""

Remarks

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

RoomRate Property (FDMSRcDetailRecord Module)

The daily room rate in a hotel transaction.

Syntax

• Swift
• Objective-C

public var roomRate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=roomRate,setter=setRoomRate:) NSString* roomRate;

- (NSString*)roomRate;
- (void)setRoomRate :(NSString*)newRoomRate;

Default Value

""

Remarks

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

RoomTax Property (FDMSRcDetailRecord Module)

The daily room tax amount.

Syntax

• Swift
• Objective-C

public var roomTax: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=roomTax,setter=setRoomTax:) NSString* roomTax;

- (NSString*)roomTax;
- (void)setRoomTax :(NSString*)newRoomTax;

Default Value

""

Remarks

This property contains the daily Room Tax for lodging.

SettlementAmount Property (FDMSRcDetailRecord Module)

The amount that the customer will be charged.

Syntax

• Swift
• Objective-C

public var settlementAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=settlementAmount,setter=setSettlementAmount:) NSString* settlementAmount;

- (NSString*)settlementAmount;
- (void)setSettlementAmount :(NSString*)newSettlementAmount;

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.

STAN Property (FDMSRcDetailRecord Module)

The merchant assigned System Trace Audit Number(STAN).

Syntax

• Swift
• Objective-C

public var stan: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=STAN,setter=setSTAN:) NSString* STAN;

- (NSString*)STAN;
- (void)setSTAN :(NSString*)newSTAN;

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.

TotalAuthorizedAmount Property (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public var totalAuthorizedAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=totalAuthorizedAmount,setter=setTotalAuthorizedAmount:) NSString* totalAuthorizedAmount;

- (NSString*)totalAuthorizedAmount;
- (void)setTotalAuthorizedAmount :(NSString*)newTotalAuthorizedAmount;

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.

TransactionType Property (FDMSRcDetailRecord Module)

Indicates transaction type for this detail record.

Syntax

• Swift
• Objective-C

public var transactionType: FdmsrcdetailrecordTransactionTypes {
  get {...}
  set {...}
}

public enum FdmsrcdetailrecordTransactionTypes: Int32 {
  case fttNotSet = 0
  case fttAuthorization = 1
  case fttAuthorizationWithCashback = 2
  case fttVoiceApproved = 3
  case fttEBTCashAuthorizationWithoutCashback = 4
  case fttRefundCredit = 5
  case fttEBTCashAuthorizationWithCashback = 6
  case fttEBTCashAuthorizationCashbackOnly = 7
  case fttEBTSNAPAuthorization = 8
  case fttEBTSNAPVoucherClear = 9
  case fttNoShowCredit = 10
  case fttNoShowDebit = 11
  case fttMOTOAuthorization = 12
  case fttRefundDebit = 13
  case fttRefundEBTSNAP = 14
}

@property (nonatomic,readwrite,assign,getter=transactionType,setter=setTransactionType:) int transactionType;

- (int)transactionType;
- (void)setTransactionType :(int)newTransactionType;

Default Value

0

Remarks

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

Config Method (FDMSRcDetailRecord Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public func getDetailAggregate() throws -> String

- (NSString*)getDetailAggregate;

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 .

To set the aggregate before calling Capture Reverse or SendSettlement call SetDetailAggregate. Save this aggregate in a secure location.

ParseAggregate Method (FDMSRcDetailRecord Module)

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

Syntax

• Swift
• Objective-C

public func parseAggregate(aggregate: String) throws -> Void

- (void)parseAggregate:(NSString*)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 (FDMSRcDetailRecord Module)

Clears all properties to their default values.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

Error Event (FDMSRcDetailRecord Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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.

FDMSRcLevel2 Type

Specifies Level 2 (purchasing card) information.

Remarks

This type specifies Level 2 (purchasing card) information.

Fields

Constructors

public init()

Config Settings (FDMSRcDetailRecord Module)

FDMSRcDetailRecord Config Settings

Base Config Settings

Trappable Errors (FDMSRcDetailRecord Module)

FDMSRcDetailRecord Errors