FDMSLevel2 Module

Properties   Methods   Events   Config Settings   Errors  

The FDMSLevel2 module is a tool used to create Level2 Corporate Purchasing Card addendum aggregates, which can then be passed to the FDMSSETTLE module and settled.

Syntax

DPaymentsSDK.Fdmslevel2

Remarks

The properties required to build a Level 2 addendum depends upon the value of the CardType property. The following tables indicate which properties are valid for what card type:

American Express

• DestinationZip (required)
• PurchaseIdentifier (required)
• TaxAmount (required)

Visa

• PurchaseIdentifier (required)
• CommercialCardType (optional)
• InvoiceNumber (optional)
• DestinationCountry (optional)
• DestinationZip (optional)
• DiscountAmount (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• FreightTaxAmount (optional)
• FreightTaxRate (optional)
• MerchantReference (optional)
• OrderDate (optional)
• ShippedFromZip (optional)
• TaxAmount (optional)

MasterCard

• MerchantTaxId (required)
• MerchantType (required)
• PurchaseIdentifier (required)
• TaxAmount (required)
• CommercialCardType (optional)
• DestinationCountry (optional)
• DestinationState (optional)
• DestinationZip (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• MerchantReference (optional)
• ShippedFromZip (optional)

The following example illustrates how to add Level 2 data to a transaction to be settled:

FDMSECommerce.Authorize() FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "060828" 'September 28th, 2006 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.InvoiceNumber = "CUSTCODE" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum()

Note that while Level 2 addendum data is only applicable to corporate purchasing cards, you may send Level 2 data for all Visa, Master Card, and American Express cards if you wish.

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.

CardType Property (FDMSLevel2 Module)

The card type for which a Level 2 or Level 3 addendum will be created.

Syntax

• Swift
• Objective-C

public var cardType: Fdmslevel2CardTypes {
  get {...}
  set {...}
}

public enum Fdmslevel2CardTypes: Int32 {
  case fctUnknown = 0
  case fctVisa = 1
  case fctMasterCard = 2
  case fctAmericanExpress = 3
}

@property (nonatomic,readwrite,assign,getter=cardType,setter=setCardType:) int cardType;

- (int)cardType;
- (void)setCardType :(int)newCardType;

Default Value

0

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

CommercialCardType Property (FDMSLevel2 Module)

Indicates the type of commercial card being settled.

Syntax

• Swift
• Objective-C

public var commercialCardType: Fdmslevel2CommercialCardTypes {
  get {...}
  set {...}
}

public enum Fdmslevel2CommercialCardTypes: Int32 {
  case fccNotCommercial = 0
  case fccPurchaseCard = 1
  case fccCorporateCard = 2
  case fccBusinessCard = 3
  case fccUnknown = 4
}

@property (nonatomic,readwrite,assign,getter=commercialCardType,setter=setCommercialCardType:) int commercialCardType;

- (int)commercialCardType;
- (void)setCommercialCardType :(int)newCommercialCardType;

Default Value

0

Remarks

Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data in the settlement when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Commercial card transactions settled with Level 2 or Level 3 data must include tax amounts to receive the best interchange rate.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

DestinationCountry Property (FDMSLevel2 Module)

Country the goods are to be shipped to.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=destinationCountry,setter=setDestinationCountry:) NSString* destinationCountry;

- (NSString*)destinationCountry;
- (void)setDestinationCountry :(NSString*)newDestinationCountry;

Default Value

""

Remarks

For Visa and MasterCard transactions, this property contains the three-digit numeric code of the country where the goods are being shipped. These codes are specified by ISO-3166. For the United States, use "840".

The maximum length of this property is 3 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

DestinationState Property (FDMSLevel2 Module)

State or province to which the goods are to be shipped.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=destinationState,setter=setDestinationState:) NSString* destinationState;

- (NSString*)destinationState;
- (void)setDestinationState :(NSString*)newDestinationState;

Default Value

""

Remarks

This property contains the State or Province where purchased goods will be delivered. The maximum length of this property is 3 characters. This property is only used for MasterCard Corporate Purchasing Cards.

DestinationZip Property (FDMSLevel2 Module)

The zip code to which the commodity was shipped.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=destinationZip,setter=setDestinationZip:) NSString* destinationZip;

- (NSString*)destinationZip;
- (void)setDestinationZip :(NSString*)newDestinationZip;

Default Value

""

Remarks

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place. In this case, both DestinationZip and ShippedFromZip should be identical.

