TSYSLevel2 Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DPaymentsSDK.Tsyslevel2

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax, and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.GetAddendum();

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

Note: If you are attempting to settle American Express transactions which include Level2 commercial card data, and you receive an error indicating that the "Record Type is missing or invalid" for the Detail Record containing that transaction, the problem is that your merchant account is not set up to settle American Express commercial cards.

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.

AmexCardholderReference Property (TSYSLevel2 Module)

Reference number supplied by the card holder.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=amexCardholderReference,setter=setAmexCardholderReference:) NSString* amexCardholderReference;

- (NSString*)amexCardholderReference;
- (void)setAmexCardholderReference :(NSString*)newAmexCardholderReference;

Default Value

""

Remarks

This property is defined by the card member and entered by the merchant at the point-of-sale. This information will be displayed within the Statement/Reporting process and may include accounting information specific to the client.

The maximum length for this property is 17 characters.

AmexChargeDescriptor Property (TSYSLevel2 Module)

Description of this transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=amexChargeDescriptor,setter=setAmexChargeDescriptor:) NSString* amexChargeDescriptor;

- (NSString*)amexChargeDescriptor;
- (void)setAmexChargeDescriptor :(NSString*)newAmexChargeDescriptor;

Default Value

""

Remarks

This property may contain up to 40 characters of free text (Spaces allowed). This is a required property for an American Express addendum.

AmexSalesTax Property (TSYSLevel2 Module)

Portion of the transaction amount which is sales tax.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=amexSalesTax,setter=setAmexSalesTax:) NSString* amexSalesTax;

- (NSString*)amexSalesTax;
- (void)setAmexSalesTax :(NSString*)newAmexSalesTax;

Default Value

""

Remarks

The sales tax charged must be included in the TransactionAmount of the original transaction.

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 maximum length of this field is 6 digits, thus the maximum AmexSalesTax is "999999", yielding a US dollar amount of $9,999.99. This field may not contain a negative number.

AmexShippedToZip Property (TSYSLevel2 Module)

The zip code to which the commodity was shipped.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=amexShippedToZip,setter=setAmexShippedToZip:) NSString* amexShippedToZip;

- (NSString*)amexShippedToZip;
- (void)setAmexShippedToZip :(NSString*)newAmexShippedToZip;

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.

The maximum length for this property is 6 characters.

AmexSupplierNumber Property (TSYSLevel2 Module)

Supplier Reference Number contained in the American Express Level 2 addendum.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=amexSupplierNumber,setter=setAmexSupplierNumber:) NSString* amexSupplierNumber;

- (NSString*)amexSupplierNumber;
- (void)setAmexSupplierNumber :(NSString*)newAmexSupplierNumber;

Default Value

""

Remarks

This property contains a reference number that is used by American Express to obtain supporting information on a charge from a Merchant. Supporting documentation should be readily available in case of inquiry. The number can be any combination of characters and numerals defined by the Merchant or Authorized Processor. However, it must be an index to the Merchant's record, so that charge information can be readily retrieved and promptly submitted within 10 calendar days (or within the period stipulated in the contractual agreement). This number appears on the card member descriptive billing and Merchant inquiry reports.

The maximum length for this property is 9 characters.

CardType Property (TSYSLevel2 Module)

The card type for which a Level2 or Level3 addendum will be created.

Syntax

• Swift
• Objective-C

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

public enum Tsyslevel2CardTypes: Int32 {
  case tctVisa = 0
  case tctMasterCard = 1
  case tctAmericanExpress = 2
}

@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:

IsTaxExempt Property (TSYSLevel2 Module)

Indicates whether this purchasing card qualifies for tax-exempt status.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=isTaxExempt,setter=setIsTaxExempt:) BOOL isTaxExempt;

- (BOOL)isTaxExempt;
- (void)setIsTaxExempt :(BOOL)newIsTaxExempt;

Default Value

False

Remarks

This property cannot be True if there is a LocalTax amount set.

LocalSalesTax Property (TSYSLevel2 Module)

Sales tax charged in addition to the original TransactionAmount .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=localSalesTax,setter=setLocalSalesTax:) NSString* localSalesTax;

- (NSString*)localSalesTax;
- (void)setLocalSalesTax :(NSString*)newLocalSalesTax;

Default Value

""

Remarks

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 maximum length of this property is 12 digits.

PurchaseOrderNumber Property (TSYSLevel2 Module)

Optional customer-specified purchase order number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=purchaseOrderNumber,setter=setPurchaseOrderNumber:) NSString* purchaseOrderNumber;

- (NSString*)purchaseOrderNumber;
- (void)setPurchaseOrderNumber :(NSString*)newPurchaseOrderNumber;

Default Value

""

Remarks

This property contains a 16, 17, or 25-character Purchase Order Number or Customer Reference Identifier supplied by the Visa or MasterCard Purchasing Card cardholder.

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

Config Method (TSYSLevel2 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 (TSYSLevel2 Module)

Returns a Level2 Purchasing card addendum based on the specified CardType .

Syntax

• Swift
• Objective-C

public func getAddendum() throws -> String

- (NSString*)getAddendum;

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax, and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.GetAddendum();

Reset Method (TSYSLevel2 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 (TSYSLevel2 Module)

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

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

Config Settings (TSYSLevel2 Module)

Base Config Settings

Trappable Errors (TSYSLevel2 Module)

TSYSLevel2 Errors