TSYSECommerce Class
Properties Methods Events Config Settings Errors
The TSYSECommerce class is an advanced tool used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This class makes authorizing these types of transactions very easy.
Syntax
class dpaymentssdk.TSYSECommerce
Remarks
This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
The TSYSECommerce class makes authorizing Card-Not-Present Mail Order and E-Commerce 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:
class.MerchantBankId = "999995" '(BIN number)
class.MerchantCategoryCode = "5999"
class.MerchantName = "test merchant"
class.MerchantNumber = "123456789012"
class.MerchantServiceNumber = "800-1234567"
class.MerchantState = "CA"
class.MerchantStoreNumber = "5999"
class.MerchantTerminalNumber = "1515"
class.MerchantZip = "90210"
Then, set the customer's credit card information, as well as his address and zip code (the address and zip code will be checked by the Vital/TSYS servers to make sure it matches the customer's billing address).
class.CardNumber = "4444333322221111"
class.CardExpMonth = 1
class.CardExpYear = 2009
class.CardCVVData = "999"
class.CustomerAddress = "8320 South Hardy Dr."
class.CustomerZip = "85284"
Next, set properties that contain details about the transaction. At the minimum, you must set a transaction_amount and transaction_number. However, you may also set the transaction_type if you are doing a Mail Order or Recurring transaction.
class.TransactionAmount = "100"
class.TransactionNumber = 1
class.TransactionType = ttECommerce
Finally, submit the transaction by calling the authorize method. 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 response_avs_result indicates whether the customer's billing address on file with his credit card company matches the information presented in the customer_address and customer_zip properties. The remaining properties provide additional information about the transaction.
Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the get_detail_aggregate method to the TSYSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.
Note: The TSYSECommerce class can be used to pass 3D-Secure and MasterCard SecureCode authentication data in an authorization to achieve a better interchange rate. To send this data, the ECI, XID and CAVV (3D-Secure), UCAFIndicator, UCAFSecurityIndicator and UCAFData (MasterCard SecureCode) configuration variables must be set before calling authorize. The CAVV and UCAF authentication result code will be returned in the ResponseCAVV and ResponseUCAF configuration settings, respectively. For Mastercard Identity Check transactions you must set the ProgramProtocol and DirectoryServerTxnID configs.
Further Note: When sending e-commerce transactions, you must send a PurchaseIdentifier (sometimes referred to as Invoice Number) in the settlement. This can be done via the PurchaseIdentifier property of the TSYSDetailRecord class. Failure to set a PurchaseIdentifier for the e-commerce Industry Type may result in a CPS downgrade when the transaction is settled, and can cause higher interchange rates.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
card_type | Type of credit card being used in this transaction. |
card_cvv_data | Three digit security code on back of card (optional). |
card_cvv_presence | Indicates the presence of the card verification value. |
card_entry_data_source | This property contains a 1-character code identifying the source of the customer data. |
card_exp_month | Expiration month of the credit card specified in Number . |
card_exp_year | Expiration year of the credit card specified in Number . |
card_is_encrypted | Determines whether data set to the Number or MagneticStripe properties is validated. |
card_magnetic_stripe | Track data read off of the card's magnetic stripe. |
card_number | Customer's credit card number for the transaction. |
customer_address | The customer's billing address. |
customer_zip | Customer's zip code (or postal code if outside of the USA). |
goods_indicator | Used to identify the type of goods purchased over the Internet. |
merchant_bank_id | The number which identifies the merchant's bank or processor. |
merchant_category_code | Classifies a merchant by the type of store. |
merchant_city | Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. |
merchant_country_code | Identifies the country where the merchant is located. |
merchant_currency_code | Identifies the type of currency used by the merchant. |
merchant_language | Designates the language that response messages will be returned in. |
merchant_name | Name of the merchant. |
merchant_number | A unique number used to identify the merchant within the VisaNet system. |
merchant_phone | Merchant's phone number. |
merchant_service_phone | Merchant's customer service number. |
merchant_state | State or province that the merchant is located in. |
merchant_store_number | Used to identify a specific merchant's store within the VisaNet system. |
merchant_street_address | Merchant's street address. |
merchant_terminal_number | Used to identify a unique terminal within a merchant location. |
merchant_time_zone | Specifies the GMT offset used to calculate the local time within the VisaNet system. |
merchant_zip | Zip code where the merchant that initiated this transaction is located. |
response_approval_code | Contains an authorization code when a transaction has been approved. |
response_authorized_amount | Amount actually used from the card (used when supporting partial redemptions). |
response_auth_source | Indicates the source of the authorization code stored in ApprovalCode . |
response_avs_result | Contains the Address Verification System result code. |
response_card_level | This property contains a two-character code created by Visa during the authorization process. |
response_code | Indicates the status of the authorization request. |
response_commercial_card_type | Response property that indicates whether the card is a commercial card. |
response_cvv_result | Contains the returned CVV result code if it was requested. |
response_retrieval_number | This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement. |
response_returned_aci | Returned Authorization Characteristics Indicator contains CPS qualification status. |
response_text | Text information that describes each response code. |
response_transaction_date | Local transaction date returned from the server in MMddyy format. |
response_transaction_id | Contains the Transaction Identifier or MasterCard Reference Number. |
response_transaction_number | Check this property against the original Transaction Number. |
response_transaction_time | Local transaction time returned from the server in HHmmss format. |
response_validation_code | This optional property contains information generated by the card issuer. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_provider | This specifies the SSL/TLS implementation to use. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
timeout | A timeout for the class. |
transaction_amount | Purchase amount to be authorized. |
transaction_number | Sequence number of this transaction. |
transaction_type | Specifies the type of transaction to process. |
visa_mvv | The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
authenticate_card | Determines only if a card has been lost or stolen. |
authorize | Sends an authorization request. |
config | Sets or retrieves a configuration setting. |
get_detail_aggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
interrupt | Interrupts the current action. |
reset | Clears all properties to their default values. |
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.
on_connected | Fired immediately after a connection completes (or fails). |
on_data_packet_in | Fired when receiving a data packet from the transaction server. |
on_data_packet_out | Fired when sending a data packet to the transaction server. |
on_disconnected | Fired when a connection is closed. |
on_error | Information about errors during data delivery. |
on_response | Used with Interleaved Transaction Mode. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AcceptanceDeviceType | Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions. |
ACI | Requested Authorization Characteristics Indicator (ACI). |
ActivateTerminal | Authenticates a POS device with TSYS. |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
AmexAggregatorName | Amex Payment Service Provider/Aggregator Name. |
AmexAirlinePassengerData | Used by Merchants that are in the airline industry to submit information for Passenger Transport transactions. |
AmexCNPInternetPhoneData | Used by Merchants in mail-, telephone- and internet-order industries to submit additional data for Card Not Present transactions. |
AmexCPGoodsSoldData | Identifies merchandise such as gift cards, computers, and other electronics that can be resold for cash. |
AuthenticationCode | An alphanumeric code provided to the POS user for input when authenticating a POS device. |
AuthorizationIndicator | The type of authorization request. |
BusinessApplicationId | Business Application Identifier (BAI). Visa only. |
CanadaDomesticIndicator | Canada Domestic Indicator. |
CardholderId | Specifies the method used to verify the identity of the cardholder. |
CAVV | AuthenticationCAVV data from the ThreeDSecure class. |
CITMITIndicator | CIT/MIT Indicator. |
CountryCode | Identifies the country where the merchant is located. |
CumulativeAmount | Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only). |
CurrencyCode | Identifies the type of currency used by the merchant. |
CurrentPendingResponseCount | Current number of pending response packets. |
DeactivateTerminal | Deactivates a POS device with TSYS. |
DigitalPaymentCryptogram | Digital Payment Cryptogram used for DSRP transactions (Mastercard only). |
DirectoryServerTxnID | Directory Server Transaction ID generated by the EMV 3DS Mastercard Directory Server during authentication (Mastercard only). |
DisconnectInterleaved | To explicitly terminate the connection. |
DoEvents | Processes events from the internal message queue. |
ECI | Electronic Commerce Indicator. |
GatewayID | A unique value to identify a Gateway or Aggregator. |
GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
HeartlandDeviceId | Specifies a device ID to uniquely identify each terminal (card data entry device). |
HeartlandEncryptionMode | Specifies the encryption mode to use in Heartland transactions. |
HeartlandKeyBlock | Specifies the key block used to encrypt the data. |
IncrementalApprovalCode | Transaction Approval Code associated with authorization to increment. |
IncrementalRetrievalNumber | Transaction Retrieval Number associated with authorization to increment. |
IncrementalTransDate | Transaction Date associated with authorization to increment. |
IncrementalTransId | Transaction Id associated with authorization to increment. |
IncrementalTransTime | Transaction Time associated with authorization to increment. |
InstallmentCount | Total number of recurring or installment payments. |
InstallmentNumber | Current installment number. |
InterleavedMode | Determines whether to use Interleaved Transaction Mode for authorization requests. |
InterleavedTimeout | Timeout value to wait for a response from TSYS. |
IsBillPayment | Indicates that the transaction is a bill payment transaction. |
IsEstimatedAmount | Specifies whether the amount is an estimate. Visa transactions only. |
IsMerchantInitiatedTransaction | Set this to process a Merchant Initiated transaction. |
ISOIdentifier | ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover. |
IsPassengerTransport | Indicates that the transaction is a passenger transport transaction. |
IsPurchaseReturnAuthorization | Set this to process a Purchase Return Authorization transaction. |
LocationDetailAddress | Merchant's street address. |
LocationDetailCity | Name of the city. |
LocationDetailCountry | Country code. |
LocationDetailEmail | Merchant's e-mail adress. |
LocationDetailName | Merchant name. |
LocationDetailPhone | Merchant's phone number. |
LocationDetailPostal | Postal code. |
LocationDetailRegion | Region code that corresponds to the state, province, or other country subdivision. |
MastercardWalletId | Mastercard Wallet Identifier used to identify the Wallet Provider. |
MaxPendingResponseCount | Maximum number of pending response packets. |
MerchantLanguage | Designates the language that response messages will be returned in. |
MerchantSellerID | Merchant's Seller ID. |
MessageReasonCode | Code used to identify MIT or Deferred Authorizations for Visa. |
MITTransactionId | Transaction Id associated with the original authorization of a Merchant Initiated Transaction. |
MPGID | Merchant Payment Gateway ID. |
OriginalAmount | The Original Amount related to a previous Consumer Initiated Transaction (Discover only). |
OriginalAmountAccountType | The Account Type of the Original Amount (Discover only). |
PFAcquirerInternalReferenceNumber | Acquirer Internal Reference Number (AIRN) (Discover only). |
PFForeignRetailerIndicator | The Payment Facilitator Foreign Retailer Indicator (Visa only). |
PFIdentifier | The Payment Facilitator/Marketplace Identifier assigned by Visa, MasterCard, or Discover. |
PFNameSubMerchantName | The Payment Facilitator Name*Sub-Merchant name. |
PFSubMerchantCity | The Payment Facilitator Sub-Merchant City. |
PFSubMerchantCountry | The Payment Facilitator Sub-Merchant Country Code. |
PFSubMerchantIdentifier | The Payment Facilitator Sub-Merchant Identifier. |
PFSubMerchantPostalCode | The Payment Facilitator Sub-Merchant Postal Code. |
PFSubMerchantState | The Payment Facilitator Sub-Merchant State/Province Code. |
Port | The port to which transactions are posted. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
POSEnvironmentIndicator | Provides additional information about the transaction for Visa. |
Processor | Specifies the Processor you are connecting to. |
ProgramProtocol | Identifies the version of the EMV 3D-Secure protocol (Mastercard only). |
PurchaseIdentifier | Optional purchase order number assigned by the merchant. |
RegisteredUserLastProfileDateChange | Registered User Last Profile Date Change (in DDMMYYYY format). Discover, Diners, JCB, and CUP only. |
RequestToken | Indicates whether to request a token for the specified card data sent in an Authorize request. |
ResponseCardholderVerification | Verification results for cardholder identification data (extended AVS). |
ResponseCAVV | Used for 3D-Secure transactions. Indicates whether the submitted CAVV value passed validation. |
ResponseMerchantAdviceCode | The Merchant Advice Code returned by Mastercard MIP for declined CNP transactions. |
ResponseStoreNumber | Check this field against the original Merchant StoreNumber. |
ResponseTerminalNumber | Check this field against the original Merchant TerminalNumber. |
ResponseTokenPAN | Card Brand Token PAN Last 4 Digits returned in the response. |
ResponseTokenStatus | The status of retrieval of the token. |
ResponseTransactionIntegrityClass | A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class. |
ResponseUCAF | Used for MasterCard SecureCode transactions to indicate whether MasterCard downgraded the SecureCode transaction and sent it to the Issuer. |
RetrieveToken | Sends a Token Only request. |
Retry | Set this to retry a failed transaction. |
SendCommCardInd | Indicates whether to send Commercial Card Request Indicator. |
SendExtendedAVS | Specifies whether to send extended AVS data. |
Server | The server to which transactions are posted. |
ServiceLocationCity | Name of the city where the cardholder received the services. |
ServiceLocationCountryCode | Country code where the cardholder received the services. |
ServiceLocationCountrySubdivision | Region code that corresponds to the state, province, or other country subdivision. |
ServiceLocationPostalCode | Postal code where the cardholder received the services. |
SpecialConditionIndicator | Describes selected special conditions at the POS. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
TLID | Transaction Link Identifier. |
Token | The token received from the TSYS host when a token request is sent. |
TokenRequestorID | Card brand Token Requestor ID assigned by the token service provider. |
TransactionStatus | A 1-character value used to indicate the purpose or status of the request. |
TsysETB | The Encryption Transmission Block TSYS uses to decrypt encrypted data. |
UCAFData | UCAF Authentication data from the MasterCard SecureCode authentication. |
UCAFIndicator | Indicates the merchant's support and usage of UCAF in MasterCard SecureCode transactions. |
UCAFSecurityIndicator | Indicates the security level and cardholder authentication in MasterCard SecureCode transactions. |
XID | TransactionId from a 3D Secure authentication. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
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.
ctUnknown (0) | Invalid or unknown prefix, card type not known. |
ctVisa (1) | Visa or Delta Card. |
ctMasterCard (2) | MasterCard. |
ctAMEX (3) | American Express Card. |
ctDiscover (4) | Discover Card. |
ctDiners (5) | Diners Club or Carte Blanche Card. |
ctJCB (6) | JCB Card. |
ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
ctMaestro (8) | Maestro Card |
ctLaser (10) | Laser Card (Ireland) |
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.
edsTrack1 (0) | Full Magnetic stripe read and transmit, Track 1. |
edsTrack2 (1) | Full magnetic stripe read and transmit, Track 2. |
edsManualEntryTrack1Capable (2) | Manually keyed, Track 1 capable. |
edsManualEntryTrack2Capable (3) | Manually keyed, Track 2 capable. |
edsManualEntryNoCardReader (4) | Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions). |
edsTrack1Contactless (5) | Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsTrack2Contactless (6) | Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsManualEntryContactlessCapable (7) | Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only). |
edsIVR (8) | Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (card_number, card_exp_month, and card_exp_year are sent). |
edsKiosk (9) | Automated kiosk transaction. Track1 or Track2 data must be sent in card_magnetic_stripe, the transaction cannot be manually entered. |
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.
TSYSHCBenefit | edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable |
TSYSHCECommerce | edsManualEntryNoCardReader |
TSYSHCRetail | edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable |
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.
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.
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.
goods_indicator Property
Used to identify the type of goods purchased over the Internet.
Syntax
def get_goods_indicator() -> int: ... def set_goods_indicator(value: int) -> None: ...
goods_indicator = property(get_goods_indicator, set_goods_indicator)
Default Value
0
Remarks
This property is used to identify the type of goods purchased over the Internet. Supported types are shown below.
tgiNotUsed (0) | GoodsIndicator is not used. |
tgiDigitalGoods (1) | Customer purchased digital goods (for instance, an application that was electronically delivered). |
tgiPhysicalGoods (2) | Customer purchased actual physical goods, which were then shipped to the customer. |
Note: This property is not actually used in the authorization, but will be contained in the aggregate returned from the get_detail_aggregate method. This property is only valid if the transaction_type is set to ttECommerce.
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.
Indicator | Language |
00 | English. |
01 | Spanish. |
02 | Portuguese. |
03 | Reserved for Irish. |
04 | Reserved for French. |
05 | Reserved for German. |
06 | Reserved for Italian. |
07 | Reserved for Dutch. |
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:
Value | Meaning |
0 | Positive offset, in hours, ahead of GMT. |
1 | Negative offset, in hours, behind GMT. |
2 | Positive offset, in 15 minute increments, ahead of GMT. |
3 | Negative offset, in 15 minute increments, behind GMT. |
4 | Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings. |
5 | Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings. |
6 | Positive offset, in hours, ahead of GMT, in cities participating in daylight savings. |
7 | Negative offset, in hours, behind GMT, in cities participating in daylight savings. |
8-9 | RESERVED. |
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.
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:
Code | Description |
6 | Off-line approval: POS device generated. |
7 | Acquirer approval. |
9 | Use for non-authorized transactions; such as credit card credits |
B | Response provided by Visa Transaction Advisor Service. |
E | Off-line approval: authorization code manually keyed. |
F | CAFIS-generated response: Post-Auth.* |
G | Issuer Approval: Post-Auth.* |
H | Exceeds acquirer settlement risk exposure cap. |
N | No authorization required: Below floor limit |
L | Late clearing - authorization previously obtained (clearing beyond 30 days) |
V | Authorization obtained via VisaNet (Issuer or STIP response) |
Space | Default value, if acquirer cannot define it (MC, D, AX) |
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:
Code | Description |
0 | Approved/Declined - Address verification was not requested or it was requested but the transaction was declined (Visa, MC, Amex, Discover). |
A | Address Match - customer_address matches, customer_zip does not, or the request does not include the customer_zip (Visa, Amex, Discover). |
I* | Ver Unavailable - Address information not verified (Discover). |
N | No match - Transaction contained postal/ZIP code only, or street address only, or postal code and street address. Also used when transaction requests AVS but sends no AVS data (Visa, MC, Amex, Discover). |
R | Retry - System unable to process (Visa, MC, Amex, Discover). |
S | Serv Unavailable - Service not supported (MC, Amex, Discover). |
U | Ver Unavailable - No data from Issuer/Authorization platform (Visa, MC, Amex, Discover). |
W | Zip Match - Nine character customer_zip matches, customer_address does not (MC, Discover). |
X | Exact Match - Nine character customer_zip and customer_address match (MC, Discover). |
Y | Exact Match - customer_zip and customer_address match (Visa, MC, Amex, Discover). |
Z | Zip Match - customer_zip matches; customer_address does not match or street address not included in the request (Visa, MC, Amex, Discover). |
1 | APPROVAL - Cardholder name and ZIP match (Amex only). |
2 | APPROVAL - Cardholder name, address, and ZIP match (Amex only). |
3 | APPROVAL - Cardholder name, address match (Amex only). |
4 | APPROVAL - Cardholder name matches (Amex only). |
5 | APPROVAL - Cardholder name incorrect, ZIP matches (Amex only). |
6 | APPROVAL - Cardholder name incorrect, address and ZIP match (Amex only). |
7 | APPROVAL - Cardholder name incorrect, address matches (Amex only). |
8 | NO MATCH - Cardholder name, address, and ZIP do not match (Amex only). |
*AVS Result Code for International addresses only
This property is read-only.
response_card_level Property
This property contains a two-character code created by Visa during the authorization process.
Syntax
def get_response_card_level() -> str: ...
response_card_level = property(get_response_card_level, None)
Default Value
""
Remarks
This property contains a two-character code created by Visa during the authorization process.
The current list of possible return values can be found in the table of contents.
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_commercial_card_type Property
Response property that indicates whether the card is a commercial card.
Syntax
def get_response_commercial_card_type() -> int: ...
response_commercial_card_type = property(get_response_commercial_card_type, None)
Default Value
0
Remarks
Response property that indicates whether the card is a commercial card.
If you wish to support Corporate Purchasing Cards with Level II or Level III data, you should inspect the value of this property after a successful authorization. If the Vital/TSYS host indicates that the authorized card is a commercial card, you may use the TSYSLevel2 or TSYSLevel3 classs to add the extra data required during settlement.
Possible values for this property include:
tccNotCommercial (0) | Not a commercial card. You must not send Level II or Level III data in the settlement. |
tccBusinessCard (1) | Business Card |
tccVisaCommerce (2) | Visa Commerce (Reserved for future use) |
tccCorporateCard (3) | Corporate Card |
tccPurchaseCard (4) | Purchasing Card |
This property is only valid after a successful authorization request and response.
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:
M | CVV2 match. |
N | CVV2 no match. |
P | Not processed. |
S | Merchant has indicated that CVV2 is not present on card. |
U | Issuer not certified and/or has not provided Visa encryption keys. |
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_text Property
Text information that describes each response code.
Syntax
def get_response_text() -> str: ...
response_text = property(get_response_text, None)
Default Value
""
Remarks
Text information that describes each response code.
This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.
The English-language response text messages are listed in the table of contents.
This property is read-only.
response_transaction_date Property
Local transaction date returned from the server in MMddyy format.
Syntax
def get_response_transaction_date() -> str: ...
response_transaction_date = property(get_response_transaction_date, None)
Default Value
""
Remarks
Local transaction date returned from the server in MMddyy format.
This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.
This property is read-only.
response_transaction_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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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 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
0
Remarks
The following types of transactions are supported by this class:
dmtECommerce (0) | This is an E-Commerce transaction, and consists of goods or services sold online over the Internet. |
dmtMOTO (1) | This is a Mail Order or Telephone Order transaction, and consists of goods sold through the mail or over the phone. |
dmtRecurring (2) | This is a recurring payment, such as a magazine subscription or health club membership. |
dmtInstallment (3) | This is an installment payment. For example, "Three easy payments of $19.95". |
All of these transactions are card-not-present transactions. If you wish to authorize card-present transactions, you must use the TSYSRetail class.
To settle a transaction authorized with the ttInstallment transaction_type, you must specify the number of this installment and the total count of all installments to be made using TSYSECommerce class. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:
TSYSECommerce.TransactionType = ttInstallment
TSYSECommerce.TransactionAmount = "1995"
TSYSECommerce.Config("InstallmentCount=3")
TSYSECommerce.Config("InstallmentNumber=1")
TSYSECommerce.Authorize()
TSYSSettle.DetailAggregate[5] = TSYSECommerce.GetDetailAggregate()
visa_mvv Property
The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program.
Syntax
def get_visa_mvv() -> str: ... def set_visa_mvv(value: str) -> None: ...
visa_mvv = property(get_visa_mvv, set_visa_mvv)
Default Value
""
Remarks
The maximum length of this property is 10 characters, and it may only contain 0-9 and A-F.
authenticate_card Method
Determines only if a card has been lost or stolen.
Syntax
def authenticate_card() -> None: ...
Remarks
This method does not send an authorization, but instead it sends an authentication request. If successful the response_code will be "85". If the card is stolen or otherwise not normal, the response_code and response_text will indicate such. You may send AVS (customer_address and customer_zip) as well as card_cvv_data, and the response_avs_result and response_cvv_result will be returned as normal.
authorize Method
Sends an authorization request.
Syntax
def authorize() -> None: ...
Remarks
This method sends an authorization request to the Vital/TSYS transaction server. If the authorization request was successful, the response_code property will contain "00" or "85".
An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement class. For example:
TSYSECommerce.Authorize()
TSYSSettle.DetailRecordCount = 1
TSYSSettle.DetailRecordAggregate(0) = TSYSECommerce.GetDetailAggregate()
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()
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 TSYSECommerceConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class TSYSECommerce: @property def on_connected() -> Callable[[TSYSECommerceConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[TSYSECommerceConnectedEventParams], 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 TSYSECommerceDataPacketInEventParams(object): @property def data_packet() -> bytes: ... # In class TSYSECommerce: @property def on_data_packet_in() -> Callable[[TSYSECommerceDataPacketInEventParams], None]: ... @on_data_packet_in.setter def on_data_packet_in(event_hook: Callable[[TSYSECommerceDataPacketInEventParams], 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 TSYSECommerceDataPacketOutEventParams(object): @property def data_packet() -> bytes: ... # In class TSYSECommerce: @property def on_data_packet_out() -> Callable[[TSYSECommerceDataPacketOutEventParams], None]: ... @on_data_packet_out.setter def on_data_packet_out(event_hook: Callable[[TSYSECommerceDataPacketOutEventParams], 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 TSYSECommerceDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class TSYSECommerce: @property def on_disconnected() -> Callable[[TSYSECommerceDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[TSYSECommerceDisconnectedEventParams], 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 TSYSECommerceErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class TSYSECommerce: @property def on_error() -> Callable[[TSYSECommerceErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[TSYSECommerceErrorEventParams], 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_response Event
Used with Interleaved Transaction Mode.
Syntax
class TSYSECommerceResponseEventParams(object): @property def transaction_id() -> str: ... @property def response_code() -> str: ... @property def response_text() -> str: ... @property def response_approval_code() -> str: ... # In class TSYSECommerce: @property def on_response() -> Callable[[TSYSECommerceResponseEventParams], None]: ... @on_response.setter def on_response(event_hook: Callable[[TSYSECommerceResponseEventParams], None]) -> None: ...
Remarks
When InterleavedMode configuration setting is set to True the component will send interleaved transactions without blocking and waiting for a response. For every response that the class receives from TSYS the Response event will fire. TransactionId parameter can be used to identify the transaction. ResponseCode and ResponseText can be used to determine if a transaction was approved or declined.
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class TSYSECommerceSSLServerAuthenticationEventParams(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 TSYSECommerce: @property def on_ssl_server_authentication() -> Callable[[TSYSECommerceSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[TSYSECommerceSSLServerAuthenticationEventParams], 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 TSYSECommerceSSLStatusEventParams(object): @property def message() -> str: ... # In class TSYSECommerce: @property def on_ssl_status() -> Callable[[TSYSECommerceSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[TSYSECommerceSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
TSYSECommerce 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.
TSYSECommerce Config Settings
Value | Description |
0 | Dedicated mPOS Terminal with PCI compliant dongle (with or without key pad) |
1 | Off the Shelf Mobile Device |
2 | Dongle with software-based application that supports PIN entry on glass |
3 | Off the Shelf Mobile Device with software-based application that supports PIN entry on glass |
M | Mobile POS Add-On Hardware |
T | Tap on Mobile No Add-On Hardware |
N | Device is not CPS capable / MasterCard TIPS (Travel Industries Premiere Service). |
Y | Device is CPS capable. |
P | CPS Capable - Manually keyed hotel/lodging transaction or preferred customer authorization request for hotel, auto rental, and passenger transport industries. |
I | CPS capable - Incremental Authorization Request. |
R | Recurring or Installment payments / MasterCard SIIP (Recurring payment). |
Code Example:
TSYSECommerce.Config("AmexAirlinePassengerData=DepartureDate=20170601|PassengerName=FROST~JANE~M~MRS|CardMemberName=FROST~CHARLES~F~MR|Origin=ABC|Destination=DEF|NumberOfCities=4|RoutingCities=ABC/DEF/GHI/JKL|NumberOfAirlineCarriers=3|AirlineCarriers=AB/XY/BC|FareBasis=ABC123DEF456GHI789JKL012|NumberOfPassengers=1|ETicket=True|ReservationCode=ABCDE1234567890");
NOTE: The tilde character "~" = character space.
DepartureDate | Passenger's departure date in format YYYYMMDD. Example: 20171220 | ||||
PassengerName | Passenger Name in format SURNAME~FIRSTNAME~MIDDLEINITIAL~TITLE. Use character space as sub-element separator. Example: FROST JANE M MRS | ||||
CardMemberName | Cardmember Name in format SURNAME~FIRSTNAME~MIDDLEINITIAL~TITLE. Use character space as sub-element separator. Example: FROST CHARLES F MR | ||||
Origin | First segment travel origination Airport. Example for Los Angeles (CA): LAX | ||||
Destination | Destination Airport for first travel segment of trip; not necessarily the final destination. For example, if passenger flies from STL to MIA with layover at JFK, Destination Airport for first segment is JFK. | ||||
NumberOfCities | Number of Airports or Cities on ticket. Maximum is 10. | ||||
RoutingCities | Routing Airport or City Codes for each leg on ticket (including Origin and Destination) in segments with virgule (/) separator. Example: ABC/DEF/GHI/JKL/MNO/PQR/STU/VWX/YZA/XYZ. Note that the minimum number of RoutingCitites is 2 (Origin and Destination). | ||||
NumberOfAirlineCarriers | Number of Airline Carriers entered in AirlineCarriers subfield. Maximum is 9. | ||||
AirlineCarriers | Airline Carrier Code for each leg on ticket (including Origin and Destination) in segments with virgule (/) separator. Example: AB/XY/BC/CD/DE/DE/CD/BC/AB. Note: Each leg must have Airline Carrier Code entry, even if multiple (or all) legs are on the same Airline. Note that the minimum number of AirlineCarriers is 1 (Airline Carrier Code from Origin to Destination). | ||||
FareBasis | Primary and secondary discount codes which indicate class of service and fare level associated with ticket. Example: ABC123DEF456GHI789JKL012 | ||||
NumberOfPassengers | Number of passengers in party. Default value is 1. | ||||
ETicket | Indicates if ticket is electronic. Default value is false. Possible values:
| ||||
ReservationCode | A precursor to a ticket number which corresponds to an airline ticket purchase reservation made by an airline or Global Distribution System (GDS). Example: ABCDE1234567890 |
Code Example:
TSYSECommerce.Config("AmexCNPInternetPhoneData=CustomerEmail=CFFROST@EMAILADDRESS.COM|CustomerHostName=PHX.QW.AOL.COM|BrowserType=MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WINDOWS~95)|ShipToCountry=840|ShippingMethod=02|ProductSKU=TKDC315U|CustomerIP=127.142.005.056|CustomerANI=6025551212|CustomerIIDigits=00");
CustomerEmail | Customer's e-mail address. | ||||||||||||
CustomerHostName | Name of the server that the customer is connected to. | ||||||||||||
BrowserType | Customer's HTTP browser type. | ||||||||||||
ShipToCountry | Three-byte, numeric country code. Example for USA: 840 | ||||||||||||
ShippingMethod | Two-byte, shipment-type code. Possible values:
| ||||||||||||
ProductSKU | Unique SKU (Stock Keeping Unit) inventory reference number of product associated with this authorization request. For multiple items, enter the SKU for the single, most expensive item. | ||||||||||||
CustomerIP | Customer's Internet IP address. | ||||||||||||
CustomerANI | ANI (Automatic Number Identification) specified phone number that customer used to place order with merchant. | ||||||||||||
CustomerIIDigits | Telephone company-provided ANI ii (Information Identifier) coding digits associated with CUSTOMER ANI phone number that correspond to calltype; e.g., cellular, government institution, etc. |
Code Example:
TSYSRetail.Config("AmexCPGoodsSoldData=ProductCode=1000");
ProductCode | Four-byte goods product indicator code. Possible values:
|
Valid values are:
Code | Description |
P | Pre Authorization |
F | Final Authorization |
U | Undefined Authorization |
Valid values are:
Value | Description |
CB | Consumer Bill Payment |
Note: When enrolled in the Visa Consumer BillPay program, the MerchantName field must be in the 'CBPS Name * Biller' format and must match what is registered with Visa.
If Canada Domestic Indicator was present in the original transaction it must be included in a reversal message.
Valid values are:
Customer Initiated Transaction (CIT)
Value | Description |
C101 | Credential on File |
C102 | Standing Order (variable amount, fixed frequency) |
C103 | Subscription (fixed amount and fixed frequency) |
C104 | Installment |
Merchant Initiated Transaction (MIT) - Recurring or Installment
Value | Description |
M101 | Unscheduled Credential on File |
M102 | Standing Order (variable amount, fixed frequency) |
M103 | Subscription (fixed amount and fixed frequency) |
M104 | Installment |
Merchant Initiated Transaction (MIT) - Industry Practice
Value | Description |
M205 | Partial Shipment |
M206 | Related/Delayed Charge |
M207 | No show Charge |
M208 | Resubmission |
Note: If CIT/MIT Indicator was present in the original transaction it must be included in a reversal message.
Indicator | Description |
EMPTY ("") | Do not send Electronic Commerce Indicator in authorization request (ie: for Retail transactions) |
SPACE (" ") | Not a Mail/Telephone Order Transaction (ie: for retail transactions). |
1 | One Time Occurrence of a Mail/Telephone Order Transaction (use for Direct Marketing). |
2 | Recurring Mail/Telephone Order Transaction. |
3 | Installment Payment of a Mail/Telephone Order Transaction. |
4 | Unknown Classification. |
5 | Secure Electronic Transaction (3-D Secure) and MasterCard SecureCode (UCAF) |
6 | Non-authenticated security transaction at a 3-D Secure capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure. |
7 | Non-authenticated Security Transaction, such as a Channel-Encrypted Transaction (default for CardNotPresent eCommerce transactions). |
8 | Non-secure Electronic Commerce Transaction |
A | In-App Authentication (Discover, Mastercard and Amex) |
R | First recurring SecureCode Phone Order transaction (Mastercard Only) |
T | Single nonrecurring SecureCode Phone Order transaction (Mastercard Only) |
Note: Other values necessary for passing 3D Secure data are CAVV and XID.
Note: Please make sure to send the SPACE (" ") value inside quotes. For Example:
TSYSRetail.Config("ECI=\" \"");
0 | No Encryption (default) |
1 | Merchant ID and Card Data (reserved for future use) |
2 | Merchant ID, Card Data, and Card Security Code (reserved for future use) |
3 | Card Data Only |
Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.
Value | Description |
02-99 | Installment Count |
ND | Not Defined |
UC | Until Canceled |
To settle a transaction authorized with the ttInstallment transaction_type, you must specify the number of this installment and the total count of all installments to be made using TSYSECommerce class. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:
TSYSECommerce.TransactionType = ttInstallment
TSYSECommerce.TransactionAmount = "1995"
TSYSECommerce.Config("InstallmentCount=3")
TSYSECommerce.Config("InstallmentNumber=1")
TSYSECommerce.Authorize()
TSYSSettle.DetailAggregate[5] = TSYSECommerce.GetDetailAggregate()
//Interleaved Transaction Mode
TSYSECommerce1.Config("InterleavedMode=True");
//Maximum number of pending response packets.
TSYSECommerce1.Config("MaxPendingResponseCount=10");
TSYSECommerce1.OnResponse += (sender, args) =>
{
Console.WriteLine("Response received for {0}, {1}, {2}, {3}", args.TransactionId, args.ResponseCode, args.ResponseText, args.ResponseApprovalCode);
};
TSYSECommerce1.Authorize();
//Explicitly Disconnect
TSYSECommerce1.Config("DisconnectInterleaved");
The default value is 60 (seconds).
Note: To Reverse a Purchase Return Authorization you should use the TSYSReversal class and set the reversal_type to rtCreditAuthorization (5) before calling the reverse method.
The following values apply to both Masterpass and MDES transactions:
Value | Description |
101 | Masterpass by Mastercard |
The following values only apply to MDES transactions:
Value | Description |
103 | Apple Pay |
216 | Google Pay |
217 | Samsung Pay |
327 | Merchant tokenization program |
The default value is 10.
Merchant Initiated Transactions A Merchant Initiated Transaction (MIT) is any transaction that relates to the previous consumer-initiated transaction but is conducted without the consumer being present and without any cardholder validation performed. Valid values are:
Code | Description |
3900 | Incremental Authorization (this is a continuation of the consumer purchase) |
3901 | Resubmission (valid when the original authorization was declined for insufficient funds) |
3902 | Delayed Charges (account charge associated with an agreement between a cardholder and a merchant for services rendered) |
3903 | Reauthorization (purchase made after the original purchase such as: split shipment, estimated amount etc.) |
3904 | No Show (when the customer did not meet the terms of the agreement and the merchant is able to charge for it) |
Deferred Authorizations If the merchant's Point-of-Interaction (POI) authorization system is offline and cannot process transactions, the merchant often completes the transaction with the cardholder and will then defer the authorization until their POI system is back online. Valid value is:
Code | Description |
5206 | Deferred Authorization |
Note: For Merchant Initiated Transactions you need to set the POSDataCode.CardInputMode to '7'.
Note: When supporting MIT transactions for Discover cards, you must keep track of the Original Amount from the initial CIT transaction.
Valid values are:
Code | Description |
(Space) (default) | Space indicates the retailer is not foreign. |
F | This value indicates the retailer is located in a different country than the marketplace. |
Note: For Visa Marketplaces, the Marketplace ID must be included in this field.
Usage 1 - Payment Facilitator Name*Sub-Merchant Name
This usage is valid for Visa, Mastercard, and Discover.
For Payment Facilitators, the field contains two parts in a concatenation of two fields separated by an asterisk (*). For Visa, Mastercard, and Discover the name submitted should match what the PayFac registered with each brand and should follow the requirements defined by each brand.
Usage 2 - Marketplace Name
For Visa Marketplaces, the field should contain the name of the Marketplace.
For Visa and Mastercard transactions, enter the city of the sub-merchant location (not the Payment Facilitator location).
For Discover transactions, enter the location where the transaction took place; this may or may not be the sub-merchant location.
For Direct Marketing merchants and preferred customer/passenger transport and card not present transactions, this field must contain a phone number for merchant customer service in format XXX-XXXXXXX. The dash is required. This field can also be used for e-mail or a URL.
Code Example:
TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");
CardInputCap (Terminal card data input capability)
0 (default) | Unspecified, data not available |
1 | Manual; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader capability |
3 | Bar code/ Payment code |
4 | Optical character reader (OCR) capability, [MC, AX] |
5 | Integrated circuit card (ICC) capability and magnetic stripe reader |
6 | Key entry only capability; Mastercard recurring and installment transactions |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader and key entry capability |
C | Magnetic stripe reader, ICC, and key entry capability |
D | Magnetic stripe reader and ICC capability |
E | ICC entry capability |
H | ICC Reader and Contactless Capability; Magnetic stripe & manual entry implied |
M | PAN auto-entry via contactless chip |
V | Other capability, [MC] |
X | Reserved for private use |
CardholderAuthCap (Terminal cardholder authentication capability)
0 | No electronic authentication capability |
1 | PIN entry capability |
2 | Electronic signature analysis capability |
3 | mPOS software-based PIN entry capability |
5 | Electronic authentication capability is inoperative |
6 | Other |
9 (default) | Unspecified, data not available |
CardCaptureCap (Terminal card-capture capability)
0 | No capture capability |
1 | Card capture capability |
9 (default) | Unspecified, data not available |
TerminalOpEnv (Terminal operating environment)
0 | No terminal used; Voice auth/ARU; Mastercard recurring/installment transactions |
1 | On card acceptor premises; attended terminal |
2 | On card acceptor premises; unattended terminal |
3 | Off card acceptor premises; attended |
4 | Off card acceptor premises; unattended |
5 | On cardholder premises; unattended |
6 | Off cardholder premises; unattended |
9 (default) | Unspecified, data not available |
M | Off card acceptor premises; merchant mobile POS environment, including mPOS |
P | On card acceptor premises; merchant mobile POS environment, including mPOS |
Q | Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
R | On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
S | Electronic delivery of product, [AX] |
T | Physical delivery of product, [AX] |
CardholderPresent (Cardholder present data)
0 | Cardholder present |
1 | Cardholder not present; unspecified reason |
2 | Cardholder not present; mail transaction |
3 | Cardholder not present; phone transaction |
4 | Cardholder not present; standing (recurring) transaction |
5 | Cardholder not present; electronic commerce |
8 | Cardholder not present; recurrent billing such as a loan or installment payment |
R | Recurring purchase transaction (original transaction was token-based with valid cryptogram) |
T | PayButton (Discover only) |
CardPresent (Card present data)
0 | Card not present |
1 | Card present |
W | Transponder, [AX] |
X | Contactless Chip Transactions, including AMEX Expresspay |
Z | Digital Wallet [AX] |
CardInputMode (Card data input mode)
0 (default) | Unspecified, data not available |
1 | Manual input; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader input |
3 | Bar code/Payment code |
6 | Key entered input |
7 | Payment Credential stored on file. NOTE: This value is required for all Mastercard recurring transactions. |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader input; track data captured and passed unaltered |
C | Online Chip |
F | Offline Chip |
M | PAN auto-entry via contactless Chip Card (EMV Mode) |
N | Track data read and sent unaltered, chip capable terminal, chip data could not be read |
P | Empty candidate list fallback |
R | PAN Entry via electronic commerce, including remote chip |
S | Electronic commerce, no security, channel encrypted, or SET without cardholder certificate |
V | Manually entered with keyed CID, [AX, JCB Canada] |
W | Swiped transaction with keyed CID, [AX, JCB Canada] |
X | Reserved for private use |
Y | Reserved for private use |
Z | Contactless Interface Change Identifies when a Chip Card Transaction with a dualinterface card switches from a contactless to a contact chip card transaction [Discover] |
NOTE: AMEX defines ApplePay with value C - Online Chip
CardholderAuthMethod (Cardholder authentication method)
0 | Not authenticated |
1 | PIN |
2 | Electronic signature analysis |
5 | Manual signature verification |
6 | Other manual verification (such as a driver's license number) |
9 (default) | Unspecified, data not available |
S | Other systematic verification |
T | Electronic ticket environment, [AX] |
CardholderAuthEntity (Cardholder authentication entity)
0 | Not authenticated |
1 | ICC - Offline PIN |
2 | Card acceptance device (CAD) |
3 | Authorizing agent - Online PIN |
4 | Merchant/card acceptor - signature |
5 | Other |
9 (default) | Unspecified, data not available |
CardOutputCap (Card data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Magnetic stripe write |
3 | ICC |
S | Other |
TerminalOutputCap (Terminal data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Printing capability only |
3 | Display capability only |
4 | Printing and display capability |
PINCaptureCap (PIN capture capability)
0 | No PIN capture capability |
1 (default) | Unspecified, data not available |
2 | Reserved |
3 | Reserved |
4 | PIN capture capability four characters maximum |
5 | PIN capture capability five characters maximum |
6 | PIN capture capability six characters maximum |
7 | PIN capture capability seven characters maximum |
8 | PIN capture capability eight characters maximum |
9 | PIN capture capability nine characters maximum |
A | PIN capture capability 10 characters maximum |
B | PIN capture capability 11 characters maximum |
C | PIN capture capability 12 characters maximum |
Note: Setting this configuration setting in TSYSDetailRecord class will not update the POSDataCode tag in the detail aggregate of the original transaction.
Value | Description |
C | Card On File |
I | Installment Payment |
R | Recurring Payment |
If the merchant initiates a transaction using a stored payment credential, the value in POSDataCode.CardInputMode should be '7' for Credential on File transactions.
0 | TSYS (default) |
1 | Heartland |
Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting card to ensure the card data is formatted correctly.
Value | Description |
1 | EMV 3-D Secure Version 2.1 |
2 | EMV 3-D Secure Version 2.2 |
3 | EMV 3-D Secure Version 2.3 |
4 | EMV 3-D Secure Version 2.4 |
5 | EMV 3-D Secure Version 2.5 |
6 | EMV 3-D Secure Version 2.6 |
7 | EMV 3-D Secure Version 2.7 |
8 | EMV 3-D Secure Version 2.8 |
9 | EMV 3-D Secure Version 2.9 |
For instance, instead of this:
TSYSECommerce.Authorize()
DetailRecord.ParseAggregate(TSYSECommerce.GetDetailAggregate())
DetailRecord.PurchaseIdentifier = "123456"
TSYSSettle.DetailAggreate[0] = DetailRecord.GetDetailAggregate()
You can do this:
TSYSECommerce.Config("PurchaseIdentifier=123456")
TSYSECommerce.Authorize()
TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate()
NOTE: When using this request, verification and authorization of the card will be performed.
Byte Number | Description |
Byte 1 | Billing ZIP Code |
Byte 2 | Billing Street Match Code |
Byte 3 | Billing Name Match Code |
Byte 4 | Telephone Number Match Code |
Byte 5 | E-mail Address Match Code |
The possible values for each byte are:
Value | Description |
Y | Data Matches |
U | Data Unchecked |
N | No Match |
S | Service not allowed |
R | Retry |
' ' (Space) | Data not sent |
For Discover transactions, byte 3 will be populated with the following values:
Value | Description |
B | No response due to blank input |
K | Unknown |
P | Not processed |
M | First Name and Last Name match |
F | First Name Matches, Last Name does not match |
L | First Name does not match, Last Name matches |
N | Nothing matches |
W | No data from Issuer/Authorization system |
U | Retry, system unable to process |
Blank or not present | CAVV not validated. |
0 | CAVV not validated because erroneous data was submitted. |
1 | CAVV failed validation. |
2 | CAVV passed validation. |
3 | CAVV validation could not be performed; Issuer attempt incomplete. |
4 | CAVV validation could not be performed; Issuer system error. |
5 | Reserved for future use. |
6 | Reserved for future use. |
7 | CAVV attempt - failed validation - issuer available (US issued card/non-US acquirer). |
8 | CAVV attempt - passed validation - issuer available (US issued card/non-US acquirer). |
9 | CAVV attempt - failed validation - issuer unavailable (US issued card/non-US acquirer). |
A | CAVV attempt - passed validation - issuer unavailable (US issued card/non-US acquirer). |
B | CAVV passed validation, information only, no liability shift. |
C | CAVV was not validated - attempted. |
D | CAVV was not validated - authentication. |
Value | Description |
01 | New account information |
02 | Try again later |
03 | Do not try again for recurring payment transaction |
04 | Token requirements not fulfilled for this token type |
21 | Recurring payment cancellation |
22 | Merchant does not qualify for product code |
Value | Description |
0 | Token retrieval was successful and is included. |
1 | Terminal not configured to receive a token. |
2 | Terminal was not authenticated. |
3 | System failure. |
The maximum length for this field is 13 characters.
The maximum length for this field is 3 characters.
The maximum length for this field is 3 characters.
The maximum length for this field is 10 characters.
Valid values are:
Value | Description |
7 | Purchase of Cryptocurrency. The transaction is related to purchase of cryptocurrency. |
8 | Quasi-Cash. The transaction is for a product or item that is representative of actual cash such as money orders, traveler's checks, foreign currency, lottery tickets, or casino gaming chips. |
9 | Existing Debt Indicator. The transaction includes payment on an existing debt. |
The format of this field is 'annnnnnnn' where 'a' is either 'D' for debit or 'C' for credit. 'nnnnnnnn' is the numeric fee amount with the decimal implied. For example: 'D00000150' is a $1.50 transaction fee amount debited to the cardholder's account.
Note: If an amount is only specified, the component will generate the format above by prepending a 'D' and the necessary number of 0's.
If Card Brand Token Requestor ID was present in the original transaction it must be included in a reversal message.
Note: The component will also send this value as part of DetailExtension Config of TSYSDetailRecord class (Group ODG41 - tag "TRI").
The tables below provide the valid values for each card brand.
Valid value for Visa is:
I | One or more incremental authorizations were performed. |
Valid values for Mastercard are:
Value | Description |
0 | Normal request (original presentment) |
1 | Deferred Authorizations |
2 | SecureCode Phone Order |
3 | ATM Installment Inquiry |
4 | Preauthorized request |
5 | Time Based Payment Authorization Request-Brazil domestic transactions |
6 | ATC Update |
8 | Account Status Inquiry Service (ASI) |
9 | Tokenization Request/Notification |
Valid values for Discover are:
Value | Description |
0 | Normal request (original presentment) |
4 | Preauthorized request |
A | Re-authorize for Full Amount |
D | Delayed Card Sale |
E | Resubmission of Card Sale |
G | Transit Aggregated Transaction |
I | Incremental Authorization |
N | No-Show Charge |
P | Partial Shipment |
R | Recurring Payment |
S | Merchant Installment Payment |
T | Third Party Installment Payment |
U | Unscheduled Payment |
V | Issuer Installment Payment |
Note: For Purchase Return Authorization Requests: Value must be 0 (Mastercard and Discover).
Indicator | Description |
0 | UCAF data is not supported by the merchant or the merchant has chosen not to send the indicator. |
1 | UCAF data collection is supported by the merchant and UCAF data was present and contained an attempted AAV for Mastercard SecureCode. |
2 | UCAF data collection is supported by the merchant and UCAF data was present and contained a fully authenticated AAV. |
5 | Issuer Risk-Based Decisioning. |
6 | Merchant Risk-Based Decisioning. |
7 | Partial Shipment, Incremental or Recurring Payment. |
Security Protocol/Cardholder Authentication | Description |
21 | Channel encryption; cardholder certificate not used(preferred value for Mastercard SecureCode). |
22 | Masterpass-generated transaction. |
24 | Digital Secure Remote Payment (DSRP) with UCAF Data. |
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This setting is only applicable when ssl_provider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when ssl_provider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
TSYSECommerce Errors
TSYSECommerce 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). |