The maximum length for this property is 10 characters.

This property is used for Visa, MasterCard, and American Express Corporate Purchasing Cards.

DiscountAmount Property (FDMSLevel2 Module)

Amount of any discount subtracted from the line item totals.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=discountAmount,setter=setDiscountAmount:) NSString* discountAmount;

- (NSString*)discountAmount;
- (void)setDiscountAmount :(NSString*)newDiscountAmount;

Default Value

""

Remarks

This property contains the amount of any discount applied to the transaction by the merchant. This field should be empty if no line item discount applies, or if Level 3 data is attached to the transaction, and contains discount amounts for individual items on an item-by-item basis.

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.

This property is only used for Visa Corporate Purchasing Cards.

DutyAmount Property (FDMSLevel2 Module)

Duty fees (if any) for imported goods.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dutyAmount,setter=setDutyAmount:) NSString* dutyAmount;

- (NSString*)dutyAmount;
- (void)setDutyAmount :(NSString*)newDutyAmount;

Default Value

""

Remarks

This property contains the fee amount associated with the import of the purchased goods.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

FreightAmount Property (FDMSLevel2 Module)

Shipping charges associated with this transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=freightAmount,setter=setFreightAmount:) NSString* freightAmount;

- (NSString*)freightAmount;
- (void)setFreightAmount :(NSString*)newFreightAmount;

Default Value

""

Remarks

This property contains the freight or shipping portion of the total transaction amount.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

FreightTaxAmount Property (FDMSLevel2 Module)

Portion of the FreightAmount that is tax.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=freightTaxAmount,setter=setFreightTaxAmount:) NSString* freightTaxAmount;

- (NSString*)freightTaxAmount;
- (void)setFreightTaxAmount :(NSString*)newFreightTaxAmount;

Default Value

""

Remarks

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the freight or shipping charges of the overall purchase.

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.

This property is only used for Visa Corporate Purchasing Cards.

FreightTaxRate Property (FDMSLevel2 Module)

Rate used to calculate the FreightTaxAmount .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=freightTaxRate,setter=setFreightTaxRate:) NSString* freightTaxRate;

- (NSString*)freightTaxRate;
- (void)setFreightTaxRate :(NSString*)newFreightTaxRate;

Default Value

""

Remarks

This property contains the tax rate used to calculate the FreightTaxAmount. This field has a two-digit implied decimal position, and the maximum length is 4 digits.

This property is only used for Visa Corporate Purchasing Cards.

InvoiceNumber Property (FDMSLevel2 Module)

Customer Reference Identifier.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

Default Value

""

Remarks

This property contains the Customer Reference Indicator, used by the customer to identify the purchase (e.g., the invoice number). The maximum length of this property is 17 characters.

This property is only used for Visa Corporate Purchasing Cards.

MerchantReference Property (FDMSLevel2 Module)

Merchant Reference Number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantReference,setter=setMerchantReference:) NSString* merchantReference;

- (NSString*)merchantReference;
- (void)setMerchantReference :(NSString*)newMerchantReference;

Default Value

""

Remarks

For Master Card, this property contains the code that facilitates merchant/corporation communication and record keeping. For Visa, this property contains the invoice number associated with the VAT invoice (not applicable in the US).

The maximum length of this property is 15 characters for Visa and 17 characters for MasterCard.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

MerchantTaxId Property (FDMSLevel2 Module)

Merchant's government tax Id number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantTaxId,setter=setMerchantTaxId:) NSString* merchantTaxId;

- (NSString*)merchantTaxId;
- (void)setMerchantTaxId :(NSString*)newMerchantTaxId;

Default Value

""

Remarks

This property contains the government-assigned tax identification number of the merchant from whom the goods or services were purchased.

The maximum length of this property is 15 characters. This property is only used for MasterCard Corporate Purchasing Cards.

MerchantType Property (FDMSLevel2 Module)

MasterCard merchant classification code.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantType,setter=setMerchantType:) NSString* merchantType;

- (NSString*)merchantType;
- (void)setMerchantType :(NSString*)newMerchantType;

Default Value

"0000"

Remarks

Merchant Type is a four-position field defined by MasterCard that describes various merchant classifications. Each position in the field has a separate, special meaning for categorizing the merchant. If the data for a particular position is not available, that position must contain a blank. If it is available, it must contain one of the following business codes:

Position 1 - Business Classification

Position 2 - Type of Business Owner Classification

