TSYSSettle Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSSettle class is used to do a Batch Settlement on all transactions that were successfully authorized with the TSYSECOMMERCE or TSYSRETAIL classes. This class may also send Level II and Level III Corporate Purchasing Card data for better interchange rates.

Syntax

class dpaymentssdk.TSYSSettle

Remarks

This class allows for a direct, secure connection to the Vital/TSYS 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 TSYSSettle class is used to settle all transactions previously authorized by the TSYSECommerce or TSYSRetail class. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the TSYSSettle class the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.

To send a Batch Settlement, first the user must fill out the Merchant properties with the same information contained in the authorizing class's Merchant properties.

TSYSSettle.MerchantBankId = "999995" TSYSSettle.MerchantCategoryCode = "5999" TSYSSettle.MerchantName = "test merchant" TSYSSettle.MerchantNumber = "123456789012" TSYSSettle.MerchantCity = "Beverly Hills" TSYSSettle.MerchantState = "CA" TSYSSettle.MerchantStoreNumber = "5999" TSYSSettle.MerchantTerminalNumber = "1515" TSYSSettle.MerchantZip = "90210"

Additionally, the agent_bank_number, agent_chain_number, terminal_id, batch_number, and industry_type must be set. Note that the terminal_id is fundamentally different from the merchant_terminal_number. The merchant_terminal_number is used to identify a unique terminal (PC, server, whatever) within a merchant location. The terminal_id, also known as the "V Number", is used for point-of-sale tracking. TSYSSettle.AgentBankNumber = "000000" TSYSSettle.AgentChainNumber = "111111" TSYSSettle.TerminalId = "00000001" TSYSSettle.BatchNumber = 15 TSYSSettle.IndustryType = itRetail

At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the detail_record_aggregate array property. First set the DetailRecordCount; to the total number of transactions you wish to settle. Each index in the detail_record_aggregate array property must be set with the XML aggregate returned from the TSYSRetail, TSYSECommerce, or TSYSDetailRecord class's GetDetailAggregate method.

TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate(0) = TSYSRetail.GetDetailAggregate()

Finally, call the send_settlement method.

TSYSSettle.SendSettlement()

If the transaction is successful, the response_code will contain "GB", which indicates a "Good Batch". You should check that the response_net_deposit and response_record_count match the batch_net_deposit and batch_record_count properties.

If the transaction is not successful and you receive an "RB" response_code (indicating a "Rejected Batch") the class fails with an error. You may inspect the error_data. error_data_field_number, error_record_type, error_sequence_number, and error_type properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the batch_number must be set to the same value that was originally used. It is critical that the same batch_number value is used to avoid duplicate charges.

Thousands of detail records may be settled in the above manner, just by increasing the DetailRecordCount and adding a transaction to each index of the detail_record_aggregate property. However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.

To Void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. Credits and forced transactions may be created using the TSYSDetailRecord class and settled in the same manner.

To add Level II or Level III data to the settled transactions, use the detail_record_addendum property and the TSYSLevel2 or TSYSLevel3 classs.

Note that the industry_type from the TSYSSettle class MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.

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.

agent_bank_number Property

Identifies a specific agent entity of the member bank or processor.

Syntax

def get_agent_bank_number() -> str: ...
def set_agent_bank_number(value: str) -> None: ...

agent_bank_number = property(get_agent_bank_number, set_agent_bank_number)

Default Value

"000000"

Remarks

This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

agent_chain_number Property

Identifies a specific chain of an agent organization.

Syntax

def get_agent_chain_number() -> str: ...
def set_agent_chain_number(value: str) -> None: ...

agent_chain_number = property(get_agent_chain_number, set_agent_chain_number)

Default Value

"000000"

Remarks

This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

batch_cash_back_total Property

Total amount of cash back for all transactions in the batch.

Syntax

def get_batch_cash_back_total() -> str: ...

batch_cash_back_total = property(get_batch_cash_back_total, None)

Default Value

"0000000000000000"

Remarks

Total amount of cash back for all transactions in the batch.

This property contains the total of all cash back amounts reflected in the settlement batch. Note that only Debit Cards, Gift Cards, and EBT cards allow for cash back to be returned to the customer. For normal credit card transactions, this property will be defaulted to zeros.

This is a Trailer property, and is automatically computed by the class.

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

batch_hashing_total Property

Total of purchases plus credits.

