FDMSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DPaymentsSDK_FDMSLevel2

Procedural Interface

 dpaymentssdk_fdmslevel2_open();
 dpaymentssdk_fdmslevel2_close($res);
 dpaymentssdk_fdmslevel2_register_callback($res, $id, $function);
 dpaymentssdk_fdmslevel2_get_last_error($res);
 dpaymentssdk_fdmslevel2_get_last_error_code($res);
 dpaymentssdk_fdmslevel2_set($res, $id, $index, $value);
 dpaymentssdk_fdmslevel2_get($res, $id, $index);
 dpaymentssdk_fdmslevel2_do_config($res, $configurationstring);
 dpaymentssdk_fdmslevel2_do_getaddendum($res);
 dpaymentssdk_fdmslevel2_do_reset($res);

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

CardType Property (DPaymentsSDK_FDMSLevel2 Class)

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

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 1 );


dpaymentssdk_fdmslevel2_set($res, 1, $value );

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:

Data Type

Integer

CommercialCardType Property (DPaymentsSDK_FDMSLevel2 Class)

Indicates the type of commercial card being settled.

Object Oriented Interface

public function getCommercialCardType();


public function setCommercialCardType($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 2 );


dpaymentssdk_fdmslevel2_set($res, 2, $value );

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.

Data Type

Integer

DestinationCountry Property (DPaymentsSDK_FDMSLevel2 Class)

Country the goods are to be shipped to.

Object Oriented Interface

public function getDestinationCountry();


public function setDestinationCountry($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 3 );


dpaymentssdk_fdmslevel2_set($res, 3, $value );

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.

Data Type

String

DestinationState Property (DPaymentsSDK_FDMSLevel2 Class)

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

Object Oriented Interface

public function getDestinationState();


public function setDestinationState($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 4 );


dpaymentssdk_fdmslevel2_set($res, 4, $value );

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.

Data Type

String

DestinationZip Property (DPaymentsSDK_FDMSLevel2 Class)

The zip code to which the commodity was shipped.

Object Oriented Interface

public function getDestinationZip();


public function setDestinationZip($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 5 );


dpaymentssdk_fdmslevel2_set($res, 5, $value );

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.

Data Type

String

DiscountAmount Property (DPaymentsSDK_FDMSLevel2 Class)

Amount of any discount subtracted from the line item totals.

Object Oriented Interface

public function getDiscountAmount();


public function setDiscountAmount($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 6 );


dpaymentssdk_fdmslevel2_set($res, 6, $value );

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.

Data Type

String

DutyAmount Property (DPaymentsSDK_FDMSLevel2 Class)

Duty fees (if any) for imported goods.

Object Oriented Interface

public function getDutyAmount();


public function setDutyAmount($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 7 );


dpaymentssdk_fdmslevel2_set($res, 7, $value );

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.

Data Type

String

FreightAmount Property (DPaymentsSDK_FDMSLevel2 Class)

Shipping charges associated with this transaction.

Object Oriented Interface

public function getFreightAmount();


public function setFreightAmount($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 8 );


dpaymentssdk_fdmslevel2_set($res, 8, $value );

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.

Data Type

String

FreightTaxAmount Property (DPaymentsSDK_FDMSLevel2 Class)

Portion of the FreightAmount that is tax.

Object Oriented Interface

public function getFreightTaxAmount();


public function setFreightTaxAmount($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 9 );


dpaymentssdk_fdmslevel2_set($res, 9, $value );

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.

Data Type

String

FreightTaxRate Property (DPaymentsSDK_FDMSLevel2 Class)

Rate used to calculate the FreightTaxAmount .

Object Oriented Interface

public function getFreightTaxRate();


public function setFreightTaxRate($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 10 );


dpaymentssdk_fdmslevel2_set($res, 10, $value );

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.

Data Type

String

InvoiceNumber Property (DPaymentsSDK_FDMSLevel2 Class)

Customer Reference Identifier.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 11 );


dpaymentssdk_fdmslevel2_set($res, 11, $value );

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.

Data Type

String

MerchantReference Property (DPaymentsSDK_FDMSLevel2 Class)

Merchant Reference Number.

Object Oriented Interface

public function getMerchantReference();


public function setMerchantReference($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 12 );


dpaymentssdk_fdmslevel2_set($res, 12, $value );

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.

Data Type

String

MerchantTaxId Property (DPaymentsSDK_FDMSLevel2 Class)

Merchant's government tax Id number.

Object Oriented Interface

public function getMerchantTaxId();


public function setMerchantTaxId($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 13 );


dpaymentssdk_fdmslevel2_set($res, 13, $value );

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.

Data Type

String

MerchantType Property (DPaymentsSDK_FDMSLevel2 Class)

MasterCard merchant classification code.

Object Oriented Interface

public function getMerchantType();


public function setMerchantType($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 14 );


dpaymentssdk_fdmslevel2_set($res, 14, $value );

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.

Data Type

String

OrderDate Property (DPaymentsSDK_FDMSLevel2 Class)

Date of the order in YYMMDD format.

Object Oriented Interface

public function getOrderDate();


public function setOrderDate($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 15 );


dpaymentssdk_fdmslevel2_set($res, 15, $value );

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.

Data Type

String

PurchaseIdentifier Property (DPaymentsSDK_FDMSLevel2 Class)

Used to identify the purchase.

Object Oriented Interface

public function getPurchaseIdentifier();


public function setPurchaseIdentifier($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 16 );


dpaymentssdk_fdmslevel2_set($res, 16, $value );

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.

Data Type

String

ShippedFromZip Property (DPaymentsSDK_FDMSLevel2 Class)

Zip code the goods are being shipped from.

Object Oriented Interface

public function getShippedFromZip();


public function setShippedFromZip($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 17 );


dpaymentssdk_fdmslevel2_set($res, 17, $value );

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.

Data Type

String

TaxAmount Property (DPaymentsSDK_FDMSLevel2 Class)

Sales tax charged in addition to the original TransactionAmount .

Object Oriented Interface

public function getTaxAmount();


public function setTaxAmount($value);

Procedural Interface

dpaymentssdk_fdmslevel2_get($res, 18 );


dpaymentssdk_fdmslevel2_set($res, 18, $value );

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.

Data Type

String

Config Method (DPaymentsSDK_FDMSLevel2 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetAddendum Method (DPaymentsSDK_FDMSLevel2 Class)

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

Object Oriented Interface

public function doGetAddendum();

Procedural Interface

dpaymentssdk_fdmslevel2_do_getaddendum($res);

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

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmslevel2_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_FDMSLevel2 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmslevel2_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 (FDMSLevel2 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.

Base Config Settings

Trappable Errors (FDMSLevel2 Class)

FDMSLevel2 Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	605   Invalid CardType.