PTechHostSettle Component
Properties Methods Events Config Settings Errors
The PTechHostSettle component is used to manually settle an open Batch with the Paymentech NetConnect system on the Tampa platform. This component supports Direct Marketing, e-Commerce, and Retail environments, and allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
Syntax
TibcPTechHostSettle
Remarks
Once an authorization request is approved with either the PTechCharge or PTechGiftCard component, one of two things happen. If your Paymentech account is setup with the Host Auto Close feature enabled, you need take no further action. The host will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. In order for the merchant's batch to be included in the Paymentech Host Auto Close process, the merchant parameter file on the host must indicate that the merchant is Auto Close. If this flag is set, the PTechHostSettle component is not necessary.
However, if your account is not setup with Host Auto Close, then after an authorization is approved the transaction is added to the current batch on the Paymentech Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through the Manual Batch Release Settlement process in order for the blocked money to be transferred to the merchant's account. To release a batch for settlement, first set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. Then get the Net Amount of the batch by calling the BatchInquiry method. Compare this amount to the amount in your transaction records. If they match, you may send a BatchRelease to settle the funds.
The status of a batch inquiry or release is returned in the Code. with a human-readable description contained in Text. Additional Response properties indicate the number of transactions in the batch, the date and time the batch was opened and closed, and Net amount of the batch.
Normally a BatchRelease is done at the end of each business day. Outstanding authorizations (even those in an open batch) will expire after 7 to 10 days depending on the cardholder's bank, so it is wise to release the batch often.
Note that this component only supports the Manual Batch Release (Host Capture) settlement method, and does not support Terminal Capture processing (this component is not required for Host Auto Close).
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
CardType | Indicates the card type for which the terminal is requesting totals or details on. |
ClientNumber | Merchant configuration property, assigned by Paymentech. |
InquiryType | The type of batch inquiry to be submitted. |
MerchantNumber | A unique number used to identify the merchant, assigned by Paymentech. |
MoreData | Indicates whether the Paymentech server has more data to return. |
Password | Password for authentication with the NetConnect Server . |
PaymentTypes | Collection of payment types in the current batch. |
Proxy | A set of properties related to proxy access. |
RequestStatus | Used with enhanced BatchInquiry s to retrieve the next set of transaction data. |
Response | Contains the response to the settlement. |
SequenceNumber | Sequence number of the transaction. |
Server | The URL for the PaymenTech NetConnect server. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
TerminalNumber | Terminal number assigned by Paymentech. |
Timeout | A timeout for the component. |
TransactionDetails | Details about each transaction in the current open batch. |
TransactionTotals | Totals of each card type that has been authorized in the current open batch. |
UserId | UserId for authentication with the NetConnect Server . |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
BatchInquiry | Retrieves the current state of the open batch. |
BatchRelease | Releases the current batch for settlement. |
Config | Sets or retrieves a configuration setting. |
Interrupt | Interrupt the current method. |
Reset | Clears all properties to their default values. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
ErrorCode | Batch Management Error Code. |
SystemInformation | System Information field for Batch Inquiry and Release transactions. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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 component 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. |
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. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
CardType Property (PTechHostSettle Component)
Indicates the card type for which the terminal is requesting totals or details on.
Syntax
property CardType: String read get_CardType write set_CardType;
Default Value
'99'
Remarks
This property is used when submitting a BatchInquiry transaction. When all card types are being requested, the value must be "99". This property is only valid for the iBatchTotalsByCardInquiry and iMerchantTotalsByCardInquiry InquiryType.
The following is a list of card mnemonics and their meanings.
VI | Visa |
MC | MasterCard |
AX | American Exp. |
DS | Discover |
JC | JCB |
DB | Debit |
EB | EBT |
SV | Stored Value |
CK | Check Authorization |
IG | In Good Taste |
PL | Retail PL |
CC | Club Card |
SC | Smarte Carte |
TH | TCH Light Fleet |
TS | TCRS Consumer Card |
IR | Irving Oil PL |
RA | RAI |
DY | Disney Rewards |
SR | Sears PL |
BE | Best |
EN | Enmark |
GC | FleetCor / GasCard |
VY | Voyager |
FO | Fleet One |
SH | Shell |
GT | Gate |
WX | WEX |
MM | MotoMart |
?? | Included in Batch Totals by Card Type responses when the host has summarized more than 14 card types within the batch (includes all other card types in the batch over 14). |
99 | Supported in Enhanced Batch Inquiry requests when "all" details or totals are being requested. |
ClientNumber Property (PTechHostSettle Component)
Merchant configuration property, assigned by Paymentech.
Syntax
property ClientNumber: String read get_ClientNumber write set_ClientNumber;
Default Value
''
Remarks
The ClientNumber will be supplied to you by Paymentech.
InquiryType Property (PTechHostSettle Component)
The type of batch inquiry to be submitted.
Syntax
property InquiryType: TibcInquiryTypes read get_InquiryType write set_InquiryType;
TibcInquiryTypes = ( iSimpleInquiry, iTransactionDetailInquiry, iBatchTotalsByCardInquiry, iMerchantTotalsByCardInquiry );
Default Value
iSimpleInquiry
Remarks
This property is used when submitting a BatchInquiry transaction. The following table explains the inquiry types:
iSimpleInquiry | No enhanced reporting is requested. The Paymentech server will return basic information for at most four PaymentTypes. |
iTransctionDetailInquiry | The Paymentech server will return each and every transaction currently contained in the open batch. This information will be contained in the TransactionDetails property. |
iBatchTotalsByCardInquiry | The Paymentech server will return the totals of all transactions for each card type in the current open batch. This information will be contained in the TransactionTotals property. |
iMerchantTotalsByCardInquiry | The Paymentech server will return the totals of all transactions for each card type in all of the currently open batches for the merchant indicated by the MerchantNumber. |
MerchantNumber Property (PTechHostSettle Component)
A unique number used to identify the merchant, assigned by Paymentech.
Syntax
property MerchantNumber: String read get_MerchantNumber write set_MerchantNumber;
Default Value
''
Remarks
This 12 digit field contains a unique number to identify the merchant to the host.
MoreData Property (PTechHostSettle Component)
Indicates whether the Paymentech server has more data to return.
Syntax
property MoreData: Boolean read get_MoreData;
Default Value
false
Remarks
This property is used when submitting a BatchInquiry transaction with enhanced reporting. Additional transaction data will be returned for any BatchInquiry submitted with an InquiryType other than iSimpleInquiry.
If the Paymentech server cannot return all of the data requested in a single response, the MoreData property will be true. You should then set the RequestStatus to rsSubsequentRequest and re-submit the BatchInquiry. Continue this until MoreData is False. If at any time you wish to start over at the beginning, set RequestStatus to rsInitialRequest and call BatchInquiry again.
This property is read-only.
Password Property (PTechHostSettle Component)
Password for authentication with the NetConnect Server .
Syntax
property Password: String read get_Password write set_Password;
Default Value
''
Remarks
The Password will be supplied to you by Paymentech.
PaymentTypes Property (PTechHostSettle Component)
Collection of payment types in the current batch.
Syntax
property PaymentTypes: TibcPTechPaymentTypeList read get_PaymentTypes;
Remarks
This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component. This property will contain the number of payment types in the current batch. Each payment type has a Name, TransCount, and NetAmount tied to it.
For instance, if the current batch contains only one American Express transaction for $10, after a Batch Inquiry: PaymentTypeCount = 1, Name(0) = "AE", TransCount(0) = "000001", and NetAmount(0) = "10.00".
This property is read-only.
Please refer to the PTechPaymentType type for a complete list of fields.Proxy Property (PTechHostSettle Component)
A set of properties related to proxy access.
Syntax
property Proxy: TibcProxy read get_Proxy write set_Proxy;
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.RequestStatus Property (PTechHostSettle Component)
Used with enhanced BatchInquiry s to retrieve the next set of transaction data.
Syntax
property RequestStatus: TibcRequestTypes read get_RequestStatus write set_RequestStatus;
TibcRequestTypes = ( rsInitialRequest, rsSubsequentRequest );
Default Value
rsInitialRequest
Remarks
This property is used when submitting a BatchInquiry transaction with enhanced reporting. Additional transaction data will be returned for any BatchInquiry submitted with an InquiryType other than iSimpleInquiry.
If the Paymentech server cannot return all of the data requested in a single response, the MoreData property will be true. You should then set the RequestStatus to rsSubsequentRequest and re-submit the BatchInquiry. Continue this until MoreData is False. If at any time you wish to start over at the beginning, set RequestStatus to rsInitialRequest and call BatchInquiry again.
Response Property (PTechHostSettle Component)
Contains the response to the settlement.
Syntax
property Response: TibcPTechSettleResponse read get_Response;
Remarks
This property will contain the response returned from the Paymentech server. It should be inspected (and logged) after a call to BatchInquiry or BatchRelease. The PTechSettleResponse type contains the following fields:
BatchOpen | Date and time the current batch was opened. |
BatchClose | Date and time this batch was closed. |
BatchNetAmount | Net amount of the current batch. |
BatchNumber | Number that identifies the batch that this transaction will be settled in. |
BatchTransCount | Total number of transactions in the batch. |
Code | Indicates the success or failure of the transaction. |
InquiryCount | Number of BatchInquirys performed on the current open batch. |
SequenceNumber | SequenceNumber echoed from the authorization. |
Text | Contains a human-readable message explaining the code. |
This property is read-only.
Please refer to the PTechSettleResponse type for a complete list of fields.SequenceNumber Property (PTechHostSettle Component)
Sequence number of the transaction.
Syntax
property SequenceNumber: Integer read get_SequenceNumber write set_SequenceNumber;
Default Value
0
Remarks
This field is user definable and can be used at the users discretion. When submitting any type of transaction for approval, this sequence number may be any numeric value 0 to 2400. This is a purely optional field for the Host Capture SettlementMode, and you may choose to send a unique number or simply send every transaction with zeros. The host will echo the sequence number submitted from the authorization request back in the SequenceNumber property.
However, if you are processing with the Terminal Capture SettlementMode, SequenceNumber CANNOT remain zero, and must contain a number that is incremented for each transaction you authorized. When it reaches 2400, the SequenceNumber should then start over at 1 again.
Server Property (PTechHostSettle Component)
The URL for the PaymenTech NetConnect server.
Syntax
property Server: String read get_Server write set_Server;
Default Value
'https://netconnect1.chasepaymentech.com/NetConnect/controller'
Remarks
This property contains the server to which all transactions are sent.
SSLAcceptServerCertEncoded Property (PTechHostSettle Component)
This is the certificate (PEM/Base64 encoded).
Syntax
property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded; property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
SSLCertEncoded Property (PTechHostSettle Component)
This is the certificate (PEM/Base64 encoded).
Syntax
property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded; property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
SSLCertStore Property (PTechHostSettle Component)
This is the name of the certificate store for the client certificate.
Syntax
property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore; property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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).
SSLCertStorePassword Property (PTechHostSettle Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;
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.
SSLCertStoreType Property (PTechHostSettle Component)
This is the type of certificate store for this certificate.
Syntax
property SSLCertStoreType: TibcCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;
TibcCertStoreTypes = ( cstUser, cstMachine, cstPFXFile, cstPFXBlob, cstJKSFile, cstJKSBlob, cstPEMKeyFile, cstPEMKeyBlob, cstPublicKeyFile, cstPublicKeyBlob, cstSSHPublicKeyBlob, cstP7BFile, cstP7BBlob, cstSSHPublicKeyFile, cstPPKFile, cstPPKBlob, cstXMLFile, cstXMLBlob, cstJWKFile, cstJWKBlob, cstSecurityKey, cstBCFKSFile, cstBCFKSBlob, cstPKCS11, cstAuto );
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component 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 component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword 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. |
SSLCertSubject Property (PTechHostSettle Component)
This is the subject of the certificate used for client authentication.
Syntax
property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;
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.
SSLProvider Property (PTechHostSettle Component)
This specifies the SSL/TLS implementation to use.
Syntax
property SSLProvider: TibcTSSLProviders read get_SSLProvider write set_SSLProvider;
TibcTSSLProviders = ( sslpAutomatic, sslpPlatform, sslpInternal );
Default Value
sslpAutomatic
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 component 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 component will select a provider depending on the current platform.
When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
SSLServerCertEncoded Property (PTechHostSettle Component)
This is the certificate (PEM/Base64 encoded).
Syntax
property SSLServerCertEncoded: String read get_SSLServerCertEncoded; property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is read-only and not available at design time.
TerminalNumber Property (PTechHostSettle Component)
Terminal number assigned by Paymentech.
Syntax
property TerminalNumber: String read get_TerminalNumber write set_TerminalNumber;
Default Value
''
Remarks
3-digit field assigned by Paymentech, which identifies the terminal to the host.
Timeout Property (PTechHostSettle Component)
A timeout for the component.
Syntax
property Timeout: Integer read get_Timeout write set_Timeout;
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.
The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the component raises an exception.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
TransactionDetails Property (PTechHostSettle Component)
Details about each transaction in the current open batch.
Syntax
property TransactionDetails: TibcPTechBatchDetailsList read get_TransactionDetails;
Remarks
When sending a BatchInquiry with the InquiryType set to iTransactionDetailInquiry, the Paymentech server will return each and every transaction currently contained in the open batch in a collection of PTechBatchDetails objects.
This property is read-only.
Please refer to the PTechBatchDetails type for a complete list of fields.TransactionTotals Property (PTechHostSettle Component)
Totals of each card type that has been authorized in the current open batch.
Syntax
property TransactionTotals: TibcPTechBatchTotalsList read get_TransactionTotals;
Remarks
When sending a BatchInquiry with the InquiryType set to iBatchTotalsByCardInquiry or iMerchantTotalsByCardInquiry, the Paymentech server will return the totals of all transactions for each card type in the current open batch in a collection of PTechBatchTotals objects.
This property is read-only.
Please refer to the PTechBatchTotals type for a complete list of fields.UserId Property (PTechHostSettle Component)
UserId for authentication with the NetConnect Server .
Syntax
property UserId: String read get_UserId write set_UserId;
Default Value
''
Remarks
The UserId will be supplied to you by PaymenTech.
BatchInquiry Method (PTechHostSettle Component)
Retrieves the current state of the open batch.
Syntax
procedure BatchInquiry();
Remarks
A batch inquiry will provide the host batch totals to the Point Of Sale (POS). If the POS and the Host are out of balance, discrepancies can be corrected prior to the batch being released. A batch inquiry will not release the batch for settlement. Use the BatchRelease method or Paymentech's online merchant interface to settle the batch.
Batch Inquiry and Release response data will be returned in the BatchNumber, BatchNetAmount, BatchTransCount, BatchOpen, and BatchClose properties. Additional information concerning the type of transactions in the settlement will be broken down into the Name, NetAmount and TransCount properties.
component.BatchInquiry()
component.BatchRelease(component.ResponseBatchNetAmount)
BatchRelease Method (PTechHostSettle Component)
Releases the current batch for settlement.
Syntax
procedure BatchRelease(NetDeposit: String);
Remarks
A batch release will provide the host batch totals to the POS and will release the batch for settlement. If there is a discrepancy between what the POS and the host have for totals, those discrepancies will need to be corrected by the merchant in a subsequent batch. To obtain the NetDeposit required for this method, first call BatchInquiry and compare the BatchNetAmount to your stored value to make sure there are no discrepancies before releasing the batch.
Batch Inquiry and Release response data will be returned in the BatchNumber, BatchNetAmount, BatchTransCount, BatchOpen, and BatchClose properties. Additional information concerning the type of transactions in the settlement will be broken down into the Name, NetAmount and TransCount properties.
component.BatchInquiry()
component.BatchRelease(component.ResponseBatchNetAmount)
Config Method (PTechHostSettle Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): String;
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Interrupt Method (PTechHostSettle Component)
Interrupt the current method.
Syntax
procedure Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (PTechHostSettle Component)
Clears all properties to their default values.
Syntax
procedure Reset();
Remarks
This method clears all properties to their default values.
DataPacketIn Event (PTechHostSettle Component)
Fired when receiving a data packet from the transaction server.
Syntax
type TDataPacketInEvent = procedure ( Sender: TObject; DataPacket: String; DataPacketB: TBytes ) of Object;
property OnDataPacketIn: TDataPacketInEvent read FOnDataPacketIn write FOnDataPacketIn;
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 component.
DataPacketOut Event (PTechHostSettle Component)
Fired when sending a data packet to the transaction server.
Syntax
type TDataPacketOutEvent = procedure ( Sender: TObject; DataPacket: String; DataPacketB: TBytes ) of Object;
property OnDataPacketOut: TDataPacketOutEvent read FOnDataPacketOut write FOnDataPacketOut;
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.
Error Event (PTechHostSettle Component)
Information about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The 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.
SSLServerAuthentication Event (PTechHostSettle Component)
Fired after the server presents its certificate to the client.
Syntax
type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; CertEncoded: String; CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object;
property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;
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.
SSLStatus Event (PTechHostSettle Component)
Fired when secure connection progress messages are available.
Syntax
type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object;
property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
TibcProxyAuthSchemes
Default Value: 0
This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password properties are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of User and Password.
AutoDetect
Boolean
Default Value: False
This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is False.
Password
String
Default Value: ""
This property contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Port
Integer
Default Value: 80
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server property for details.
Server
String
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server property is set to the corresponding address. If the search is not successful, an error is returned.
SSL
TibcProxySSLTypes
Default Value: 0
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
String
Default Value: ""
This property contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Constructors
constructor Create();
constructor Create(valServer: String; valPort: Integer);
constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);
PTechBatchDetails Type
Details of a transaction in the open batch.
Remarks
Each PTechBatchDetails in the collection will contain detailed information about a single transaction in the open batch. This includes the ApprovalCode returned in the authorization response, the CardType that was authorized, the SequenceNumber sent in the original authorization, the transaction amount (TransAmount) that was authorized, and the type of the transaction (TransType - Sale, Return, etc).
Fields
ApprovalCode
String (read-only)
Default Value: ""
Approval code of transaction pending settlement.
CardType
String (read-only)
Default Value: ""
Credit card used in transaction pending settlement.
SequenceNumber
Integer (read-only)
Default Value: 0
Sequence number of transaction pending settlement.
TransAmount
String (read-only)
Default Value: ""
Authorized amount of transaction pending settlement.
TransType
String (read-only)
Default Value: ""
Transaction type of transaction pending settlement.
One of the following 1-character transaction types may be returned:
S | Sale |
R | Return |
P | Prior Auth Sale |
C | Cash Advance Sale |
Constructors
constructor Create();
PTechBatchTotals Type
Transaction totals by card type.
Remarks
Each PTechBatchTotals in the collection will contain the number of transactions and the net dollar amount of all transactions in the open batch that match the indicated CardType.
Fields
CardType
String (read-only)
Default Value: ""
Credit card used in transaction pending settlement.
NetAmount
String (read-only)
Default Value: ""
Total dollar amount of all transactions in the open batch that match the indicated CardType.
TransCount
Integer (read-only)
Default Value: 0
Total number of transactions in the open batch that match the indicated CardType.
Constructors
constructor Create();
PTechPaymentType Type
Indicates the number of transactions and the total dollar amount for a specific payment type.
Remarks
For example, 12 American Express transactions totaling $536 is indicated like this: Name = "AE", TransCount = "000012", and NetAmount = "536.00".
Fields
Name
String (read-only)
Default Value: ""
Name of the payment type at the current index. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component. This property will contain the name for each payment type returned. Valid payment types include:
CR | Credit Card and Stored Value |
DB | Debit Card Only |
AE | American Express Only |
EB | Electronic Benefits Transfer Only |
NetAmount
String (read-only)
Default Value: ""
Net transaction amount for the payment type. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component. This property will contain the net transaction amount for the payment type indicated by Name. This property will be in the range of "-999999.99" to "9999999.99" for each payment type.
TransCount
String (read-only)
Default Value: ""
Total number of transactions for the payment type. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component. This property will contain the total number of transactions for the payment type indicated by Name.
Constructors
constructor Create();
PTechSettleResponse Type
Contains the response to the batch settlement..
Remarks
This type contains the results of a transaction made with the PTechHostSettle or PTechManualSettle component. The fields contained by this type are listed below.
Fields
BatchClose
String (read-only)
Default Value: ""
Date at which the current batch was closed. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component.
BatchNetAmount
String (read-only)
Default Value: ""
Net amount of the current batch. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component. This property will contain the net transaction totals of the currently open (or just released) batch. This value may be between the range "-9999999.99" to "9999999.99".
Note, when using the PTechManualSettle component to send manual batch settlements, this property will always be "00.00", because the Paymentech host is not maintaining the state of the batch.
BatchNumber
String (read-only)
Default Value: ""
Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component.
Note that when using the PTechManualSettle component to manually settle transactions via Paymentech's Terminal Capture System (TCS), this property will contain the original batch number incremented by one.
BatchOpen
String (read-only)
Default Value: ""
Date at which the current batch was opened. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component.
BatchTransCount
Integer (read-only)
Default Value: 0
Total number of transactions in the batch. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component.
Note, when using the PTechManualSettle component to send manual batch settlements, this property will always be "0", because the Paymentech host is not maintaining the state of the batch.
Code
String (read-only)
Default Value: ""
Indicates the status of the authorization request. This is the property used to determine whether a transaction has been approved or not. Valid values for this property are:
A | Transaction is Approved. |
E | Error condition or card declined (see the Error section of the help file for more information). |
See the list of errors for this component for more information.
InquiryCount
Integer (read-only)
Default Value: 0
Number of BatchInquirys performed on the current open batch. The number returned in this field indicates how many times a batch inquiry has been requested from the host.
SequenceNumber
String (read-only)
Default Value: ""
SequenceNumber echoed from the authorization. After any transaction this property will contain the same value sent in the SequenceNumber property.
Text
String (read-only)
Default Value: ""
Approval/Decline/Error text message information This property contains a response message returned from the Paymentech host, and is used by the terminal to display the Batch Inquiry or Release result. This property will contain human-readable text indicating whether the Inquiry or Release was successful, or it will contain a description of any error encountered.
See the list of errors for this component for more information.
Constructors
constructor Create();
Config Settings (PTechHostSettle Component)
The component 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 component, access to these internal properties is provided through the Config method.PTechHostSettle Config Settings
The component will construct the System Information data based on the following specifications:
- Application Name - 7 characters
- Release Date - 6 characters (MMDDYY)
- EPROM / Version Number - 10 characters
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form 'Basic [encoded-user-password]'.
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component raises an exception.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ('#13#10') .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the component beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components 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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components 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 component 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 component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost 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 LocalPort after the connection is established.
LocalPort 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 DataIn 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 DataIn 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 SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider 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 component 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 component is the same.
-----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 component. 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 component 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 SSLStatus 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 component 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 SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider 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 SSLProvider 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 component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider 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 component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the component 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 component will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider 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 component 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 component raises an exception.
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 SSLProvider 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 component 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 component 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 components: 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 component to use the internal implementation instead of using the system security libraries.
This setting is set to False by default on all platforms.
Trappable Errors (PTechHostSettle Component)
PTechHostSettle Errors
432 Invalid Index | |
501 Property length is invalid | |
502 Property is set with invalid data. | |
504 Luhn digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
517 Response length mismatch. | |
518 LRC check failed. | |
519 Corrupt response. | |
545 Error found in token data | |
546 Missing property for current method call. | |
593 Verification of post data failed: Invalid mix of properties for the current method call. |
The following is a list of error codes which may be returned by the Paymentech Server. In the case of a server-side error condition, the Code property will contain "E", the error code will be contained in the ApprovalCode property, and the description in Text
Paymentech Issuer Errors
ApprovalCode | Text | Description |
200 | Auth Declined | Cardholder's bank did not approve transaction. |
201 | Call Voice Oper | Authorizer needs more information for approval. |
202 | Hold - Call | Card issuer does not want that card used. Call for further instructions. |
203 | Call Voice Oper | Authorizer didn't respond within allotted time. |
204 | Invalid Card No | Account #/mag stripe is invalid. |
205 | Invalid Exp. Date | Expiration date is either incorrect format or prior to today. |
206 | Invalid ICA No | Invalid International Control Account number. |
207 | Invalid ABA No | Invalid American Banking Association number. |
208 | Invalid PIN No | The Personal ID Number for a debit transaction is incorrect. |
209 | Invalid Bank MID | The Bank Merchant ID is incorrect. |
210 | Invalid Term No | The merchant ID is not valid or active. |
211 | Invalid Amount | Amount is either: equal to 0, has no decimal, has decimal in wrong place, or has multiple decimals. |
213 | Invalid Tran Fmt | The transaction format isn't valid, typically invalid SIC code |
214 | Call Voice Oper | Authorization center cannot be reached. |
215 | Lost/Stolen Card | Card has been reported lost or stolen. |
216 | Invalid PIN | Personal ID code is incorrect. |
217 | Over Credit Flr | Amount requested exceeds credit limit. |
218 | Request Denied | Transaction is not valid for this authorizer. |
220 | Not Online to XX | Fatal communications error. |
221 | Auth Down-Retry | Debit authorizer temporarily unavailable. |
222 | Auth Declined | Vehicle not found in positive file. |
223 | Invalid Pin No | Driver # not found in positive file. |
224 | Auth Declined | Card is on private label negative file. |
225 | Card Not Allowed | Merchant does not accept this card. |
226 | PL Setup Reqd | Merchant not set up for Private Label. |
227 | BIN Not Allowed | Merchant cannot accept this Private Label BIN range. |
228 | Card Not Allowed | Merchant cannot accept this card. |
229 | Inv Merc Rstrct Code | Restriction code field contains invalid data. |
230 | Prod Restricted | Merchant attempted a product code not permitted by this merchant. |
231 | Prod Not On File | Merchant attempted a product code that does not exist on host. |
232 | Auth Declined | Invalid card type for Prior Auth sale. |
233 | Auth Declined | Terminal Type not supported. |
234 | Auth Declined | T&E card used for Sale when merchant only allows Auth Only. |
235 | *Request Denied* | Prior Auth selected with no Auth code provided. |
238 | Invalid Driver Number | The Driver Number entered is invalid. |
247 | PIN Not Selected | EBT recipient has not selected a PIN for this card. |
248 | Unmatch Vch Info | Voucher submitted does not match one previously issued. |
248 | CVC2/CID ERROR | CVC2 or CID entered was not valid for the card number. |
249 | Tran Not Defined | This type of transaction is not allowed for this type of card. |
257 | Block Act Not Alwd | The merchant.is not allowed to process Stored Value Block Activations |
258 | Incorrect Act Amt | The activation amount requested does not match the predenominated amount for the card. |
292 | Auth Down - Retry | Authorizer is not responding. |
293 | Auth Busy - Retry | Authorizer not available at this time. |
294 | Auth Busy - Retry | Authorizer not available at this time. |
297 | Auth Error - Retry | Authorizer not available at this time. |
298 | Err - Pls Retry | Debit authorizer experienced an error. |
299 | Err - Pls Retry | Debit authorizer experienced an error. |
Paymentech Format Errors
ApprovalCode | Text | Description |
300 | Invalid Term ID | The length of the merchant ID is incorrect or contains invalid data. |
301 | Invalid Function | Tran code is incorrect or wrong length. |
302 | Invalid Card | Mag stripe contains invalid data or account # is greater than 19 digits |
303 | Invalid Exp. Date | Card has expired, month was not 01-12 or year was not 00-99. |
304 | Invalid Action Code | Action code is longer than 1 digit. |
305 | Amt Entry Error | Amount less than .01 or greater than 99999.99 or contained non- numeric data. |
306 | Invalid PIN | Incorrect PIN block length. |
307 | Invalid Card | Invalid card type or account number. |
308 | Auth # Not Entered | Auth code was not entered on a Prior Auth, Incremental or Rev. |
309 | Invalid Down Pay Ind | Insurance down payment indicator is invalid. |
310 | Policy # Wrong Len | Insurance policy number is incorrect length. |
311 | Invalid Ind Code | Industry type must be RE or DM. |
312 | Invalid Function | Tran code is invalid or contains alpha data. |
313 | Entry Mode Invalid | POS Entry mode is less than 01 or greater than 04. |
314 | Invalid Industry Data | The Industry Specific field contains invalid data. |
315 | Inv Fleet Data | The Fleet Card field contains invalid data. |
316 | Invalid Sys Info | The System Information field contains invalid data. |
317 | Invalid Format | Payment Service indicator or Transaction ID is invalid. |
318 | Inv Transaction Class | Transaction class not "F" for financial transaction. |
319 | Inv PIN Capability | Pin capability code field contains invalid data. |
320 | Inv/Missing Retr Ref | Retrieval Reference # is missing or contains alpha data. |
321 | Inv MSDI | Market Specific Data field contains invalid data. |
322 | Invalid Duration | Market specific data field Duration is 00, blank or missing. |
323 | Inv Pref Cust Ind | Preferred Customer indicator contains invalid data. |
324 | Inv MO/TO Number | Mail/Telephone Order number is invalid (InvoiceNumber must have a value). |
325 | Inv Sale/Chg Des/Folio | Hotel Sale Code, Charge Descriptor or Folio contains invalid data. |
326 | Inv Mult Clr Seq No | Multiple Clearing sequence number is invalid. |
327 | Inv Purch Card Data | Purchasing card field contains invalid data. |
328 | Inv Input/Use VRU | Insurance transaction not from VRU. |
329 | Invalid EC Data 329 | Invalid Electronic Commerce Data. |
330 | INV Function or Multiple FS or Unknown TKN | Indicates system problem, notify Paymentech Network Services or Multiple field separators received without required data or A token of unknown definition was received |
331 | INV TKN Value | Invalid token value was received. |
332 | CVD Data Error | Error with the cardholder verification data received; invalid value or not allowable for this card for this transaction. |
333 | TKN Data Error | Indicates system problem, notify Paymentech Network Services. |
359 | Invalid Sequence Number | The SequenceNumber must be a number between 0 and 2400. |
Paymentech Host / Setup Errors
ApprovalCode | Text | Description |
400 | Invalid Term ID | Merchant ID not found in merchant file. |
401 | Invalid Term ID | Merchant ID not found in terminal file. |
402 | Term Not Active | Active flag for merchant set to "N". |
403 | Invalid Act Code | Merchant not set up for cash advance function. |
404 | Void Not Allowed | The transaction requested for voiding is not an EFT transaction. |
405 | Ref Num Not Found | Transaction requested for reversal not found. |
406 | Proc Error 7 | The host can't clear all transaction records for the requested Batch Release. |
407 | Too Many Batches | There are 999 open batches for this merchant. |
408 | Release Batch | Current batch has 999 records. Release batch before continuing. |
409 | Invalid Function | Debit transaction requested but debit flag is set to "N". |
410 | Invalid Term ID | The Terminal ID portion of the merchant ID is incorrect. |
411 | Invalid Term ID | The maximum retries for this merchant have been exceeded. |
412 | Proc Error 13 | Unable to read reference number file. |
413 | Proc Error 14 | 413 |
414 | Proc Error 15 | 414 |
415 | Invalid Function | 415 |
416 | Invalid Function | Merchant is Authorization Only and a debit record was sent. |
417 | Invalid Function | Private label flag is "N" but a private label account number was sent. |
418 | Please Try Again | Incorrect debit working key. |
419 | Invalid Function | Manually entered transactions are not allowed for this terminal ID. |
420 | Amount Too Large | Maximum sale amount exceeded. |
421 | Amount Too Large | Maximum return amount exceeded. |
422 | Invalid Term ID | Host couldn't read terminal file within specified time. |
423 | Proc Error 24 | Host couldn't read reference number file within specified time. |
424 | Invalid Term ID | Transaction open flag has been set to "Y" within prior 3 minutes. |
425 | Invalid Function | Cash management not allowed for this merchant ID. |
426 | Rev Not Allowed | Host found no batch number matching the one sent. |
427 | Rev Not Allowed | Host found no transactions meeting the specifications sent. |
428 | Dscv Not Allowed | Merchant not set up for Discover transactions. |
429 | Rev Not Allowed | The batch containing the transaction to void has been released. |
430 | Dscv Not Allowed | Merchant not set up for Discover. |
431 | DC Not Allowed | Merchant not set up for Diners Club. |
432 | CB Not Allowed | Merchant not set up for Carte Blanche. |
433 | Invalid Key | No AMEX subscriber number, process control ID or product code set up |
434 | Invalid Key | Future use. |
435 | Failed-Plz Call | Debit transaction being sent to an authorizer not set up on host file. |
436 | Failed-Plz Call | Debit security key does not exist on the security management file. |
437 | Failed-Plz Call | Failure occurred during encryption/decryption of PIN. |
438 | Failed-Plz Call | Error occurred while generating a debit working key. |
439 | Failed-Plz Call | The DB (debit) sponsor institution on the merchant file is not set up on sponsor file. |
440 | Failed-Plz Call | The network set up on the sponsoring bank file for this institution is not set up on the host's network file. |
441 | Failed-Plz Call | The host is unable to communicate with decryption device. |
442 | JCB Not Allowed | JCB CD flag on merchant record not set up for JCB transactions. |
443 | JCB Not Allowed | JCB subscriber number not set up for JCB transactions. |
444 | Bank Not On File | Debit BIN not set up for this merchant in routing table. |
445 | No Sponsor Inst | No valid sponsorship was found on Merchant record. |
446 | Failed Plz Call | Future use. |
447 | WX Not Allowed | Merchant not set up to accept WEX. |
448 | Amount Too Large | Amount exceeds maximum limit. |
449 | Reenter Odometer | Odometer was 000000 or contained non-numeric data. |
450 | Duplicate Tran | No ACK reversal was followed by a duplicate request |
451 | Tran Not Allowed | Requested transaction type is not allowed for this card/merchant. |
452 | Bat Already Rels | Batch has already been released. |
453 | Invalid Rtng Ind | Invalid Routing Indicator field. |
454 | AX Not Allowed | AMEX not allowed. |
999 | Invalid Merchant | Merchant number not on file. |
Paymentech Debit / EBT Specific Errors
ApprovalCode | Text | Description |
602 | Call Voice Op | Auth center cannot be reached. |
692 | Auth Down-Retry | Debit authorizer temporarily unavailable. |
693 | Auth Busy-Retry | Queue for debit authorizer too long. |
694 | Auth Busy-Retry | Debit authorizer not responding in time. |
Paymentech Batch Management Errors (use the ErrorCode configuration setting to retrieve this information from the PTechHostSettle component.
ErrorCode | Text | Description |
105 | Invalid Term ID | Merchant ID on a Batch Inquiry or Release is incorrect. |
106 | Term Not Active | Active flag for the merchant ID is set to N. |
107 | No Transactions | A Batch Inquiry or Release was requested but no open batch exists. |
108 | Bat Already Rels | A second batch release was attempted. |
109 | Batch Not Found | Requested batch does not exist. |
The component may also return one of the following error codes, which are inherited from other components.
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost 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 LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the component 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). |