Syntax

def get_batch_hashing_total() -> str: ...

batch_hashing_total = property(get_batch_hashing_total, None)

Default Value

"0000000000000000"

Remarks

Total of purchases plus credits.

This 16-digit property contains the batch hashing total generated by the terminal. The hashing total is generated by adding the absolute value of all detail record amounts. Void and purchase return settlement amounts are treated as positive and added to the total, not subtracted from it.

This is a Trailer property, and is automatically computed by the class.

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

batch_net_deposit Property

Total of purchases minus credits.

Syntax

def get_batch_net_deposit() -> str: ...

batch_net_deposit = property(get_batch_net_deposit, None)

Default Value

"0000000000000000"

Remarks

Total of purchases minus credits.

This 16-digit property contains the net deposit generated by the terminal. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit/refund amounts from it.

This is a Trailer property, and is automatically computed by the class.

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

batch_record_count Property

Total number of records sent including Header, Parameter, and Trailer.

Syntax

def get_batch_record_count() -> int: ...

batch_record_count = property(get_batch_record_count, None)

Default Value

0

Remarks

Total number of records sent including Header, Parameter, and Trailer.

This property contains a batch (transaction) record count, calculated by the class. This property is supplied in the Batch Trailer Record and contains the total number of transactions in the batch -- including Header, Parameter, Detail(s), and Trailer records. This property reflects the actual number of records that have been sent, and is independent of the number of detail records sent in the settlement.

This is a Trailer property, and is automatically computed by the class.

This property is read-only.

batch_number Property

Sequence number of this batch transaction.

Syntax

def get_batch_number() -> int: ...
def set_batch_number(value: int) -> None: ...

batch_number = property(get_batch_number, set_batch_number)

Default Value

0

Remarks

This property contains a three digit batch sequence number generated by the Point of Sale (POS) device. The batch number must be within the range "001" to "999". If the POS device is automatically incrementing the batch number, it should automatically advance the number from "999" to "001"("000" is invalid). Batch numbers must not be reused or repeated within 5 consecutive days.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

If the transaction is successful, the response_code will contain "GB", which indicates a "Good Batch". You should check that the response_net_deposit and response_record_count match the batch_net_deposit and batch_record_count properties.

If the transaction is not successful and you receive an "RB" response_code (indicating a "Rejected Batch") the class fails with an error. You may inspect the error_data. error_data_field_number, error_record_type, error_sequence_number, and error_type properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the batch_number must be set to the same value that was originally used. It is critical that the same batch_number value is used to avoid duplicate charges.

detail_record_count Property

The number of records in the DetailRecord arrays.

Syntax

def get_detail_record_count() -> int: ...
def set_detail_record_count(value: int) -> None: ...

detail_record_count = property(get_detail_record_count, set_detail_record_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• detail_record_addendum
• detail_record_aggregate

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

detail_record_addendum Property

Optional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the TSYSECOMMERCE , TSYSRETAIL , or TSYSDETAILRECORD class's GetDetailAggregate method.

Syntax

def get_detail_record_addendum(detail_record_index: int) -> str: ...
def set_detail_record_addendum(detail_record_index: int, value: str) -> None: ...

Default Value

""

Remarks

Optional Detail Record Addendum data (such as Level2 or Level3 data)

The detail_record_detail_aggregate property contains an xml aggregate of the transaction retrieved from the TSYSECommerce, TSYSRetail, or TSYSDetailRecord class's GetDetailAggregate method. If you wish to accept corporate purchasing cards you will also need to send Level2, and possibly Level3 addendum data along with the detail_record_detail_aggregate. The detail_record_addendum_aggregate property takes an xml aggregate containing either Level2 or Level3 addendum data, which will be added to the detail_record_detail_aggregate. The addendum aggregate may be created with either the TSYSLevel2 or TSYSLevel3 classs, and then returned via those class's GetAddendum method.

For example:

'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()

Note that you may mix corporate and non-corporate card transactions in the same settlement. It is not necessary that all detail_record_detail_aggregates have a corresponding detail_record_addendum_aggregate.

The detail_record_index parameter specifies the index of the item in the array. The size of the array is controlled by the detail_record_count property.

detail_record_aggregate Property

Set this property with xml aggregates of the transactions you wish to settle.

Syntax

def get_detail_record_aggregate(detail_record_index: int) -> str: ...
def set_detail_record_aggregate(detail_record_index: int, value: str) -> None: ...

Default Value

""

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the TSYSRetail, or TSYSECommerce class's GetDetailAggregate method. For instance:

TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the TSYSDetailRecord class.

For example, to add a gratuity to a charge:

DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) DetailRecord.Gratuity = "500" DetailRecord.SettlementAmount = DetailRecord.AuthorizedAmount + DetailRecord.Gratuity TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

To settle a Passenger Transport transaction authorized with the sitPassengerTransport industry_type, you must use the TSYSDetailRecord class to add the number of this passenger and the total count of all passengers in the authorization code. For instance, if the authorization transaction included "Three passengers", and this is the first passenger, then the passenger number will be 1, and the passenger count 3. An example is included below:

TSYSRetail.IndustryType = sitPassengerTransport TSYSRetail.Authorize() DetailRecord.ParseAggregate TSYSRetail.GetDetailAggregate() DetailRecord.PassengerCount = 3 DetailRecord.PassengerNumber = 1 DetailRecord.Config("RestrictedTicketIndicator=True") DetailRecord.Config("TicketNumber=8382152100395") DetailRecord.Config("PassengerName=John Smith") DetailRecord.Config("DepartureDate=072117") DetailRecord.Config("Origin=JFK") DetailRecord.Config("Leg1=Carrier=DL;ServiceClass=C;StopOver=X;Destination=LAX") TSYSSettle1.IndustryType = sitPassengerTransport TSYSSettle1.Config("TravelAgencyCode=12345678") 'if ticket was issued by a travel agency TSYSSettle1.Config("TravelAgencyName=Travel and Tours") 'if ticket was issued by a travel agency TSYSSettle1.DetailAggregate[5] = DetailRecord.GetDetailAggregate()

The detail_record_index parameter specifies the index of the item in the array. The size of the array is controlled by the detail_record_count property.

error_data Property

Erroneous data contained within the property specified by DataFieldNumber .

Syntax

def get_error_data() -> str: ...

error_data = property(get_error_data, None)

Default Value

""

Remarks

Erroneous data contained within the field specified by error_data_field_number.

When you receive a Rejected Batch (ResponseCode is "RB"), this 32-character property will contain the data that caused the batch to fail. The record that contains this error is specified by error_sequence_number, and the location of the erroneous data within that record is specified by error_data_field_number.

This property is read-only.

error_data_field_number Property

Field within an invalid record that contains an error.

Syntax

def get_error_data_field_number() -> int: ...

error_data_field_number = property(get_error_data_field_number, None)

Default Value

0

Remarks

Field within an invalid record that contains an error.

When you receive a Rejected Batch (ResponseCode is "RB"), this property contains the sequential field number within the data record which caused the batch to be rejected. The erroneous data within this property is returned in error_data, and the sequence number of the record that contains this error is specified by error_sequence_number.

This property is read-only.

error_detail_record_index Property

Provides the index of the DetailRecord that caused the batch error.

Syntax

def get_error_detail_record_index() -> int: ...

error_detail_record_index = property(get_error_detail_record_index, None)

Default Value

-1

Remarks

Provides the index of the DetailRecord that caused the batch error.

When you receive a Rejected Batch (Response Code of 'RB'), this field will be populated with the index of the DetailRecord that caused the error (provided that it was a Detail Record that caused it). If no error occurred, this field will return "-1".

This property is read-only.

error_type Property

Type of batch error.

Syntax

def get_error_type() -> str: ...

error_type = property(get_error_type, None)

Default Value

""

Remarks

Type of batch error.

When you receive a Rejected Batch (ResponseCode is "RB"), this one character property will provide additional info as to the nature of the rejected batch. The following table lists the currently defined error types.

This property is read-only.

error_record_type Property

Type of record in which an error occurred.

Syntax

def get_error_record_type() -> str: ...

error_record_type = property(get_error_record_type, None)

Default Value

""

Remarks

Type of record in which an error occurred.

When you receive a Rejected Batch (ResponseCode is "RB"), this one character property defines the type of data record which caused the batch to be rejected. The table below lists all valid responses.

This property is read-only.

error_sequence_number Property

Sequence number of the record that caused an error.

Syntax

def get_error_sequence_number() -> int: ...

error_sequence_number = property(get_error_sequence_number, None)

Default Value

0

Remarks

Sequence number of the record that caused an error.

