TSYSHCLevel3 Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSHCLevel3 class is used to add Level 3 data to a previously authorized transaction. This class makes adding Level 3 data very easy.

Syntax

class dpaymentssdk.TSYSHCLevel3

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHCLevel3 class makes adding Level 3 data to a transaction very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:

TSYSHCLevel31.GenKey = "gen_key_value" TSYSHCLevel31.MerchantId = "merchant_id" TSYSHCLevel31.RoutingId = "routing_id"

Next, set properties that contain details about the transaction. At the minimum, you must set a retrieval_number and original_amount.

TSYSHCLevel31.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber TSYSHCLevel31.OriginalAmount = TSYSHCRetail1.TransactionAmount

Now, set the Level 3 enhanced data that you wish to add to the transaction. For example: TSYSHCLevel31.CommodityCode = "FAKE" TSYSHCLevel31.NationalTax = "0" TSYSHCLevel31.MerchantTaxId = "merchantTaxId" // Merchant VAT Registration Number TSYSHCLevel31.CustomerTaxId = "customerTaxId" // Customer VAT Registration Number TSYSHCLevel31.DiscountAmount = "0" TSYSHCLevel31.FreightAmount = "0" TSYSHCLevel31.DutyAmount = "0" TSYSHCLevel31.ShipFromZip = "27709" TSYSHCLevel31.DestinationZip = "27709" TSYSHCLevel31.DestinationCountry = "840" TSYSHCLevel31.InvoiceNumber = "VATInvoiceRefNo" TSYSHCLevel31.OrderDate = "111023" // "yyMMdd" TSYSHCLevel31.FreightTaxAmount = "0" TSYSHCLevel31.FreightTaxRate = "0"

If you have any line item details, you can specify them now. Note that line_item_quantity and line_item_total are required to be set when adding line item details.

TSYSHCLevel31.LineItemCount = 2 TSYSHCLevel31.LineItemCommodityCode(0) = "fake" TSYSHCLevel31.LineItemDescription(0) = "hardware" TSYSHCLevel31.LineItemDiscountAmount(0) = "0" TSYSHCLevel31.LineItemDiscountRate(0) = "0" TSYSHCLevel31.LineItemProductCode(0) = "1243320" TSYSHCLevel31.LineItemQuantity(0) = 1 TSYSHCLevel31.LineItemTaxAmount(0) = "3" TSYSHCLevel31.LineItemTaxRate(0) = "0" TSYSHCLevel31.LineItemTotal(0) = "53" TSYSHCLevel31.LineItemUnitCost(0) = "50" TSYSHCLevel31.LineItemUnits(0) = "each" TSYSHCLevel31.LineItemCommodityCode(1) = "fake" TSYSHCLevel31.LineItemDescription(1) = "software" TSYSHCLevel31.LineItemDiscountAmount(1) = "0" TSYSHCLevel31.LineItemDiscountRate(1) = "0" TSYSHCLevel31.LineItemProductCode(1) = "1243321" TSYSHCLevel31.LineItemQuantity(1) = 2 TSYSHCLevel31.LineItemTaxAmount(1) = "3" TSYSHCLevel31.LineItemTaxRate(1) = "0" TSYSHCLevel31.LineItemTotal(1) = "106" TSYSHCLevel31.LineItemUnitCost(1) = "53" TSYSHCLevel31.LineItemUnits(1) = "each"

Finally, submit the level 3 details by calling adjust_transaction. TSYSHCRetail1.AdjustTransaction()

When the class receives a response from the Vital/TSYS servers, the result of the adjustment will be displayed in several Response properties. The response_code indicates whether the level 3 details were successfully added to the transaction. The remaining properties provide additional information about the transaction.

Once the level 3 details are successfully added, the transaction will be added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr class.

Note: If you intend to add Level 3 data to a transaction, the initial authorization (purchase) should have CaptureMode set to Delay (1). This initiates a delay on the capture, thus providing you with time to add the Level 3 details before the transaction is settled.

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 Level 3 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 used in the original authorization request (that is referenced by retrieval_number).

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.

gen_key Property

The unique GenKey value used to identify a POS device.

Syntax

def get_gen_key() -> str: ...
def set_gen_key(value: str) -> None: ...

gen_key = property(get_gen_key, set_gen_key)

Default Value

""

Remarks

This property is used to specify the unique GenKey value used to identify the POS device to the host capture system. This property is required to be specified in every transaction performed.

Your GenKey value is obtained from the host capture system when you successfully authenticate your POS device, which can be accomplished by calling authenticate_device. Once retrieved, your GenKey value must be stored in the POS device.

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.

merchant_id Property

The unique ID that associates the POS device with the merchant account.

Syntax

def get_merchant_id() -> str: ...
def set_merchant_id(value: str) -> None: ...

merchant_id = property(get_merchant_id, set_merchant_id)

Default Value

""

Remarks

The unique ID, also known as the POS ID, that associates the POS device with the merchant account.

This property is required to be specified in every transaction performed.

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.

original_amount Property

The original authorized amount for the transaction to be adjusted.

Syntax

def get_original_amount() -> str: ...
def set_original_amount(value: str) -> None: ...

original_amount = property(get_original_amount, set_original_amount)

Default Value

""

Remarks

This property is used to specify the original transaction amount. This property is required, along with either retrieval_number or transaction_number, when calling adjust_transaction so that the Host Capture system can identify the transaction.

