TSYSLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class dpaymentssdk.TSYSLevel3

Remarks

This TSYSLevel3 class creates Level III addendum data, which can be sent in the settlement to achieve a better interchange rate when accepting corporate purchasing cards. The Level III addendum allows the merchant to send very detailed information about every item that was purchased by the card holder, as well as tax and shipping information.

This class creates a different addendum aggregate based on the card_type. Visa and MasterCard addendums differ slightly, and therefore a slightly different set of properties are required for each.

The following properties are valid for both tctVisa and tctMasterCard card_types.

• purchase_identifier
• local_tax
• national_tax
• purchase_order
• freight_amount
• duty_amount
• destination_zip
• ship_from_zip
• destination_country
• line_item_description
• line_item_discount_amount
• line_item_product_code
• line_item_quantity
• line_item_tax_amount
• line_item_tax_rate
• line_item_total
• line_item_units

Additional properties for the tctVisa card_type include:

• merchant_tax_id
• customer_tax_id
• commodity_code
• discount_amount
• tax_invoice_number
• order_date
• freight_tax_amount
• freight_tax_rate
• line_item_commodity_code
• line_item_unit_cost

Additional properties for the tctMasterCard card_type include:

• alternate_tax_amount
• alternate_tax_id
• line_item_discount_rate
• line_item_tax_included
• line_item_tax_type

The following example illustrates how to build a Level III addendum for the tctVisa card_type: 'First authorize the credit card TSYSECommerce1.TransactionAmount = "53" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. 'The following properties are required for a Visa Corporate Purchasing Card: TSYSLevel3.CardType = tctVisa TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "purchOrdNum" TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number TSYSLevel3.CommodityCode = "fake" TSYSLevel3.DiscountAmount = "0" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "840" TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo" TSYSLevel3.OrderDate = "060526" TSYSLevel3.FreightTaxAmount = "0" TSYSLevel3.FreightTaxRate = "0" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()

A Level III addendum for the tctMasterCard card_type is constructed similarly:

'First authorize the credit card TSYSECommerce1.TransactionAmount = "200" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. TSYSLevel3.cardType = tctMasterCard TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "cardholderRefId" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "USA" TSYSLevel3.AlternateTaxAmount = "0" TSYSLevel3.AlternateTaxId = "altTaxId" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemDescription(0) = "bolt" TSYSLevel3.LineItemProductCode(0) = "BOLT6x20" TSYSLevel3.LineItemQuantity(0) = 2 TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemTaxType(0) = "taxType" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTaxIncluded(0) = False TSYSLevel3.LineItemTotal(0) = "100" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemDiscountRate(0) = "0" TSYSLevel3.LineItemDescription(1) = "flange nut" TSYSLevel3.LineItemProductCode(1) = "FLANGE6" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "each" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemTaxType(1) = "taxType" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTaxIncluded(1) = False TSYSLevel3.LineItemTotal(1) = "100" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemDiscountRate(1) = "0" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle1.DetailAddendum(1) = TSYSLevel3.GetAddendum()

Note that while Level3 addendum data is only applicable to corporate purchasing cards, however you may send Level3 data for all Visa and Master Card 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.

alternate_tax_amount Property

Secondary tax amount (only applicable in some countries).

Syntax

def get_alternate_tax_amount() -> str: ...
def set_alternate_tax_amount(value: str) -> None: ...

alternate_tax_amount = property(get_alternate_tax_amount, set_alternate_tax_amount)

Default Value

""

Remarks

This property is used to record the second tax amount in countries where more than one type of tax can be applied to purchases. This amount 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 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 transaction_amount 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 MasterCard Corporate Purchasing Cards.

alternate_tax_id Property

Tax Id number of the merchant that reported the AlternateTaxAmount .

Syntax

def get_alternate_tax_id() -> str: ...
def set_alternate_tax_id(value: str) -> None: ...

alternate_tax_id = property(get_alternate_tax_id, set_alternate_tax_id)

Default Value

""

Remarks

This property contains the tax identification number of the merchant that reported the alternate_tax_amount This property is only used for MasterCard Corporate Purchasing Cards.

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:

commodity_code Property

Code indicating the type of goods or services sold.

Syntax

def get_commodity_code() -> str: ...
def set_commodity_code(value: str) -> None: ...

commodity_code = property(get_commodity_code, set_commodity_code)

Default Value

""

Remarks

This property should contain an international description code of the overall goods or services being supplied. The acquirer bank or processor should provide the merchant an updated listing of currently defined codes.

The maximum length of this property is 4 characters.

This property is only used for Visa Corporate Purchasing Cards.

customer_tax_id Property

Customer's Value Added Tax registration number.

Syntax

def get_customer_tax_id() -> str: ...
def set_customer_tax_id(value: str) -> None: ...

customer_tax_id = property(get_customer_tax_id, set_customer_tax_id)

Default Value

""

Remarks

This property contains a Value Added Tax registration number supplied by the Commercial Card cardholder.

The maximum length of this property is 13 characters.

This property is only used for Visa Corporate Purchasing Cards.

destination_country Property

Country the goods are to be shipped to.

Syntax

def get_destination_country() -> str: ...
def set_destination_country(value: str) -> None: ...

destination_country = property(get_destination_country, set_destination_country)

Default Value

""

Remarks

For Visa 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".

For MasterCard transactions, this property should contain the three-character alpha code specified by that same ISO spec. For the United States, use "USA".

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

destination_zip Property

Zip code the goods are to be shipped to.

Syntax

def get_destination_zip() -> str: ...
def set_destination_zip(value: str) -> None: ...

destination_zip = property(get_destination_zip, set_destination_zip)

Default Value

""

Remarks

This property contains the Postal/Zip code of the address where purchased goods will be delivered. This property can be identical to the ship_from_zip if the customer is present and takes immediate possession of the goods.

The maximum length of this property is 10 characters.

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

discount_amount Property

Amount of any discount subtracted from the line item totals.

Syntax

def get_discount_amount() -> str: ...
def set_discount_amount(value: str) -> None: ...

discount_amount = property(get_discount_amount, set_discount_amount)

Default Value

""

Remarks

This property contains the amount of any discount applied by the merchant to the entire order. This field should be empty if the line_item_unit_cost for each line item reflects a discount price, or if no discount applies.

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

duty_amount Property

Duty fees (if any) for imported goods.

Syntax

def get_duty_amount() -> str: ...
def set_duty_amount(value: str) -> None: ...

duty_amount = property(get_duty_amount, set_duty_amount)

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

freight_amount Property

Shipping charges associated with this transaction.

Syntax

def get_freight_amount() -> str: ...
def set_freight_amount(value: str) -> None: ...

freight_amount = property(get_freight_amount, set_freight_amount)

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

freight_tax_amount Property

Portion of the FreightAmount that is tax.

Syntax

def get_freight_tax_amount() -> str: ...
def set_freight_tax_amount(value: str) -> None: ...

freight_tax_amount = property(get_freight_tax_amount, set_freight_tax_amount)

Default Value

""

Remarks

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

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

freight_tax_rate Property

Rate used to calculate the FreightTaxAmount .

Syntax

def get_freight_tax_rate() -> str: ...
def set_freight_tax_rate(value: str) -> None: ...

freight_tax_rate = property(get_freight_tax_rate, set_freight_tax_rate)

Default Value

""

Remarks

This property contains the tax rate used to calculate the freight_tax_amount. 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.

line_item_count Property

The number of records in the LineItem arrays.

Syntax

def get_line_item_count() -> int: ...
def set_line_item_count(value: int) -> None: ...

line_item_count = property(get_line_item_count, set_line_item_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• line_item_commodity_code
• line_item_debit_credit_indicator
• line_item_description
• line_item_discount_amount
• line_item_discount_rate
• line_item_product_code
• line_item_quantity
• line_item_tax_amount
• line_item_tax_included
• line_item_tax_rate
• line_item_tax_type
• line_item_total
• line_item_unit_cost
• line_item_units

The array indices start at 0 and end at line_item_count - 1.

line_item_commodity_code Property

Code describing the good or service being supplied.

Syntax

def get_line_item_commodity_code(line_item_index: int) -> str: ...
def set_line_item_commodity_code(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Code describing the good or service being supplied.

This property will contain an international description code of the individual good or service being supplied. The acquirer's bank will provide the merchant an updated listing of currently defined codes. It is recommended to use a National or International list of standardized codes.

The maximum length for this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is only used for Visa Corporate Purchasing Cards.

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_debit_credit_indicator Property

Debit/Credit Indicator.

Syntax

def get_line_item_debit_credit_indicator(line_item_index: int) -> str: ...
def set_line_item_debit_credit_indicator(line_item_index: int, value: str) -> None: ...

Default Value

"D"

Remarks

Debit/Credit Indicator.

This 1-character property represents the sign of the line_item_total. Possible values are:

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_description Property

Description of the item.

Syntax

def get_line_item_description(line_item_index: int) -> str: ...
def set_line_item_description(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Description of the item.

This property contains an alphanumeric description of the item(s) being supplied.

The maximum length of this property is 35 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_discount_amount Property

Amount of the discount for each line item (if any).

Syntax

def get_line_item_discount_amount(line_item_index: int) -> str: ...
def set_line_item_discount_amount(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Amount of the discount for each line item (if any).

This property contains the amount of any discount applied by the merchant to this line item. This property should be empty (or zero) if the line_item_unit_cost reflects a discount price or if no line item discount applies.

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 transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_discount_rate Property

Rate used to calculate the DiscountAmount .

Syntax

def get_line_item_discount_rate(line_item_index: int) -> str: ...
def set_line_item_discount_rate(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Rate used to calculate the line_item_discount_amount.

This property contains the rate used to calculate the line_item_discount_amount. This property is a two decimal value. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_product_code Property

Merchant-defined product code for this Line Item.

Syntax

def get_line_item_product_code(line_item_index: int) -> str: ...
def set_line_item_product_code(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Merchant-defined product code for this Line Item.

This property can contain a merchant-defined description of the individual item contained in this Line Item.

The maximum length of this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_quantity Property

Quantity of items in this Line Item.

Syntax

def get_line_item_quantity(line_item_index: int) -> int: ...
def set_line_item_quantity(line_item_index: int, value: int) -> None: ...

Default Value

0

Remarks

Quantity of items in this Line Item.

This property contains the quantity of items being purchased, in whole numbers. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97 All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_tax_amount Property

Tax on this individual item.

Syntax

def get_line_item_tax_amount(line_item_index: int) -> str: ...
def set_line_item_tax_amount(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tax on this individual item.

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the purchased item.

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 transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_tax_included Property

Net/Gross Indicator.

Syntax

def get_line_item_tax_included(line_item_index: int) -> bool: ...
def set_line_item_tax_included(line_item_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Net/Gross Indicator.

If this property is true, the line_item_total already contains the line_item_tax_amount. If false, the line_item_tax_amount has not yet been added to the line_item_total. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_tax_rate Property

Tax rate used to calculate the TaxAmount .

Syntax

def get_line_item_tax_rate(line_item_index: int) -> str: ...
def set_line_item_tax_rate(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Tax rate used to calculate the line_item_tax_amount.

This property contains the tax rate used to calculate the line_item_tax_amount. This property has a two-digit implied decimal position, and the maximum length is 4 digits. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_tax_type Property

Type of tax charged in TaxAmount .

Syntax

def get_line_item_tax_type(line_item_index: int) -> str: ...
def set_line_item_tax_type(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Type of tax charged in line_item_tax_amount.

This 4-character property designates the type of value-added taxes that are being used.

All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1. This property is only used for MasterCard Corporate Purchasing Cards.

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_total Property

Total cost of this line item.

Syntax

def get_line_item_total(line_item_index: int) -> str: ...
def set_line_item_total(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as line_item_unit_cost multiplied by line_item_quantity, with any line_item_tax_amount and line_item_discount_amount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

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

Note: This property is 12 digits in length for Visa, but only 9 for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_unit_cost Property

Cost of each individual item.

Syntax

def get_line_item_unit_cost(line_item_index: int) -> str: ...
def set_line_item_unit_cost(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Cost of each individual item.

This property contains the cost of each item in this Line Item. For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

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 transaction_amount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is only used for Visa Corporate Purchasing Cards.

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

line_item_units Property

Unit of measure for this Line Item.

Syntax

def get_line_item_units(line_item_index: int) -> str: ...
def set_line_item_units(line_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Unit of measure for this Line Item.

This property contains the alphanumeric code for units of measure as used in international trade. In practice, this should reflect the way in which the line_item_unit_cost is calculated. If you're selling rope by the foot, the line_item_units might be "feet". If you're selling chemicals, it might be by the "ounce". For example, if your customer purchased 3 T-Shirts at $13.99 each, then: TSYSLevel3.LineItemCount = 1 TSYSLevel3.LineItemQuantity(0) = 3 TSYSLevel3.LineItemUnitCost(0) = "1399" TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

The maximum length of this property is 12 characters. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

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

The line_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.

local_tax Property

Amount of local or state taxes that are a part of this transaction.

Syntax

def get_local_tax() -> str: ...
def set_local_tax(value: str) -> None: ...

local_tax = property(get_local_tax, set_local_tax)

Default Value

""

Remarks

This property contains the sales tax associated with the purchase. If the transaction is exempt from local or state taxes, set this property to the text "EXEMPT".

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

merchant_tax_id Property

Merchant's government tax Id number.

Syntax

def get_merchant_tax_id() -> str: ...
def set_merchant_tax_id(value: str) -> None: ...

merchant_tax_id = property(get_merchant_tax_id, set_merchant_tax_id)

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 field is 20 characters.

This property is only used for Visa Corporate Purchasing Cards.

national_tax Property

Amount of federal or national taxes that are a part of this transaction.

Syntax

def get_national_tax() -> str: ...
def set_national_tax(value: str) -> None: ...

national_tax = property(get_national_tax, set_national_tax)

Default Value

""

Remarks

This property contains the national tax 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 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 transaction_amount 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.

order_date Property

Date of the order in YYMMDD format.

Syntax

def get_order_date() -> str: ...
def set_order_date(value: str) -> None: ...

order_date = property(get_order_date, set_order_date)

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.

purchase_identifier Property

Optional purchase order number assigned by the merchant.

Syntax

def get_purchase_identifier() -> str: ...
def set_purchase_identifier(value: str) -> None: ...

purchase_identifier = property(get_purchase_identifier, set_purchase_identifier)

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and will be automatically left-justified, space-filled to 25 spaces.

This field is applicable to E-Commerce, Hotel, and Auto Rental transactions.

Note: For the Hotel industry_type, this property will contain the Hotel Folio Number. For the Auto Rental industry_type, it should indicate the Rental Agreement Number.

Failure to set a purchase_identifier for the e-commerce industry_type may result in a CPS downgrade when the transaction is settled. This can result in higher interchange rates.

purchase_order Property

Purchase Order Number supplied by the cardholder.

Syntax

def get_purchase_order() -> str: ...
def set_purchase_order(value: str) -> None: ...

purchase_order = property(get_purchase_order, set_purchase_order)

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.

ship_from_zip Property

Zip code the goods are being shipped from.

Syntax

def get_ship_from_zip() -> str: ...
def set_ship_from_zip(value: str) -> None: ...

ship_from_zip = property(get_ship_from_zip, set_ship_from_zip)

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.

tax_invoice_number Property

Unique Value Added Tax Invoice Reference Number.

Syntax

def get_tax_invoice_number() -> str: ...
def set_tax_invoice_number(value: str) -> None: ...

tax_invoice_number = property(get_tax_invoice_number, set_tax_invoice_number)

Default Value

""

Remarks

This property contains the invoice number that is associated with the Value Added Tax (VAT) invoice.

The maximum length of this property is 15 characters.

This property is only used for Visa 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 Level III 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. Different addendums are created when the card_type is set to tctVisa or tctMasterCard, and different properties are required for the two different card_types.

The following properties are valid for both tctVisa and tctMasterCard card_types.

• purchase_identifier
• local_tax
• national_tax
• purchase_order
• freight_amount
• duty_amount
• destination_zip
• ship_from_zip
• destination_country
• line_item_description
• line_item_discount_amount
• line_item_product_code
• line_item_quantity
• line_item_tax_amount
• line_item_tax_rate
• line_item_total
• line_item_units

Additional properties for the tctVisa card_type include:

• merchant_tax_id
• customer_tax_id
• commodity_code
• discount_amount
• tax_invoice_number
• order_date
• freight_tax_amount
• freight_tax_rate
• line_item_commodity_code
• line_item_unit_cost

Additional properties for the tctMasterCard card_type include:

• alternate_tax_amount
• alternate_tax_id
• line_item_discount_rate
• line_item_tax_included
• line_item_tax_type

The following example illustrates how to build a Level III addendum for the tctVisa card_type: 'First authorize the credit card TSYSECommerce1.TransactionAmount = "53" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. 'The following properties are required for a Visa Corporate Purchasing Card: TSYSLevel3.CardType = tctVisa TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "purchOrdNum" TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number TSYSLevel3.CommodityCode = "fake" TSYSLevel3.DiscountAmount = "0" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "840" TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo" TSYSLevel3.OrderDate = "060526" TSYSLevel3.FreightTaxAmount = "0" TSYSLevel3.FreightTaxRate = "0" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.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 TSYSLevel3ErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class TSYSLevel3:
@property
def on_error() -> Callable[[TSYSLevel3ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TSYSLevel3ErrorEventParams], 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.

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

TSYSLevel3 Config Settings

Base Config Settings

TSYSLevel3 Errors

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