Position 3 - Minority, Small Business, Disadvantaged Certification

Position 4 - Racial or Ethnic Type (Unconditional Majority Owner)

The maximum length of this property is 4 characters. This property is only used for MasterCard Corporate Purchasing Cards.

OrderDate Property (FDMSLevel2 Module)

Date of the order in YYMMDD format.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=orderDate,setter=setOrderDate:) NSString* orderDate;

- (NSString*)orderDate;
- (void)setOrderDate :(NSString*)newOrderDate;

Default Value

""

Remarks

This property contains the purchase order date, and must be supplied in the YYMMDD format.

The maximum length of this field is 6 digits.

This property is only used for Visa Corporate Purchasing Cards.

PurchaseIdentifier Property (FDMSLevel2 Module)

Used to identify the purchase.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=purchaseIdentifier,setter=setPurchaseIdentifier:) NSString* purchaseIdentifier;

- (NSString*)purchaseIdentifier;
- (void)setPurchaseIdentifier :(NSString*)newPurchaseIdentifier;

Default Value

""

Remarks

This field is required for Visa, MasterCard and Amex Level2 transactions.For Visa this field should contain a merchant assigned value to identify the purchase such as the SKU number. For MasterCard this field should contain the code that was supplied to the merchant by the cardholder. For Amex this field should contain the customer reference number. The maximum length of this property is 25 characters.

ShippedFromZip Property (FDMSLevel2 Module)

Zip code the goods are being shipped from.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=shippedFromZip,setter=setShippedFromZip:) NSString* shippedFromZip;

- (NSString*)shippedFromZip;
- (void)setShippedFromZip :(NSString*)newShippedFromZip;

Default Value

""

Remarks

This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

TaxAmount Property (FDMSLevel2 Module)

Sales tax charged in addition to the original TransactionAmount .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=taxAmount,setter=setTaxAmount:) NSString* taxAmount;

- (NSString*)taxAmount;
- (void)setTaxAmount :(NSString*)newTaxAmount;

Default Value

""

Remarks

This property contains the amount of state or provincial (or VAT) tax included in the transaction amount. Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

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.

This property is used for Visa, MasterCard, and American Express Corporate Purchasing Cards.

Config Method (FDMSLevel2 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.

GetAddendum Method (FDMSLevel2 Module)

Returns a Level 2 Purchasing card addendum based on the specified CardType .

Syntax

• Swift
• Objective-C

public func getAddendum() throws -> String

- (NSString*)getAddendum;

Remarks

The properties required to build a Level 2 addendum depends upon the value of the CardType property. The following tables indicate which properties are valid for what card type:

American Express

• DestinationZip (required)
• PurchaseIdentifier (required)
• TaxAmount (required)

Visa

• PurchaseIdentifier (required)
• CommercialCardType (optional)
• InvoiceNumber (optional)
• DestinationCountry (optional)
• DestinationZip (optional)
• DiscountAmount (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• FreightTaxAmount (optional)
• FreightTaxRate (optional)
• MerchantReference (optional)
• OrderDate (optional)
• ShippedFromZip (optional)
• TaxAmount (optional)

MasterCard

• MerchantTaxId (required)
• MerchantType (required)
• PurchaseIdentifier (required)
• TaxAmount (required)
• CommercialCardType (optional)
• DestinationCountry (optional)
• DestinationState (optional)
• DestinationZip (optional)
• DutyAmount (optional)
• FreightAmount (optional)
• MerchantReference (optional)
• ShippedFromZip (optional)

The following example illustrates how to add Level 2 data to a transaction to be settled:

FDMSECommerce.Authorize() FDMSLevel2.CardType = fctVisa FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard FDMSLevel2.OrderDate = "060828" 'September 28th, 2006 FDMSLevel2.FreightTaxAmount = "0" FDMSLevel2.FreightAmount = "600" FDMSLevel2.PurchaseIdentifier = "123456PURCHID" FDMSLevel2.InvoiceNumber = "CUSTCODE" FDMSLevel2.ShippedToZip = "90210" FDMSLevel2.ShippedFromZip = "90210" FDMSLevel2.TaxAmount = "120" FDMSSettle.DetailRecordCount = 1 FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate() FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum()

Reset Method (FDMSLevel2 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 (FDMSLevel2 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.

Config Settings (FDMSLevel2 Module)

Base Config Settings

Trappable Errors (FDMSLevel2 Module)

FDMSLevel2 Errors