The transaction 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 merchant_currency_code. In the United States, the number of allowable significant digits is seven. Thus the maximum t transaction amount; is "9999999", yielding a US dollar amount of $99,999.99.

Note: This field may not contain a negative number.

response_batch_number Property

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

Syntax

def get_response_batch_number() -> int: ...

response_batch_number = property(get_response_batch_number, None)

Default Value

0

Remarks

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if capture_mode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See capture_mode for more details.

This property is read-only.

response_code Property

Indicates the status of the authorization request.

Syntax

def get_response_code() -> str: ...

response_code = property(get_response_code, None)

Default Value

""

Remarks

Indicates the status of the authorization request.

This property contains the response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the response_text to determine nature of a response message. A response code of "00" represents an approval. A response code of "10" indicates that the transaction was partially approved for a lesser amount (response_authorized_amount). All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

A list of valid result response_codes are listed in the table of contents.

This property is read-only.

response_retrieval_number Property

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

Syntax

def get_response_retrieval_number() -> str: ...

response_retrieval_number = property(get_response_retrieval_number, None)

Default Value

""

Remarks

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.

This property is read-only.

response_text Property

Text information that describes each response code.

Syntax

def get_response_text() -> str: ...

response_text = property(get_response_text, None)

Default Value

""

Remarks

Text information that describes each response code.

This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.

The English-language response text messages are listed in the table of contents.

This property is read-only.

response_transaction_date Property

Local transaction date returned from the server in MMddyy format.

Syntax

def get_response_transaction_date() -> str: ...

response_transaction_date = property(get_response_transaction_date, None)

Default Value

""

Remarks

Local transaction date returned from the server in MMddyy format.

This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.

This property is read-only.

response_transaction_number Property

Check this property against the original Transaction Number.

Syntax

def get_response_transaction_number() -> str: ...

response_transaction_number = property(get_response_transaction_number, None)

Default Value

""

Remarks

Check this property against the original Transaction Number.

This property should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

This property is read-only.

response_transaction_time Property

Local transaction time returned from the server in HHmmss format.

Syntax

def get_response_transaction_time() -> str: ...

response_transaction_time = property(get_response_transaction_time, None)

Default Value

""

Remarks

Local transaction time returned from the server in HHmmss format.

This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.

This property is read-only.

retrieval_number Property

The retrieval reference number (RRN) used to identify a transaction.

Syntax

def get_retrieval_number() -> str: ...
def set_retrieval_number(value: str) -> None: ...

retrieval_number = property(get_retrieval_number, set_retrieval_number)

Default Value

""

Remarks

This property is used to specify the retrieval reference number (RRN) for the transaction that you wish to retrieve or adjust. This value is used by the Host Capture system to identify the transaction.

Note either retrieval_number or transaction_number may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the retrieval_number will be used and the transaction_number ignored.

In the case of performing level 3 or settlement transactions, transaction_number is not supported and thus retrieval_number must be used to reference the transaction.

routing_id Property

The Routing ID assigned to the merchant by TSYS.

Syntax

def get_routing_id() -> str: ...
def set_routing_id(value: str) -> None: ...

routing_id = property(get_routing_id, set_routing_id)

Default Value

""

Remarks

This property is used to specify the six alphanumeric character routing ID assigned to you via TSYS.

This property is required to be set for every transaction request.

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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

tax_invoice_number Property

Optional VAT Invoice Number assigned by the merchant.

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

In this property the merchant may assign an optional VAT Invoice Number.

An invoice number can contain alphanumeric characters and must not be greater than 15 characters in length.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

30

Remarks

If timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of timeout seconds.

The default value for timeout is 30 (seconds).

adjust_transaction Method

Sends Level 3 transaction requests.

Syntax

def adjust_transaction() -> None: ...

Remarks

This method allows you to add Level 3 data to a previously authorized transaction. If the adjustment request was successful, the response_code property will contain "200". response will contain additional details about the authorization request.

Minimum required properties:

• gen_key
• merchant_id
• routing_id
• original_amount
• retrieval_number

If you wish to also add line_items data, the following properties are required to do so:

• line_item_quantity
• line_item_total

When adding line_items data, the class will send a separate adjustment request for each line item. If a line item request fails to adjust successfully, the class fails with an error. The error message will contain the index of the failed line item. response_code and response_text will contain additional details about why the line item failed.

If a timeout occurs during the adjustment request, you will want to use the TSYSHCTransactionDetails class to issue a get_details request. If the request was received by the TSYS server, the GetDetails response will contain the adjusted values and no other steps are necessary. If the request was not received by the TSYS server, the GetDetails response will show that the adjusted values were not updated. Therefore the adjustment request should be resent.

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.

interrupt Method

Interrupts the current action.

Syntax

def interrupt() -> None: ...

Remarks

This method interrupts any processing that the class is currently executing.

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 TSYSHCLevel3ErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class TSYSHCLevel3SSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

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

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

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

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class TSYSHCLevel3:
@property
def on_ssl_server_authentication() -> Callable[[TSYSHCLevel3SSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[TSYSHCLevel3SSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class TSYSHCLevel3SSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class TSYSHCLevel3:
@property
def on_ssl_status() -> Callable[[TSYSHCLevel3SSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[TSYSHCLevel3SSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

TSYSHCLevel3 Config Settings

TSYSHCLevel3 Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

TSYSHCLevel3 Errors

TSYSHCLevel3 Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors