TSYSGiftCard Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSGiftCard class is used to manipulate funds on Gift and Prepaid Cards using the Vital/TSYS payment system. This class supports card-present gift card transactions, and allows for simple, direct, secure communication 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.

Syntax

class dpaymentssdk.TSYSGiftCard

Remarks

This class supports two different kinds of Stored Value cards. Gift Cards and Prepaid Cards. Gift Cards support only the Fifth/Third and Stored Value Systems (SVS) receiving_institutions, and a merchant must have software (such as this class) to authorize gift card Purchase (redemption) transactions. On the other hand, Prepaid cards (once activated) authorize exactly like credit cards, and can be used at any store. Examples of gift and cards include a retailer's gift card, a prepaid telephone card, and a reloadable subway pass. Examples of prepaid cards would be the prepaid cards purchased at shopping malls, or sometimes given away as promotional gimmicks. Not included in either of these are government income-support cards, otherwise known as EBT cards or electronic food stamps. (Use the TSYSBenefit class for EBT cards).

The TSYSGiftCard class makes these transactions 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 properties with setup information acquired from your member bank or processor. For instance:

TSYSGiftCard1.MerchantBankId = "999995" TSYSGiftCard1.MerchantNumber = "888000002447" TSYSGiftCard1.MerchantName = "TEST_MERCHANT" TSYSGiftCard1.MerchantTerminalNumber = "1515" TSYSGiftCard1.MerchantStoreNumber = "5999" TSYSGiftCard1.MerchantCategoryCode = "5999" TSYSGiftCard1.MerchantCity = "Durham" TSYSGiftCard1.MerchantState = "NC" TSYSGiftCard1.MerchantZip = "27713" TSYSGiftCard1.MerchantTimeZone = "705" TSYSGiftCard1.MerchantABANumber = "123456789" TSYSGiftCard1.MerchantSettlementAgent = "V123" TSYSGiftCard1.AgentBankNumber = "000000" TSYSGiftCard1.AgentChainNumber = "111111" TSYSGiftCard1.IndustryType = itRetail TSYSGiftCard1.ReceivingInstitution = riFifthThird

Next, set properties that contain details about the transaction. The transaction_number is a sequence number, and should be incremented for each transaction you send. transaction_amount is the amount of sale, plus any cash_back_amount returned to the customer, formatted with an implicit decimal place (cash_back_amount is only applicable to the ttGiftCardPurchase transaction_type). The card_magnetic_stripe data for Prepaid cards can be either track1 or track2, but Gift cards support only the dsTrack2 card_entry_data_source. Both types support manual entry via the card_number, card_exp_month, and card_exp_year properties.

In addition, you are also be required to set an employee_id and batch_number for Gift Card transactions. (These are ignored for Prepaid transactions). Even though Gift Card transactions are not submitted for settlement, the batch_number should reflect the batch sequence number of the current batch. The employee_id is a unique number used to identify the employee operating the terminal being used to issue gift cards. For example:

TSYSGiftCard1.TransactionNumber = 1 TSYSGiftCard1.BatchNumber = 123 TSYSGiftCard1.EmployeeId = "12345678" TSYSGiftCard1.TransactionAmount = "1000" TSYSGiftCard1.CashBackAmount = "300" TSYSGiftCard1.CardTrack2Data = "9999999800002773=09121015432112345678"

The TSYSGiftCard class supports both Gift Card and Prepaid Cards, so you should make sure to choose the correct transaction_type for the type of card you are using. Then call the authorize method to submit the transaction.

TSYSGiftCard1.TransactionType = ttGiftCardPurchase TSYSGiftCard1.Authorize()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The response_code indicates whether the transaction was approved, and the remaining properties provide additional information about the transaction.

Note that Gift Card and Prepaid Card transactions, with the exception of the ttPrepaidCardPurchase transaction_type are real-time transactions, and cannot be settled with the TSYSSettle class. ttPrepaidCardPurchase is identical to a credit card purchase made with the TSYSRetail class, so it must be settled with the TSYSSettle class. However, using this class to authorize Prepaid card transactions allows you to retrieve balance information and allow partial authorizations.

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.

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.

batch_number Property

The batch number that this transaction will be included in.

Syntax

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

batch_number = property(get_batch_number, set_batch_number)

Default Value

1

Remarks

Unlike regular credit card transactions, Debit, EBT, and GiftCard transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSSettle class's BatchNumber property. The range is from 1 to 999.

Note, this property is ignored for Prepaid Card transactions.

card_type Property

