TSYSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class dpaymentssdk.TSYSLevel2

Remarks

The type of addendum created by this class depends upon the value of the card_type property. If the card_type is tctVisa or tctMasterCard the addendum created by the get_addendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these card_types are: is_tax_exempt, local_sales_tax, and purchase_order_number. 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 card_type is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: amex_cardholder_reference, amex_charge_descriptor, amex_sales_tax, amex_shipped_to_zip, and amex_supplier_number. 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 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.

amex_cardholder_reference Property

Reference number supplied by the card holder.

Syntax

def get_amex_cardholder_reference() -> str: ...
def set_amex_cardholder_reference(value: str) -> None: ...

amex_cardholder_reference = property(get_amex_cardholder_reference, set_amex_cardholder_reference)

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.

amex_charge_descriptor Property

Description of this transaction.

Syntax

def get_amex_charge_descriptor() -> str: ...
def set_amex_charge_descriptor(value: str) -> None: ...

amex_charge_descriptor = property(get_amex_charge_descriptor, set_amex_charge_descriptor)

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.

amex_sales_tax Property

Portion of the transaction amount which is sales tax.

Syntax

def get_amex_sales_tax() -> str: ...
def set_amex_sales_tax(value: str) -> None: ...

amex_sales_tax = property(get_amex_sales_tax, set_amex_sales_tax)

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

amex_shipped_to_zip Property

The zip code to which the commodity was shipped.

Syntax

def get_amex_shipped_to_zip() -> str: ...
def set_amex_shipped_to_zip(value: str) -> None: ...

amex_shipped_to_zip = property(get_amex_shipped_to_zip, set_amex_shipped_to_zip)

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.

amex_supplier_number Property

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

Syntax

def get_amex_supplier_number() -> str: ...
def set_amex_supplier_number(value: str) -> None: ...

amex_supplier_number = property(get_amex_supplier_number, set_amex_supplier_number)

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.

card_type Property

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

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

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:

is_tax_exempt Property

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

Syntax

def get_is_tax_exempt() -> bool: ...
def set_is_tax_exempt(value: bool) -> None: ...

is_tax_exempt = property(get_is_tax_exempt, set_is_tax_exempt)

Default Value

FALSE

Remarks

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

local_sales_tax Property

Sales tax charged in addition to the original TransactionAmount .

Syntax

def get_local_sales_tax() -> str: ...
def set_local_sales_tax(value: str) -> None: ...

local_sales_tax = property(get_local_sales_tax, set_local_sales_tax)

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.

purchase_order_number Property

Optional customer-specified purchase order number.

Syntax

def get_purchase_order_number() -> str: ...
def set_purchase_order_number(value: str) -> None: ...

purchase_order_number = property(get_purchase_order_number, set_purchase_order_number)

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

get_addendum Method

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

Syntax

def get_addendum() -> str: ...

Remarks

The type of addendum created by this class depends upon the value of the card_type property. If the card_type is tctVisa or tctMasterCard the addendum created by the get_addendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these card_types are: is_tax_exempt, local_sales_tax, and purchase_order_number. 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 card_type is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: amex_cardholder_reference, amex_charge_descriptor, amex_sales_tax, amex_shipped_to_zip, and amex_supplier_number. 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

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

on_error Event

Information about errors during data delivery.

Syntax

class TSYSLevel2ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class TSYSLevel2:
@property
def on_error() -> Callable[[TSYSLevel2ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TSYSLevel2ErrorEventParams], None]) -> None: ...

Remarks

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

TSYSLevel2 Config Settings

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

TSYSLevel2 Errors

TSYSLevel2 Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	592   Invalid or unparseable aggregate.
	605   Invalid CardType.