When you receive a Rejected Batch (ResponseCode is "RB"), this property will contain the sequential number of the data record which caused the rejected batch state. To obtain the index of the DetailRecord in the detail_records arrays that contains the erroneous data, please see the error_detail_record_index. The field within this record that contains erroneous data is specified by error_data_field_number, and the actual data causing the error will be contained in the error_data property.

This property is read-only.

industry_type Property

Code which indicates the industry the merchant is engaged in.

Syntax

def get_industry_type() -> int: ...
def set_industry_type(value: int) -> None: ...

industry_type = property(get_industry_type, set_industry_type)

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

merchant_bank_id Property

The number which identifies the merchant's bank or processor.

Syntax

def get_merchant_bank_id() -> str: ...
def set_merchant_bank_id(value: str) -> None: ...

merchant_bank_id = property(get_merchant_bank_id, set_merchant_bank_id)

Default Value

""

Remarks

The number which identifies the merchant's bank or processor.

This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.

Note, the TSYS Server uses the Merchant's merchant_bank_id and merchant_number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

merchant_category_code Property

Classifies a merchant by the type of store.

Syntax

def get_merchant_category_code() -> str: ...
def set_merchant_category_code(value: str) -> None: ...

merchant_category_code = property(get_merchant_category_code, set_merchant_category_code)

Default Value

""

Remarks

Classifies a merchant by the type of store.

This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).

merchant_city Property

Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.

Syntax

def get_merchant_city() -> str: ...
def set_merchant_city(value: str) -> None: ...

merchant_city = property(get_merchant_city, set_merchant_city)

Default Value

""

Remarks

Merchant's City

For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the merchant_name and merchant_state must also be specified.

The first character of this property may not be a space and must contain the same data used in the batch settlement.

Note that this property is ignored for Direct Marketing and E-Commerce transactions. merchant_service_phone is used for those industries instead of merchant_city.

This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.

merchant_country_code Property

Identifies the country where the merchant is located.

Syntax

def get_merchant_country_code() -> str: ...
def set_merchant_country_code(value: str) -> None: ...

merchant_country_code = property(get_merchant_country_code, set_merchant_country_code)

Default Value

"840"

Remarks

Identifies the country where the merchant is located.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".

merchant_currency_code Property

Identifies the type of currency used by the merchant.

Syntax

def get_merchant_currency_code() -> str: ...
def set_merchant_currency_code(value: str) -> None: ...

merchant_currency_code = property(get_merchant_currency_code, set_merchant_currency_code)

Default Value

"840"

Remarks

Identifies the type of currency used by the merchant.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

merchant_language Property

Designates the language that response messages will be returned in.

Syntax

def get_merchant_language() -> str: ...
def set_merchant_language(value: str) -> None: ...

merchant_language = property(get_merchant_language, set_merchant_language)

Default Value

"00"

Remarks

Designates the language that response messages will be returned in.

This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.

merchant_name Property

Name of the merchant.

Syntax

def get_merchant_name() -> str: ...
def set_merchant_name(value: str) -> None: ...

merchant_name = property(get_merchant_name, set_merchant_name)

Default Value

""

Remarks

Name of the merchant.

This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.

This is an optional property. However if this property is specified, the merchant_state and merchant_city (Retail) or merchant_state and merchant_service_phone (E-Commerce) must also be specified.

This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.

merchant_number Property

A unique number used to identify the merchant within the VisaNet system.

Syntax

def get_merchant_number() -> str: ...
def set_merchant_number(value: str) -> None: ...

merchant_number = property(get_merchant_number, set_merchant_number)

Default Value

""

Remarks

A unique number used to identify the merchant within the VisaNet system.

This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.

Note, the TSYS Server uses the Merchant's merchant_bank_id and merchant_number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

merchant_phone Property

Merchant's phone number.

Syntax

def get_merchant_phone() -> str: ...
def set_merchant_phone(value: str) -> None: ...

merchant_phone = property(get_merchant_phone, set_merchant_phone)

Default Value

""

Remarks

Merchant's phone number.

This property contains the Merchant's business phone number. This can be the same as the customer service phone number.

merchant_service_phone Property

Merchant's customer service number.

Syntax

def get_merchant_service_phone() -> str: ...
def set_merchant_service_phone(value: str) -> None: ...

merchant_service_phone = property(get_merchant_service_phone, set_merchant_service_phone)

Default Value

""

Remarks

Merchant's customer service number.

This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

merchant_state Property

State or province that the merchant is located in.

Syntax

def get_merchant_state() -> str: ...
def set_merchant_state(value: str) -> None: ...

merchant_state = property(get_merchant_state, set_merchant_state)

Default Value

""

Remarks

State or province that the merchant is located in.

This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.

This is an optional property. However if it is specified the Merchant merchant_name and merchant_city (Retail) or merchant_name and merchant_service_phone (E-Commerce) must also be specified.

merchant_store_number Property

Used to identify a specific merchant's store within the VisaNet system.

Syntax

def get_merchant_store_number() -> str: ...
def set_merchant_store_number(value: str) -> None: ...

merchant_store_number = property(get_merchant_store_number, set_merchant_store_number)

Default Value

""

Remarks

Used to identify a specific merchant's store within the VisaNet system.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.

merchant_street_address Property

Merchant's street address.

Syntax

def get_merchant_street_address() -> str: ...
def set_merchant_street_address(value: str) -> None: ...

merchant_street_address = property(get_merchant_street_address, set_merchant_street_address)

Default Value

""

Remarks

Merchant's street address.

This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.

merchant_terminal_number Property

Used to identify a unique terminal within a merchant location.

Syntax

def get_merchant_terminal_number() -> str: ...
def set_merchant_terminal_number(value: str) -> None: ...

merchant_terminal_number = property(get_merchant_terminal_number, set_merchant_terminal_number)

Default Value

""

Remarks

Used to identify a unique terminal within a merchant location.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.

merchant_time_zone Property

Specifies the GMT offset used to calculate the local time within the VisaNet system.

Syntax

def get_merchant_time_zone() -> str: ...
def set_merchant_time_zone(value: str) -> None: ...

merchant_time_zone = property(get_merchant_time_zone, set_merchant_time_zone)

Default Value

"705"

Remarks

Specifies the GMT offset used to calculate the local time within the VisaNet system.

This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.

Byte #1:

If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.

merchant_zip Property

Zip code where the merchant that initiated this transaction is located.

Syntax

def get_merchant_zip() -> str: ...
def set_merchant_zip(value: str) -> None: ...

merchant_zip = property(get_merchant_zip, set_merchant_zip)

Default Value

""

Remarks

Zip code where the merchant that initiated this transaction is located.

This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.

This property is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.

merchant_local_phone Property

Merchant's local phone number. Used in settlement only.

Syntax

def get_merchant_local_phone() -> str: ...
def set_merchant_local_phone(value: str) -> None: ...

merchant_local_phone = property(get_merchant_local_phone, set_merchant_local_phone)

Default Value

""

Remarks

This property should contain an 11-character merchant phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This phone number should be the number for the local merchant establishment. For the Hotel industry_type, it should contain the phone number for the actual hotel at which the customer is staying. Likewise, for the Auto Rental industry_type this property must contain the phone number for the location from which the car is actually rented.

This property is used for Hotel, Auto Rental, and Direct Marketing industry_types.

This property is only used in the settlement, and will be ignored for all authorizations.

response_code Property

Indicates the status of the batch transmission.

Syntax

def get_response_code() -> str: ...

response_code = property(get_response_code, None)

Default Value

""

Remarks

Indicates the status of the batch transmission.

This property contains the two character response code returned by the host indicating the status of the Batch Settlement attempt. The following table provides a summary of the response returned by the TSYS host:

This property is read-only.

response_net_deposit Property

Total of purchases minus credits and voids.

Syntax

def get_response_net_deposit() -> str: ...

response_net_deposit = property(get_response_net_deposit, None)

Default Value

""

Remarks

Total of purchases minus credits and voids.

This property contains the net deposit generated by the terminal. It should equal the BatchNetDesposit property, which is computed by the class. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit amounts from it. This property is represented as an absolute value and cannot be negative.

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

response_number Property

Batch number that belongs to this response.

Syntax

def get_response_number() -> int: ...

response_number = property(get_response_number, None)

Default Value

0

Remarks

Batch number that belongs to this response.

This property should be compared to the batch_number in order to match a response with a given Batch Settlement. If running in synchronous mode, this property should always be identical to batch_number.

This property is read-only.

response_record_count Property

Number of records received by the server in this batch.

Syntax

def get_response_record_count() -> int: ...

response_record_count = property(get_response_record_count, None)

Default Value

0

Remarks

Number of records received by the server in this batch.

This property contains the total number of records received by the host -- including Header, Parameter, Detail, and Trailer records. In the case of a response_code of "GB" (Good Batch), the value returned should match the value in the Batch.RecordCount property. In the case of a response_code of "RB" (Rejected Batch), this property will reflect the total number of records received until the point of failure. response_record_count + 1 will reveal the sequential number of the transaction record responsible for causing a rejected batch condition, and should be identical to the Error.SequenceNumber property in this case.

This property is read-only.

response_text Property

Contents of this property are dependent upon the Code .

Syntax

def get_response_text() -> str: ...

response_text = property(get_response_text, None)

Default Value

""

Remarks

Contents of this field are dependent upon the response_code.

This nine character property will contain the text "_ACCEPTED" when a settlement batch has been successfully received by the host. However, the Point of Sale (POS) device should examine only the response_code to determine the status of a particular Batch Settlement.

This property is read-only.

response_transmission_date Property

Date that the batch was settled.

Syntax

def get_response_transmission_date() -> str: ...

response_transmission_date = property(get_response_transmission_date, None)

Default Value

""

Remarks

Date that the batch was settled.

This property is reserved, pending the future upgrade to a higher protocol version.

This property is read-only.

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 are designations of 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. PKCS12 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 displayed below.

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.

terminal_id Property

Contains number to accommodate a POS device tracking number.

Syntax

def get_terminal_id() -> str: ...
def set_terminal_id(value: str) -> None: ...

terminal_id = property(get_terminal_id, set_terminal_id)

Default Value

"00000001"

Remarks

This eight digit field contains the number to accommodate a Point Of Sale (POS) device tracking number. This field is also known as the "V" number. Unless otherwise specified by the merchant's bank or processor, this field should be defaulted to "00000001".

Note: If specified, the "V" alpha character must be changed to a numeric 7 when setting this property.

This is a Parameter Property, and need only be set once for a single Batch Settlement transaction.

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

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

Resets all the properties of the entire settlement to their default values.

Syntax

def reset() -> None: ...

Remarks

This method resets the Header and Parameter Record properties to default values, and clears all Detail Records. To clear only the Detail Records (leaving Header and Parameter records intact) set the DetailRecordCount property to 0.

send_settlement Method

Begins a Batch Settlement transaction with the transaction server.

Syntax

def send_settlement() -> None: ...

Remarks

This begins a Batch Settlement transaction. The Header Record, Parameter Record, all transaction Detail Records, and the computed Trailer Record are sent sequentially to the Vital/TSYS host.

If the transaction is successful, the response_code will contain "GB", which indicates a "Good Batch". You should check that the response_net_deposit and response_record_count match the batch_net_deposit and batch_record_count properties.

If the transaction is not successful and you receive an "RB" response_code (indicating a "Rejected Batch") the class fails with an error. You may inspect the error_data. error_data_field_number, error_record_type, error_sequence_number, and error_type properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the batch_number must be set to the same value that was originally used. It is critical that the same batch_number value is used to avoid duplicate charges.

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

class TSYSSettleConnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class TSYSSettle:
@property
def on_connected() -> Callable[[TSYSSettleConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[TSYSSettleConnectedEventParams], None]) -> None: ...

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_data_packet_in Event

Fired when receiving a data packet from the transaction server.

Syntax

class TSYSSettleDataPacketInEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class TSYSSettle:
@property
def on_data_packet_in() -> Callable[[TSYSSettleDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[TSYSSettleDataPacketInEventParams], None]) -> None: ...

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

on_data_packet_out Event

Fired when sending a data packet to the transaction server.

Syntax

class TSYSSettleDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class TSYSSettle:
@property
def on_data_packet_out() -> Callable[[TSYSSettleDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[TSYSSettleDataPacketOutEventParams], None]) -> None: ...

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

on_disconnected Event

Fired when a connection is closed.

Syntax

class TSYSSettleDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class TSYSSettle:
@property
def on_disconnected() -> Callable[[TSYSSettleDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[TSYSSettleDisconnectedEventParams], None]) -> None: ...

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.

Please refer to the Error Codes section for more information.

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

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

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

TSYSSettle Config Settings

TSYSSettle 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

TSYSSettle Errors

TSYSSettle 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