Type of credit card being used in this transaction.

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

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the card_number is set, but it can also be changed manually. A list of valid card types is included below.

card_cvv_data Property

Three digit security code on back of card (optional).

Syntax

def get_card_cvv_data() -> str: ...
def set_card_cvv_data(value: str) -> None: ...

card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the card_cvv_data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, card_cvv_presence will be automatically set to cvpProvided. If set to empty string (""), card_cvv_presence will be automatically set to cvpNotProvided.

card_cvv_presence Property

Indicates the presence of the card verification value.

Syntax

def get_card_cvv_presence() -> int: ...
def set_card_cvv_presence(value: int) -> None: ...

card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of card_cvv_data.

The class will automatically set this value to cvpProvided when a card_cvv_data value is specified. You can explicitly specify the card_cvv_presence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

card_entry_data_source Property

This property contains a 1-character code identifying the source of the customer data.

Syntax

def get_card_entry_data_source() -> int: ...
def set_card_entry_data_source(value: int) -> None: ...

card_entry_data_source = property(get_card_entry_data_source, set_card_entry_data_source)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

card_exp_month Property

Expiration month of the credit card specified in Number .

Syntax

def get_card_exp_month() -> int: ...
def set_card_exp_month(value: int) -> None: ...

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

1

Remarks

Expiration month of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

card_exp_year Property

Expiration year of the credit card specified in Number .

Syntax

def get_card_exp_year() -> int: ...
def set_card_exp_year(value: int) -> None: ...

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

2000

Remarks

Expiration year of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

card_is_encrypted Property

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

def get_card_is_encrypted() -> bool: ...
def set_card_is_encrypted(value: bool) -> None: ...

card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)

Default Value

FALSE

Remarks

Determines whether data set to the card_number or card_magnetic_stripe fields is validated.

By default, when the card_number or card_magnetic_stripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and card_magnetic_stripe data will be parsed for the track specified by card_entry_data_source. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the card_number or card_magnetic_stripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the card_type may be affected, and the card number will not be verified.

card_magnetic_stripe Property

Track data read off of the card's magnetic stripe.

Syntax

def get_card_magnetic_stripe() -> str: ...
def set_card_magnetic_stripe(value: str) -> None: ...

card_magnetic_stripe = property(get_card_magnetic_stripe, set_card_magnetic_stripe)

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If card_entry_data_source is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the card_entry_data_source property to indicate which track you are sending.

The following example shows how to set the card_magnetic_stripe and card_entry_data_source properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

card_number Property

Customer's credit card number for the transaction.

Syntax

def get_card_number() -> str: ...
def set_card_number(value: str) -> None: ...

card_number = property(get_card_number, set_card_number)

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with card_magnetic_stripe data, this property should be left empty.

cash_back_amount Property

Amount returned to the customer in cash.

Syntax

def get_cash_back_amount() -> str: ...
def set_cash_back_amount(value: str) -> None: ...

cash_back_amount = property(get_cash_back_amount, set_cash_back_amount)

Default Value

""

Remarks

This property may contain an optional cash back amount when authorizing a Debit Purchase transaction, EBT Cash Benefit Purchase, or a Gift Card Purchase transaction. The value of transaction_amount must reflect the cost of the goods or service purchased plus this cash_back_amount.

Note: cash_back_amount must be empty for Restaurant IndustryType as this is not supported by TSYS.

Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.

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: For EBT Withdrawal transactions, cash_back_amount must be empty. However, when creating detail records for the settlement of the transaction, the DebitCashBack in the detail record must match the transaction_amount for the authorization.

Note, this property is only valid for the ttGiftCardPurchase transaction_type. Trying to send any other transaction_type with cash back will cause the class to fail with an error.

customer_address Property

The customer's billing address.

Syntax

def get_customer_address() -> str: ...
def set_customer_address(value: str) -> None: ...

customer_address = property(get_customer_address, set_customer_address)

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the customer_zip property.

This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.

Per TSYS specs, the following rules apply:

• In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
• There must be a (space) between two consecutive data elements that are only numeric.

In order to maximize the address information included in the request, it is suggested that you strip out the spaces (when possible) and punctuations before setting the property.

Note the following examples:

• "1234 56th Street" is equivalent to: "1234 56Street"
• "1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
• "1391 ELM STREET" is equivalent to: "1391ELMSTREET"
• "P.O. BOX 24356" is equivalent to: "POBOX24356"

The length of this property is 19 characters, and any string longer than this fails with an error. If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

customer_zip Property

Customer's zip code (or postal code if outside of the USA).

Syntax

def get_customer_zip() -> str: ...
def set_customer_zip(value: str) -> None: ...

customer_zip = property(get_customer_zip, set_customer_zip)

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

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

employee_id Property

Identification number of the Employee making this transaction.

Syntax

def get_employee_id() -> str: ...
def set_employee_id(value: str) -> None: ...

employee_id = property(get_employee_id, set_employee_id)

Default Value

""

Remarks

This property identifies the operator initiating this transaction, and should be a unique value defined for each employee within the merchant. This field is only required if the merchant participates in a program where operator level reporting is performed.

Note, this property is ignored for Prepaid Card transactions.

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.

Note: itDirectMarketing, itHotel, and itAutoRental are NOT supported for this class All Debit, EBT, and Gift Card transactions must be face-to-face card present transactions.

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.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this property is ignored. merchant_service_phone is used for those industries instead of merchant_city (this does not apply to MasterCard).

Note: This property must contain the same data used in the batch settlement. The first character of this property may not be a space. 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:

Bytes #2-3:

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_aba_number Property

Merchant's routing number.

Syntax

def get_merchant_aba_number() -> str: ...
def set_merchant_aba_number(value: str) -> None: ...

merchant_aba_number = property(get_merchant_aba_number, set_merchant_aba_number)

Default Value

""

Remarks

This property identifies the merchant to a direct debit switch, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 9 digits in length.

merchant_settlement_agent Property

Merchant's settling agent.

Syntax

def get_merchant_settlement_agent() -> str: ...
def set_merchant_settlement_agent(value: str) -> None: ...

merchant_settlement_agent = property(get_merchant_settlement_agent, set_merchant_settlement_agent)

Default Value

""

Remarks

This property identifies the merchant settling agent, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 4 digits in length.

original_purchase_date Property

Date and time of original purchase, used for returns.

Syntax

def get_original_purchase_date() -> str: ...
def set_original_purchase_date(value: str) -> None: ...

original_purchase_date = property(get_original_purchase_date, set_original_purchase_date)

Default Value

""

Remarks

This property is only applicable for Debit Credit transactions and Gift Card Refund transactions. If supplied, this property must be 8 characters long and formatted as "MMDDhhmm" (month, day, hour, minute).

Note that this property is only valid for the ttGiftCardRefund transaction_type, and will be ignored for all other transactions.

partial_redemption Property

Partial Redemption indicator.

Syntax

def get_partial_redemption() -> bool: ...
def set_partial_redemption(value: bool) -> None: ...

partial_redemption = property(get_partial_redemption, set_partial_redemption)

Default Value

FALSE

Remarks

If the customer does not have enough on his stored value card to cover the complete cost of the purchase, the merchant may request that the host perform a partial redemption. The stored value card will be used to fund as much of the transaction as possible, and the remainder may be funded by some other form of payment. When partial_redemption is set to True, the host will supply the actual amount authorized from the stored value card in the response_authorized_amount property.

Note that the response_authorized_amount will only contain a value if partial_redemption is set to True, and will remain blank otherwise. If the Stored Value card has a zero balance before submitting this transaction, it will be declined regardless of the value of partial_redemption.

receiving_institution Property

Indicates which gift card network to use.

Syntax

def get_receiving_institution() -> int: ...
def set_receiving_institution(value: int) -> None: ...

receiving_institution = property(get_receiving_institution, set_receiving_institution)

Default Value

0

Remarks

This field contains a secondary network routing identifier, which indicates the gift card network to be used to process transactions. This is necessary because private issue gift card number ranges may conflict with ranges assigned to major credit card issuers. The supported receiving institutions include:

Note, this property is ignored for Prepaid Card transactions.

response_approval_code Property

Contains an authorization code when a transaction has been approved.

Syntax

def get_response_approval_code() -> str: ...

response_approval_code = property(get_response_approval_code, None)

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved.

This six character property contains an authorization code when a transaction has been approved. If the response_code returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The response_approval_code must be stored and submitted in the settlement data capture record.

This property is read-only.

response_authorized_amount Property

Amount actually used from the card (used when supporting partial redemptions).

Syntax

def get_response_authorized_amount() -> str: ...

response_authorized_amount = property(get_response_authorized_amount, None)

Default Value

""

Remarks

Amount actually used from the card (used when supporting partial redemptions).

The response_authorized_amount represents the actual approved transaction amount when a transaction request is received from a client using the partial_redemption option. If partial_authorization is set to True, then response_authorized_amount will be the amount of the transaction_amount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.

For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the partial_authorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the response_authorized_amount will represent the approved amount of $7.50.In this case, the response_code will also be "00" (Approval). The merchant must tender the difference between the requested transaction_amount and the response_authorized_amount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the transaction_amount) then this property will be "0" or "".

If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of partial_authorization.

This property is read-only.

response_auth_source Property

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

def get_response_auth_source() -> str: ...

response_auth_source = property(get_response_auth_source, None)

Default Value

""

Remarks

Indicates the source of the authorization code stored in response_approval_code.

This property contains a one character code indicating the source of the response_approval_code. The received code must be stored and submitted in the batch settlement. Valid source codes are:

* Currently in use by Japan Acquirer Services (JAS).

This property is read-only.

response_avs_result Property

Contains the Address Verification System result code.

Syntax

def get_response_avs_result() -> str: ...

response_avs_result = property(get_response_avs_result, None)

Default Value

""

Remarks

Contains the Address Verification System result code.

This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:

*AVS Result Code for International addresses only

This property is read-only.

response_balance Property

Available balance remaining on card.

Syntax

def get_response_balance() -> str: ...

response_balance = property(get_response_balance, None)

Default Value

""

Remarks

Available balance remaining on card.

This property contains the Available Balance remaining on the card following the transaction that was just authorized. It represents the balance on the card prior to the transaction, minus the transaction_amount from this transaction. For example, if a card has a $20.00 balance prior to a $15.00 ttGiftCardPurchase authorization, then the response_balance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).

Note that this balance will be returned for all transaction_types, not just Balance Inquiries.

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_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 a two character 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 "85" represents a successful card verification (when the transaction_type set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. 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_cvv_result Property

Contains the returned CVV result code if it was requested.

Syntax

def get_response_cvv_result() -> str: ...

response_cvv_result = property(get_response_cvv_result, None)

Default Value

""

Remarks

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an response_text indicating such. The following is a list of current result codes:

This property is read-only.

response_host_message_id Property

Unique host message identifier (Reserved for future use).

Syntax

def get_response_host_message_id() -> str: ...

response_host_message_id = property(get_response_host_message_id, None)

Default Value

""

Remarks

Unique host message identifier (Reserved for future use).

This property will contain a unique host message identifier assigned by the authorizing system and returned in Debit, EBT, and Gift card response messages. This property is reserved for future use and will most likely contain spaces.

This property is read-only.

response_network_id Property

Identification code of the network on which the transaction was authorized.

Syntax

def get_response_network_id() -> str: ...

response_network_id = property(get_response_network_id, None)

Default Value

""

Remarks

Identification code of the network on which the transaction was authorized.

This property indicates the network through which the transaction was authorized. If this property contains a "V" or a "5", this indicates the transaction was processed as a credit card purchase transaction even though it was originally submitted as a debit transaction. When these values ("V" or "5") are returned, the transaction must be settled as a credit card (non-debit) transaction.

The response_network_id must be printed on the customer's receipt.

The following values may be returned by the TSYS host:

This property is valid for Debit card and EBT card transactions only. It will be ignored for all other transaction_types.

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_returned_aci Property

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

def get_response_returned_aci() -> str: ...

response_returned_aci = property(get_response_returned_aci, None)

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character property contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the response_transaction_id or response_validation_code properties.

This property is read-only.

response_settle_date Property

Date at which the Debit, EBT, or Gift Card transaction will settle.

Syntax

def get_response_settle_date() -> str: ...

response_settle_date = property(get_response_settle_date, None)

Default Value

""

Remarks

Date at which the Debit, EBT, or Gift Card transaction will settle.

This property contains a four-character transaction settlement date as returned by the TSYS Acquiring Solutions authorization system. This date is in "MMDD" format, and indicates the date at which this transaction will settle. This date does not have to match the date you actually submit this transaction in a batch settlement.

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_trace Property

System Trace Audit Number returned for Debit transactions.

Syntax

def get_response_trace() -> str: ...

response_trace = property(get_response_trace, None)

Default Value

""

Remarks

System Trace Audit Number returned for Debit transactions.

This property contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages.

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_id Property

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

def get_response_transaction_id() -> str: ...

response_transaction_id = property(get_response_transaction_id, None)

Default Value

""

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) 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.

response_validation_code Property

This optional property contains information generated by the card issuer.

Syntax

def get_response_validation_code() -> str: ...

response_validation_code = property(get_response_validation_code, None)

Default Value

""

Remarks

This optional property contains information generated by the card issuer.

This optional four character property contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.

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

Additional Notes

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.

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

transaction_amount Property

Purchase amount to be authorized.

Syntax

def get_transaction_amount() -> str: ...
def set_transaction_amount(value: str) -> None: ...

transaction_amount = property(get_transaction_amount, set_transaction_amount)

Default Value

""

Remarks

This field contains the transaction amount to be authorized.

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.

transaction_number Property

Sequence number of this transaction.

Syntax

def get_transaction_number() -> int: ...
def set_transaction_number(value: int) -> None: ...

transaction_number = property(get_transaction_number, set_transaction_number)

Default Value

0

Remarks

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the response_transaction_number for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

transaction_type Property

Specifies the type of Gift Card transaction to process.

Syntax

def get_transaction_type() -> int: ...
def set_transaction_type(value: int) -> None: ...

transaction_type = property(get_transaction_type, set_transaction_type)

Default Value

15

Remarks

This property indicates the type of Gift Card transaction to send. The following table explains the transaction types in detail:

authorize Method

Sends a Gift Card transaction.

Syntax

def authorize() -> None: ...

Remarks

This method sends a Gift Card authorization request to the Vital/TSYS host. The type of transaction sent is based upon the value of the transaction_type property. If the request was successful, the response_code property will contain "00".

Note that only ttPrepaidCardPurchase transactions are settled with the TSYSSettle class. All other transactions (including ttGiftCardPurchase) take place in real time. Instead of using this class to authorize Prepaid Card purchases, you may opt to use the TSYSRetail class instead. However, this class allows you to support partial_redemption, and will also return the prepaid card's available balance in the response_balance property.

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_detail_aggregate Method

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

def get_detail_aggregate() -> str: ...

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

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

Note that ttPrepaidCardPurchase transactions are identical to regular credit card authorizations, and thus must be settled like credit card transactions. Attempting to call this method for any other transaction_type will cause the class to fail with an error.

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_connected Event

Fired immediately after a connection completes (or fails).

Syntax

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

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

# In class TSYSGiftCard:
@property
def on_connected() -> Callable[[TSYSGiftCardConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[TSYSGiftCardConnectedEventParams], 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 TSYSGiftCardDataPacketInEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class TSYSGiftCard:
@property
def on_data_packet_in() -> Callable[[TSYSGiftCardDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[TSYSGiftCardDataPacketInEventParams], 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 TSYSGiftCardDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class TSYSGiftCard:
@property
def on_data_packet_out() -> Callable[[TSYSGiftCardDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[TSYSGiftCardDataPacketOutEventParams], 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 TSYSGiftCardDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class TSYSGiftCard:
@property
def on_disconnected() -> Callable[[TSYSGiftCardDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[TSYSGiftCardDisconnectedEventParams], 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 TSYSGiftCardErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class TSYSGiftCard:
@property
def on_error() -> Callable[[TSYSGiftCardErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TSYSGiftCardErrorEventParams], 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 TSYSGiftCardSSLServerAuthenticationEventParams(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 TSYSGiftCard:
@property
def on_ssl_server_authentication() -> Callable[[TSYSGiftCardSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[TSYSGiftCardSSLServerAuthenticationEventParams], 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 TSYSGiftCardSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

TSYSGiftCard Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

TSYSGiftCard Config Settings

Base Config Settings

TSYSGiftCard Errors

TSYSGiftCard Errors

	501   Data field invalid length.
	502   Data field invalid format.
	503   Data field out of range.
	504   Luhn digit check failed.
	505   Card date invalid.
	506   Card expired.
	507   Card type unknown.
	509   No gateway specified.
	511   Invalid data entered.
	512   Truncated response.
	513   Invalid response.
	517   Response length mismatch.
	518   LRC check failed.
	519   Corrupt response.
	520   Response packet empty.
	521   Response truncated.
	522   Host disconnected.
	523   No response from host.
	524   Server error response.
	526   Invalid timeout value.
	527   Vital/TSYS returned an error response.
	535   Signature verification failed.
	544   Error building packet.
	593   Missing or erroneous property value. Cannot send transaction.
	594   Response received before transmission completed.
	595   Prematurely disconnected (check merchant_number and merchant_bank_id).
	596   Pending responses max number exceeded (Interleaved).
	597   Pending response timeout (Interleaved).

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

TCPClient Errors

	100   You cannot change the remote_port at this time. A connection is in progress.
	101   You cannot change the remote_host (Server) at this time. A connection is in progress.
	102   The remote_host address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the local_port at this time. A connection is in progress.
	107   You cannot change the local_host at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   remote_port cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).