PTechGiftCard Class

Properties   Methods   Events   Config Settings   Errors  

The PTechGiftCard class is used to manipulate funds on Stored Value (Gift) Cards with the Paymentech NetConnect system on the Tampa platform. This class supports card-present gift card transactions, and allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand- alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

dpaymentssdk.Ptechgiftcard

Remarks

A Stored Value Card (or Gift Card as they are commonly called) is a not actually a type of credit or debit card. Simply put, a Stored Value Card is a card with a magnetic strip on the back that holds information about monies that have been "pre-paid" into an account for the purpose of making financial transactions. Examples include a retailer's gift card, a prepaid telephone card, a college campus meal plan card, a reloadable subway pass, etcetera. Not included are government income-support cards, otherwise known as EBT cards or electronic food stamps.

There just a few steps to setting up the class and sending transactions. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your PINCapability and CashRegisterId at this time.

After the merchant information is setup, you may enter transaction data. When the EntryDataSource is Manually Entered, the merchant should fill the Number, ExpMonth, and ExpYear fields. Otherwise, you should fill the MagneticStripe field with the Track 2 data read from the back of the card, and set EntryDataSource to Track2. These are the only two Entry Data Sources supported for Stored Value (Gift) Cards.

Now you must choose what transaction you wish to make. Adding Value to a card, Redeeming a card, voiding a previous transaction, or retrieving the card's current balance.

To add funds to an existing Gift Card, simply set the TransactionAmount with the amount to add to the card, and then call AddValue. Activating a new gift card is handled the same way. If the card indicated by MagneticStripe (or Number) has not yet been activated, calling AddValue will automatically activate it with the amount indicated by TransactionAmount.

To redeem funds from a Gift Card due to a customer purchase, set TransactionAmount to the total for the purchase and call RedeemCard. If the Gift Card account contains enough funds, Code will indicate the card was approved. If there are not enough funds available on the card to cover the TransactionAmount, normally the transaction will be declined. However, the merchant may set PartialRedemption to True. This allows the customer to split the cost of the purchase between the Gift Card and another form of payment. Instead of declining the Gift Card, AuthorizedAmount will contain the amount deducted from the Gift Card. The merchant may subtract that from TransactionAmount to determine the difference to charge the customer.

Finally, you may inquire as to the total funds contained on the card by calling BalanceInquiry. This will not effect the amount of funds contained on the card in any way.

The status of any of the above transactions will be stored in the Code field, with human-readable text appearing in Text. Like the PTechCharge class, there are several other Response fields which will contain data that should be logged. However, there are a few new fields specific to the PTechGiftCard class: Balance will be returned after all transactions except VoidTransaction, and will contain the current balance of the Gift Card. PreviousBalance will indicate the balance BEFORE the last transaction went through. The Trace field is used for tracking after the sale, and must be printed on every customer receipt.

Gift Card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, only the Host Capture settlement mode is supported. At the end of the day you should release the current batch using the PTechHostSettle class (the batch may contain other authorizations that were made using different classs from this product. See the documentation for the other classs you are using for more information).

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

CardContains the customer's credit card information.
CashOutIndicatorIndicates to the host that the customer wants the remainder of the card's value returned as cash.
CashRegisterIdCash Register transaction identifier.
ClientNumberMerchant configuration property, assigned by Paymentech.
DuplicateCheckingIndicates whether duplicate checking is enabled.
EmployeeNumberIdentifies the employee making this transaction.
IndustryTypeDetermines the merchant's industry type.
InvoiceNumberMerchant-generated invoice number.
MerchantNumberA unique number used to identify the merchant, assigned by Paymentech.
PartialRedemptionPartial Redemption indicator.
PasswordPassword for authentication with the NetConnect Server .
PINCapabilityIndicates if the terminal device supports a PIN pad.
ProxyA set of properties related to proxy access.
ResponseContains the response to the authorization.
SequenceNumberSequence number of the transaction.
ServerThe URL for the PaymenTech NetConnect server.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertThe server certificate for the last established connection.
TerminalNumberTerminal number assigned by Paymentech.
TimeoutA timeout for the class.
TransactionAmountPurchase amount for an authorization.
UserIdUserId for authentication with the NetConnect Server .

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ActivateCardActivates a Gift Card.
AddValueActivates and/or adds funds to a Gift Card.
BalanceInquiryRetrieves the balance remaining on a gift card.
ConfigSets or retrieves a configuration setting.
DeactivateCardDeactivates a gift card.
InterruptInterrupt the current method.
ReactivateCardRe-activates Gift Card that has been previously deactivated.
RedeemCardDeducts funds from a gift card for the purchase of goods or services.
ResetClears all properties to their default values.
VoidTransactionVoids a transaction in the current batch.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.

Config Settings


The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AllowPartialAuthsIndicates whether partial authorizations are to be supported.
CustomerDefinedDataAdditional transaction identification data.
DiscoverAuthAmountReturns the amount authorized for the transaction.
DiscoverPINCapababilityIndicates if the POS is capable of supporting a PIN.
DiscoverPOSEntryModeReturns the method by which the primary account number was entered at the POS.
DiscoverProcessingCodeReturns the type of Authorization request that was submitted to Discover.
DiscoverSystemTraceAuditNumberReturns the value assigned by the host/merhant to assist in identifying a specific transaction.
DiscoverTrackDataConditionReturns condition of the track data.
HardwareSerialNumHardware Serial Number.
HostProcessingTypesHost Processing Platform.
RequestBalanceInfoSpecifies whether to request balance information.
ResponsePOSRetrievalNumberPOS Retrieval Number sent in the request, echoed back in the response.
SettlementModeIndicates whether the class uses Paymentech's Host Capture or Terminal Capture system.
SoftwareIDSoftware Identifier.
SystemInformationSystem Information field for Batch Inquiry and Release transactions.
VendorIDHardware/Vendor Identifier.
VoiceAuthCodeWhen VoiceAuthCode contains a value, the class will send a Force transaction to the Paymentech system.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the class will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the class binds to a SOCKS firewall as a server (TCPClient only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLContextProtocolThe protocol used when getting an SSLContext instance.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithmThe algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Card Property (PTechGiftCard Class)

Contains the customer's credit card information.

Syntax


public CCCard getCard();


public void setCard(CCCard card);

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

Note: This class only supports Manual or Track 2 for Entry Data Sources.

This property is not available at design time.

Please refer to the CCCard type for a complete list of fields.

CashOutIndicator Property (PTechGiftCard Class)

Indicates to the host that the customer wants the remainder of the card's value returned as cash.

Syntax


public boolean isCashOutIndicator();


public void setCashOutIndicator(boolean cashOutIndicator);

Default Value

False

Remarks

When the CashOutIndicator is set to True, the stored value card will be "cashed out". This means that all funds stored on the card is cleared, and the merchant is to return those funds to the customer as cash. Thus, when CashOutIndicator is True the CashOut field will contain the amount of money the merchant is to return to the customer in cash. The AuthorizedAmount field will contain the total amount removed from the gift card (The sum of the TransactionAmount plus the CashOut amount).

CashRegisterId Property (PTechGiftCard Class)

Cash Register transaction identifier.

Syntax


public String getCashRegisterId();


public void setCashRegisterId(String cashRegisterId);

Default Value

""

Remarks

The CashRegisterId identifies the cash register initiating this transaction and should be a unique value defined for each of the merchant's registers. The maximum length of this property is 15 characters.

ClientNumber Property (PTechGiftCard Class)

Merchant configuration property, assigned by Paymentech.

Syntax


public String getClientNumber();


public void setClientNumber(String clientNumber);

Default Value

""

Remarks

The ClientNumber will be supplied to you by Paymentech.

DuplicateChecking Property (PTechGiftCard Class)

Indicates whether duplicate checking is enabled.

Syntax


public int getDuplicateChecking();


public void setDuplicateChecking(int duplicateChecking);


Enumerated values:
  public final static int duDoNotSendIndicator = 0;
  public final static int duNoDuplicateChecking = 1;
  public final static int duErrorOnDuplicate = 2;
  public final static int duReturnOriginalResponse = 3;

Default Value

0

Remarks

This Duplicate Checking Indicator is used to tell the Host whether or not to check for duplicate transactions. This property is not valid for BatchInquiry and BatchRelease transactions.

In order to be viewed as a duplicate, the transaction must be exactly the same as the original. This includes SequenceNumber and TransactionAmount.

duDoNotSendIndicator (0)Duplicate Checking Indicator is not sent in the authorization request.
duNoDuplicateChecking (1)No duplicate checking is performed.
duErrorOnDuplicate (2)Duplicate SequenceNumbers are not allowed within the current open batch. Transaction requests containing duplicate SequenceNumbers will receive an error response.
duReturnOriginalResponse (3)Treats authorization requests (within the current batch) containing the same SequenceNumber, Number, TransactionAmount, and the current Transaction Type as duplicate transactions. If a duplicate is found and it was approved, the host will respond with the original response data. If no duplicate is found, or the duplicate was an error, normal authorization processes will be followed.

EmployeeNumber Property (PTechGiftCard Class)

Identifies the employee making this transaction.

Syntax


public String getEmployeeNumber();


public void setEmployeeNumber(String employeeNumber);

Default Value

""

Remarks

The EmployeeNumber identifies the operator initiating this transaction and should be a unique value defined for each employee within the client. This field is only required if the merchant participates in a program where operator level reporting is performed. The maximum length of this property is 10 characters.

IndustryType Property (PTechGiftCard Class)

Determines the merchant's industry type.

Syntax


public int getIndustryType();


public void setIndustryType(int industryType);


Enumerated values:
  public final static int pitRetail = 0;
  public final static int pitDirectMarketing = 1;
  public final static int pitECommerce = 2;
  public final static int pitRestaurant = 3;
  public final static int pitHotel = 4;

Default Value

0

Remarks

This property sets the merchant's industry type. Valid values are shown in the table below:

Industry TypeDescription
pitRetail (0)Retail environments are classified as those environments where the card and cardholder are physically present at the time of purchase.
pitDirectMarketing (1)Mail Order or Phone Order (MOPO) environments are classified as those environments where the card and/or cardholder are not physically present at the time of purchase and the transaction is performed through the mail or over the telephone.
pitECommerce (2)Electronic Commerce environments are classified as those environments where the card and/or cardholder are not physically present at the time of purchase and the transaction is performed over the Internet.
pitRestaurant (3)Restaurant environments are similar to retail environments, where the card and cardholder are physically present at the time of purchase.* A gratuity may be added at the time of authorization, or before settlement. Note that the itRestaurant industry type requires merchants to use Paymentech's Terminal Capture System (TCS) to process transactions, and batches must be manually settled using the PTechManualSettle class.
pitHotel (4)Hotel/Lodging environments allow for both card-present and card-not-present transactions* (for instance, a phoned-in reservation or a charge for a no-show). Additional hotel (PTechHotelInfo) information must be submitted in the authorization and capture. Additional charges may be added on to the initial authorization using the PTechDetailRecord class before the transaction is settled with the PTechManualSettle class. Note that the itHotel industry type requires merchants to use Paymentech's Terminal Capture System (TCS) to process transactions, and batches must be manually settled using the PTechManualSettle class.
Note: setting the IndustryType to itDirectMarketing or itECommerce will also reset the PINCapability to ppNoPIN.

* Restaurant orders taken over the phone should be processed as itDirectMarketing transactions. Hotel transactions should always be processed in the itHotel IndustryType. Setting the PTechHotelInfo.PreferredCustomer field to True.

Note: Only the itRetail and itRestaurant industry types are supported for Stored Value transactions.

InvoiceNumber Property (PTechGiftCard Class)

Merchant-generated invoice number.

Syntax


public String getInvoiceNumber();


public void setInvoiceNumber(String invoiceNumber);

Default Value

""

Remarks

This property contains a merchant-generated invoice number. This number should be unique for each transaction. The maximum length for this properties varies depending on the IndustryType. For Retail transactions the max length is 6 characters. For Direct Marketing transactions it is 9 characters, and for Electronic Commerce transactions the maximum length is 16 characters. Any text beyond these limits will be truncated by the class.

MerchantNumber Property (PTechGiftCard Class)

A unique number used to identify the merchant, assigned by Paymentech.

Syntax


public String getMerchantNumber();


public void setMerchantNumber(String merchantNumber);

Default Value

""

Remarks

This 12 digit field contains a unique number to identify the merchant to the host.

PartialRedemption Property (PTechGiftCard Class)

Partial Redemption indicator.

Syntax


public boolean isPartialRedemption();


public void setPartialRedemption(boolean partialRedemption);

Default Value

False

Remarks

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

Note that the AuthorizedAmount will only contain a value if PartialRedemption is set to True, and will remain blank otherwise. If the Stored Value card has a zero Balance, RedeemCard will fail with a declined message regardless of the value of PartialRedemption.

Password Property (PTechGiftCard Class)

Password for authentication with the NetConnect Server .

Syntax


public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

The Password will be supplied to you by Paymentech.

PINCapability Property (PTechGiftCard Class)

Indicates if the terminal device supports a PIN pad.

Syntax


public int getPINCapability();


public void setPINCapability(int PINCapability);


Enumerated values:
  public final static int ppUnknown = 0;
  public final static int ppAcceptsPIN = 1;
  public final static int ppNoPIN = 2;
  public final static int ppPadInoperative = 8;
  public final static int ppVerifiedPIN = 9;

Default Value

0

Remarks

This property indicates to the host whether the merchant's terminal has a PIN entry pad. Valid values for this property are:

Unknown (0) Unknown.
ppAcceptsPIN (1) Terminal device accepts PIN entry.
ppNoPIN (2) Terminal device does not accept PIN entry.
ppPadInoperative (8) PIN pad inoperative.
ppVerifiedPIN (9) PIN Verified by terminal device.
NOTE: Code 8 is not used at this time. This is for future use by Visa

Proxy Property (PTechGiftCard Class)

A set of properties related to proxy access.

Syntax


public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

Response Property (PTechGiftCard Class)

Contains the response to the authorization.

Syntax


public PTechGiftCardResponse getResponse();


Remarks

This property will contain the response returned from the Paymentech server. It should be inspected (and logged) after a call to ActivateCard, AddValue, BalanceInquiry, DeactivateCard, ReactivateCard, RedeemCard or VoidTransaction. The PTechGiftCardResponse type contains the following fields:

ApprovalCode Contains an authorization code for an approved transaction.
AuthorizedAmountUsed for partial authorizations. Indicates the actual amount authorized from the stored value card.
Balance Balance after this transaction was completed.
BatchNumber Number that identifies the batch that this transaction will be settled in.
CashOut Returned only when CashOutIndicator is True, and will contain the total value removed from the card.
Code Indicates the success or failure of the transaction.
CVVResult Contains the returned CVV result code if it was requested. Used for fraud detection.
PreviousBalance Balance before this transaction started.
RetrievalNumber Reference number returned from the Paymentech host.
SequenceNumber SequenceNumber echoed from the authorization.
Text Contains a human-readable message explaining the code.
Trace Gift Card-specific host tracking number for this transaction.

This property is read-only.

Please refer to the PTechGiftCardResponse type for a complete list of fields.

SequenceNumber Property (PTechGiftCard Class)

Sequence number of the transaction.

Syntax


public int getSequenceNumber();


public void setSequenceNumber(int 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 field.

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 (PTechGiftCard Class)

The URL for the PaymenTech NetConnect server.

Syntax


public String getServer();


public void setServer(String server);

Default Value

"https://netconnect1.chasepaymentech.com/NetConnect/controller"

Remarks

This property contains the server to which all transactions are sent.

SSLAcceptServerCert Property (PTechGiftCard Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax


public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (PTechGiftCard Class)

The certificate to be used during SSL negotiation.

Syntax


public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (PTechGiftCard Class)

This specifies the SSL/TLS implementation to use.

Syntax


public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

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

Possible values are:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (PTechGiftCard Class)

The server certificate for the last established connection.

Syntax


public Certificate getSSLServerCert();


Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

TerminalNumber Property (PTechGiftCard Class)

Terminal number assigned by Paymentech.

Syntax


public String getTerminalNumber();


public void setTerminalNumber(String terminalNumber);

Default Value

""

Remarks

3-digit field assigned by Paymentech, which identifies the terminal to the host.

Timeout Property (PTechGiftCard Class)

A timeout for the class.

Syntax


public int getTimeout();


public void setTimeout(int 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 class will wait for the operation to complete before returning control.

The class 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 class throws 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.

TransactionAmount Property (PTechGiftCard Class)

Purchase amount for an authorization.

Syntax


public String getTransactionAmount();


public void setTransactionAmount(String transactionAmount);

Default Value

""

Remarks

This field contains the transaction amount to be authorized. The transaction amount is presented in US Dollars with a decimal point in the proper position. If sending a Debit transaction and the customer requests cash back, the TransactionAmount must include the total cost of the purchase, PLUS the DebitCashBack amount.

This must be formatted as a dollar amount with a real decimal point, excluding the dollar sign. For instance "12.00"

UserId Property (PTechGiftCard Class)

UserId for authentication with the NetConnect Server .

Syntax


public String getUserId();


public void setUserId(String userId);

Default Value

""

Remarks

The UserId will be supplied to you by PaymenTech.

ActivateCard Method (Ptechgiftcard Class)

Activates a Gift Card.

Syntax

public void activateCard();

Remarks

Stored value Activation transactions provide merchants the ability to activate a new stored value card on the Chase Paymentech stored value host. Activation transactions can only be performed on cards that have not been previously activated. Activation transactions are usually used by merchants who wish to identify how many new stored value cards have been issued, from the previously activated stored value cards that have had additional value issued. Merchants have the ability to activate stored value cards with a host configured pre-denominated TransactionAmount or activate the cards with a flexible TransactionAmount. With pre-denominated cards, dependent on host configurations, the stored value host will either approve the transaction for the amount that the pre-denominated card is setup for (regardless of the amount keyed), or decline the transaction if the amount keyed at the Point-of-Sale if the amount doesn't match the amount identified on the card.

This transaction is automatically added to the current open batch, and will be settled when the PTechHostSettle class's BatchRelease method is called.

The gift card may be specified by either a MagneticStripe returned by a card reader, (Track2 only), or manually entered through the Number, ExpMonth, and ExpYear.A 3-digit Card Verification Value code may also be supplied in the CVVData field.

The Code and Text fields indicate whether this transaction was successful.

Note: Activation transactions will fail at the stored value host if the card has been previously activated or has previously had value issued to it. Also, ActivateCard cannot be used to activate a card that has been deactivated via the DeactivateCard method. You must use the ReactivateCard method instead.

AddValue Method (Ptechgiftcard Class)

Activates and/or adds funds to a Gift Card.

Syntax

public void addValue();

Remarks

AddValue transactions allows a merchant to issue or add value to a stored value card at the host. This transaction can be used on both new and existing stored value cards. The AddValue transaction can be used in place of an ActivateCard transaction.

AddValue transactions can be performed on a stored value card more than once over the lifetime of the card, as the cardholder chooses to "reload" the card.

Merchants have the ability to issue stored value cards with a host configured pre-denominated amount, or issue the cards with a flexible transaction amount. With pre-denominated cards, based on the selections indicated at sign-up, the stored value host will either approve the transaction for the amount that the pre-denominated card is setup for (regardless of the amount keyed), or decline the transaction if the amount keyed at the Point Of Sale doesn't match the amount identified on the card.

This transaction is automatically added to the current open batch, and will be settled when the PTechHostSettle class's BatchRelease method is called.

The gift card may be specified by either a MagneticStripe returned by a card reader, (Track2 only), or manually entered through the Number, ExpMonth, and ExpYear.A 3-digit Card Verification Value code may also be supplied in the CVVData field.

The Code and Text fields indicate whether this transaction was successful.

BalanceInquiry Method (Ptechgiftcard Class)

Retrieves the balance remaining on a gift card.

Syntax

public void balanceInquiry();

Remarks

A BalanceInquiry transaction requests that the host return the quantity of funds remaining in the customer's Stored Value (Gift) Card. This transaction is not added to the batch and cannot be settled by the PTechHostSettle class. No charge is made to the customer's gift card.

The gift card may be specified by either a MagneticStripe returned by a card reader, (Track2 only), or manually entered through the Number, ExpMonth, and ExpYear.A 3-digit Card Verification Value code may also be supplied in the CVVData field.

The Code and Text fields indicate whether this transaction was successful. The Balance field will contain the card's current balance.

Config Method (Ptechgiftcard Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

DeactivateCard Method (Ptechgiftcard Class)

Deactivates a gift card.

Syntax

public void deactivateCard();

Remarks

A stored value Deactivation transaction is the process of removing the remaining balance from a card account and placing the card into an inactive status. This transaction is most often used when the cardholder has lost the card, yet still has the card number. The terminal will initiate a transaction to the host, which will redeem the total balance on the card. Once a card is deactivated, it can only be restored to circulation using the ReactivateCard method. Calling AddValue on a deactivated card will result in an error.

The gift card may be specified by either a MagneticStripe returned by a card reader, (Track2 only), or manually entered through the Number, ExpMonth, and ExpYear.A 3-digit Card Verification Value code may also be supplied in the CVVData field.

The Code and Text fields indicate whether this transaction was successful.

Interrupt Method (Ptechgiftcard Class)

Interrupt the current method.

Syntax

public void interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ReactivateCard Method (Ptechgiftcard Class)

Re-activates Gift Card that has been previously deactivated.

Syntax

public void reactivateCard();

Remarks

This method re-activates and returns to circulation a Gift Card that was deactivated through the DeactivateCard method. Note that any balance that was present before the card was deactivated is lost, and the card starts fresh with a $0.00 balance. You must specify a TransactionAmount to initialize the reactivated card with funds (you cannot reactivate a card with a $0.00 TransactionAmount).

The gift card may be specified by either a MagneticStripe returned by a card reader, (Track2 only), or manually entered through the Number, ExpMonth, and ExpYear.A 3-digit Card Verification Value code may also be supplied in the CVVData field.

The Code and Text fields indicate whether this transaction was successful.

RedeemCard Method (Ptechgiftcard Class)

Deducts funds from a gift card for the purchase of goods or services.

Syntax

public void redeemCard();

Remarks

A Redemption transaction is the process of deducting value from the Gift Card, and is very similar to a Credit Card Sale transaction, except that funds are immediately removed from the balance of the gift card. RedeemCard requests that the host verify and remove funds from the cardholder's Stored Value (Gift) Card. This transaction is automatically added to the current open batch, and will be settled when the PTechHostSettle class's BatchRelease method is called.

The gift card may be specified by either a MagneticStripe returned by a card reader, (Track2 only), or manually entered through the Number, ExpMonth, and ExpYear.A 3-digit Card Verification Value code may also be supplied in the CVVData field.

The Code and Text fields indicate whether this transaction was successful. The host will return either an approval if the card has the requested value, or a decline if the card has less than the requested value.

If the merchant allows it, at the time of purchase a customer my Cash Out his gift card, and receive the remainder of the gift card's stored value as cash. To cash out a gift card, set the CashOutIndicator to True before calling RedeemCard. The change to be returned to the customer (The gift card's total value minus the TransactionAmount) will be returned in CashOut, and the Balance will be "0.00".

In the case that the customer's gift card does not have enough funds to cover the entire TransactionAmount, the merchant may request that the host perform a Partial Redemption. With PartialRedemption set to True, the Point of Sale is capable of processing a Redemption transaction for more than the card balance and still receive an approval. All of the funds remaining on the gift card will be put towards the TransactionAmount, and the merchant will be required to obtain an additional form of payment for the remaining balance. The amount actually removed from the card will be returned in AuthorizedAmount, and the customer's receipt should indicate the remaining amount (TransactionAmount - AuthorizedAmount) due.

Reset Method (Ptechgiftcard Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

VoidTransaction Method (Ptechgiftcard Class)

Voids a transaction in the current batch.

Syntax

public void voidTransaction(String retrievalNumberToVoid, String lastRetrievalNumber);

Remarks

A stored value Void transaction allows the removal of a transaction from the open batch in the terminal. The void will communicate to the stored value host so that the host can reverse the requested stored value transaction.

The VoidTransaction method has two parameters, RetrievalNumberToVoid and LastRetrievalNumber. RetrievalNumberToVoid is the RetrievalNumber of the transaction you wish to void. LastRetrievalNumber should be set to the last RetrievalNumber received from the Paymentech Server. If LastRetrievalNumber is left blank, the contents of the RetrievalNumber field will be used instead.

Before sending a void, you must make sure that the Number field contains the card number from the original transaction. For example:

class.Card = new CCCard("4444333322221111", 1, 2010); class.TransactionAmount = "1.00"; class.RedeemCard(); cnumToVoid = class.Card.CardNumber; refNumToVoid = class.Response.RetrievalNumber; ... more sale transactions ... 'All that's needed for a void: class.Card = new CCCard(cnumToVoid, -1, -1); // Expiration date will be ignored class.SequenceNumber++; class.VoidTransaction(refNumToVoid, class.Response.RetrievalNumber);

In the above void, if you use a new instance of the class or otherwise reset it's state, you must set the LastRetrievalNumber parameter as well.

Note: Voids cannot be performed on BalanceInquiry or Forced transactions.

DataPacketIn Event (Ptechgiftcard Class)

Fired when receiving a data packet from the transaction server.

Syntax

public class DefaultPtechgiftcardEventListener implements PtechgiftcardEventListener {
  ...
  public void dataPacketIn(PtechgiftcardDataPacketInEvent e) {}
  ...
}

public class PtechgiftcardDataPacketInEvent {
  public byte[] dataPacket;
}

Remarks

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

DataPacketOut Event (Ptechgiftcard Class)

Fired when sending a data packet to the transaction server.

Syntax

public class DefaultPtechgiftcardEventListener implements PtechgiftcardEventListener {
  ...
  public void dataPacketOut(PtechgiftcardDataPacketOutEvent e) {}
  ...
}

public class PtechgiftcardDataPacketOutEvent {
  public byte[] dataPacket;
}

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 (Ptechgiftcard Class)

Information about errors during data delivery.

Syntax

public class DefaultPtechgiftcardEventListener implements PtechgiftcardEventListener {
  ...
  public void error(PtechgiftcardErrorEvent e) {}
  ...
}

public class PtechgiftcardErrorEvent {
  public int errorCode;
  public String description;
}

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 (Ptechgiftcard Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultPtechgiftcardEventListener implements PtechgiftcardEventListener {
  ...
  public void SSLServerAuthentication(PtechgiftcardSSLServerAuthenticationEvent e) {}
  ...
}

public class PtechgiftcardSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

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 (Ptechgiftcard Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultPtechgiftcardEventListener implements PtechgiftcardEventListener {
  ...
  public void SSLStatus(PtechgiftcardSSLStatusEvent e) {}
  ...
}

public class PtechgiftcardSSLStatusEvent {
  public String message;
}

Remarks

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

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will throws an exception because none is present.

Fields

CardType
int

Default Value: 0

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

ctUnknown (0) Invalid or unknown prefix, card type not known.
ctVisa (1) Visa or Delta Card.
ctMasterCard (2) MasterCard.
ctAMEX (3) American Express Card.
ctDiscover (4) Discover Card.
ctDiners (5) Diners Club or Carte Blanche Card.
ctJCB (6) JCB Card.
ctVisaElectron (7) Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8) Maestro Card
ctLaser (10) Laser Card (Ireland)

CVVData
String

Default Value: ""

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

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

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

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

CVVPresence
int

Default Value: 0

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

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

Available values are:

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

EntryDataSource
int

Default Value: 0

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

edsTrack1 (0) Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1) Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2) Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (Number, ExpMonth, and ExpYear are sent).
edsKiosk (9)Automated kiosk transaction. Track1 or Track2 data must be sent in MagneticStripe, the transaction cannot be manually entered.

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

TSYSHCBenefit edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce edsManualEntryNoCardReader
TSYSHCRetail edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

ExpMonth
int

Default Value: 1

Expiration month of the credit card specified in Number.

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

ExpYear
int

Default Value: 2000

Expiration year of the credit card specified in Number.

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

IsEncrypted
boolean

Default Value: False

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

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

MagneticStripe
String

Default Value: ""

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

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

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

class.Card = new CCCard("B4788250000028291^TSYS^05121015432112345678", dsTrack1) or class.Card = new CCCard("4788250000028291=05121015432112345678", dsTrack2) or CCCardType Card = new CCCard() Card.MagneticStripe = "B4788250000028291^TSYS^05121015432112345678" Card.EntryDataSource = dsTrack1

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

Number
String

Default Value: ""

Customer's credit card number for the transaction.

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

Constructors

public CCCard();



public CCCard( number,  expMonth,  expYear);



public CCCard( magneticStripe,  entryDataSource);



Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate
String (read-only)

Default Value: ""

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
String

Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields 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.

EncodedB
byte[]

Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields 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.

ExpirationDate
String (read-only)

Default Value: ""

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String

Default Value: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
String (read-only)

Default Value: ""

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
String (read-only)

Default Value: ""

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
String (read-only)

Default Value: ""

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
String (read-only)

Default Value: ""

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String

Default Value: ""

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.

PrivateKey
String (read-only)

Default Value: ""

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean (read-only)

Default Value: False

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String (read-only)

Default Value: ""

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String (read-only)

Default Value: ""

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String

Default Value: ""

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)

Default Value: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String (read-only)

Default Value: ""

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
String (read-only)

Default Value: ""

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
String

Default Value: "MY"

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

The StoreType field 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 field 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 field for details.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

StoreB
byte[]

Default Value: "MY"

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

The StoreType field 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 field 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 field for details.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

StorePassword
String

Default Value: ""

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

StoreType
int

Default Value: 0

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The 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: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

Subject
String

Default Value: ""

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

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

SubjectAltNames
String (read-only)

Default Value: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String (read-only)

Default Value: ""

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
String (read-only)

Default Value: ""

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
String (read-only)

Default Value: ""

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
String

Default Value: ""

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int

Default Value: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication (Non-Repudiation)
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String (read-only)

Default Value: ""

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Proxy Type

The proxy the class 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
int

Default Value: 0

This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields 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 fields 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 class. Look at the configuration file for the class 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 field will clear the values of User and Password.

AutoDetect
boolean

Default Value: False

This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Note: This setting is applicable only in Windows.

Password
String

Default Value: ""

This field 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 fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int

Default Value: 80

This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field 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 field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
int

Default Value: 0

This field 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 class will use the psTunnel option. If the URL is an http URL, the class 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 field contains a username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields 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 fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

public Proxy();



public Proxy( server,  port);



public Proxy( server,  port,  user,  password);



PTechGiftCardResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the PTechGiftCard class. The fields contained by this type are listed below.

Fields

ApprovalCode
String (read-only)

Default Value: ""

Contains an authorization code when a transaction has been approved, or an error code. This six character field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction has not been approved, then this field will contain an error code, and the Text field will contain the description. Note that the host does not send back an actual authorization code for Credit Returns. Instead, the host sends back six blank spaces in the authorization code field. Credit VOIDS return the original authorization number.

See the list of errors for this class for more information.

AuthorizedAmount
String (read-only)

Default Value: ""

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

Note that the AuthorizedAmount will only contain a value if the PartialRedemption property in the authorizing class was set to True. It will remain blank otherwise.

Balance
String (read-only)

Default Value: ""

Balance after this transaction was completed. This field contains the available balance remaining on the card. It is required that this value be printed on the customer's receipt.

BatchNumber
String (read-only)

Default Value: ""

Current open batch number This field is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

CashOut
String (read-only)

Default Value: ""

The sum of the TransactionAmount plus the remainder of any value left on the card. When the CashOutIndicator field is set to True, the stored value card will be "cashed out". This means that all funds stored on the card is cleared, and the merchant is to return those funds to the customer as cash. When CashOutIndicator is True, the CashOut field will contain the amount of money the merchant is to return to the customer in cash. AuthorizedAmount will contain the total amount removed from the gift card (The sum of the TransactionAmount plus the CashOut amount).

Code
String (read-only)

Default Value: ""

Indicates the status of the authorization request. This is the field used to determine whether a transaction has been approved or not. Valid values for this field are:

ATransaction is Approved.
EError condition or card declined (see the Error section of the help file for more information).

See the list of errors for this class for more information.

CVVResult
String (read-only)

Default Value: ""

Contains the returned CVV result code if it was requested. If a CVV value was present in the CVVData field before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the Card.CVVData; field is filled. Instead, an AMEX transaction will be declined if the CVV value does not match, with an Text indicating such. The following is a list of current result codes:

MCVV2 match.
NCVV2 no match.
PNot processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer not certified and/or has not provided Visa encryption keys.

PreviousBalance
String (read-only)

Default Value: ""

Balance before this transaction started. This field contains the available balance on the card BEFORE this transaction took place. For instance, if a Stored Value card contains funds in the amount of $50.00, and the TransactionAmount for this authorization was "20.00", the Balance will contain "30.00" and the PreviousBalance, if returned, will contain "50.00". This field may or may not be returned by the processor, and is not required to be printed on the customer's receipt.

RetrievalNumber
String (read-only)

Default Value: ""

Reference number returned from the Paymentech host. This is the reference number of the transaction as assigned by the Paymentech host. This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the VoidTransaction method.

If the SettlementMode is set to manual this field will contain the POSRetrievalNumber submitted in the authorization. If no POSRetrievalNumber was sent, this field will contain all zeros, and you will not have a reference number for the transaction.

If the SettlementMode is set to host settle, this field will always contain the Paymentech-generated retrieval number returned by the transaction server, regardless of the value contained in the POSRetrievalNumber property.

In all cases, the RetrievalNumber will contain the number used to reference the transaction when issuing voids or reversals.

SequenceNumber
String (read-only)

Default Value: ""

SequenceNumber echoed from the authorization. After any transaction this field will contain the same value sent in the SequenceNumber property.

Text
String (read-only)

Default Value: ""

Approval/Decline/Error text message information This field contains a response or display text message, and is used by the terminal to display the authorization result. This field will contain human-readable text indicating whether the transaction was approved or declined, or will contain a description of the error. The actual error code will be returned in the ApprovalCode field. The Text field is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the Code field to determine this.

See the list of errors for this class for more information.

Trace
String (read-only)

Default Value: ""

Trace number returned for Stored Value transactions. This field is returned in the response to a Stored Value card transaction. The returned value is used for transaction tracking purposes, and must be printed on the customer's receipt.

Constructors

public PTechGiftCardResponse();



Config Settings (Ptechgiftcard Class)

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

PTechGiftCard Config Settings

AllowPartialAuths:   Indicates whether partial authorizations are to be supported.

When this setting is True, if the credit card being authorized does not contain sufficient funds to cover the TransactionAmount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount, which is equal to the balance of the credit card. The customer must then use another form of payment to make up the remainder. The total amount authorized by Paymentech will be returned in the AuthorizedAmount configuration setting. For instance, if the TransactionAmount is $50, but credit card only has a $42 balance, the card is charged for $42.00, and the AuthorizedAmount will be "42.00". The merchant may then collect the remaining $8 in cash, check, credit card, or any other acceptable form of payment. This setting is True by default.

CustomerDefinedData:   Additional transaction identification data.

This data field will allow merchants to assign a unique value to their transaction that will assist them in reconciling their authorization activity to their settlement activity. This field is supported for all transactions and all IndustryTypes. The data will be stored on the Paymentech system, however only Paymentech acquired merchants will see this value in their back-end reporting (Combined Extract File). Note that the maximum length for the CustomerDefinedData is 30 characters. Strings longer than 30 characters will be truncated by the class.

DiscoverAuthAmount:   Returns the amount authorized for the transaction.

After an operation this setting may be queried to return the amount authorized for that transaction. The decimal point in the returned value is implied. This is a read-only configuration setting valid only for Discover transactions.

DiscoverPINCapabability:   Indicates if the POS is capable of supporting a PIN.

After an operation this setting may be queried to return the code which indicates if the POS is capable of supporting a PIN. This value is determined at the host based on transaction and terminal parameter settings. This is a read-only configuration setting valid only for Discover transactions.

DiscoverPOSEntryMode:   Returns the method by which the primary account number was entered at the POS.

After an operation this setting may be queried to return the method by which the PAN was entered at the POS. This is a read-only configuration setting valid only for Discover transactions.

DiscoverProcessingCode:   Returns the type of Authorization request that was submitted to Discover.

After an operation this setting may be queried to return the type of authorization request that was submitted to Discover. This is a read-only configuration setting valid only for Discover transactions.

DiscoverSystemTraceAuditNumber:   Returns the value assigned by the host/merhant to assist in identifying a specific transaction.

After an operation this setting may be queried to return the value assigned by the host/merhant to assist in identifying a specific transaction. This is a read-only configuration setting valid only for Discover transactions.

DiscoverTrackDataCondition:   Returns condition of the track data.

After an operation this setting may be queried to return the condition of the track data. This is a read-only configuration setting valid only for Discover transactions.

HardwareSerialNum:   Hardware Serial Number.

This field is used for POS/VAR Capabilities Data. It determines the serial number of hardware device.

HostProcessingTypes:   Host Processing Platform.

This field is used for POS/VAR Capabilities Data. It can be set to the binary 'OR' of one or more of the following values:

Valid values:

Description Value
TAS Only Credit 128 (Hex 0x80)
TAS/TCS Credit 64 (Hex 0x40)
TCS Only Credit 32 (Hex 0x20)
HCS Auth Only Credit 16 (Hex 0x10)
HCS Auth/Settle Credit 8 (Hex 0x8)
Host Extended Product Support (Debit, SV, EBT) 4 (Hex 0x4)
For TAS/TCS Credit and Host Extended Product, this configuration setting must be set to 68.

RequestBalanceInfo:   Specifies whether to request balance information.

When this setting is 'True', the available card balance amounts will be returned via ResponseBalanceAmount1 and ResponseBalanceAmount2 and the currency codes for each amount will be returned via ResponseBalanceCurrency1 and ResponseBalanceCurrency2. This setting is 'False' by default.

ResponsePOSRetrievalNumber:   POS Retrieval Number sent in the request, echoed back in the response.

If the SettlementMode is set to Host Capture, Paymentech ignores the value of the POSRetrievalNumber property and generates its own RetrievalNumber to reference the transaction. The ResponsePOSRetrievalNumber configuration setting can be used to return the value you sent in the request, but the RetrievalNumber will always contain the number used to reference the transaction.

SettlementMode:   Indicates whether the class uses Paymentech's Host Capture or Terminal Capture system.

Possible values are:

0 Host Capture (default)
1 Terminal Capture

Note that for PTechReversal, 1 (Terminal Capture) will be the default value. If Host Capture is being used, a value of 0 will need to be set.

Host-Capture means that you authorize your transactions using the AuthOnly or Sale methods, and you process refunds and capture outstanding authorizations with the Credit and Capture methods. Paymentech handles all batch management. All you need to do is use the PTechHostSettle class to release the batch for settlement (you may even set your account up for Host Auto-Close, which will automatically release the batch for settlement at the end of the business day).

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging and Restaurant IndustryTypes, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a restaurant authorization may have a GratuityAmount added to the original charge before the transaction is settled. Likewise, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types supported by PTechCharge may be processed in smTerminalCapture mode. However, Restaurant and Hotel transactions MUST be authorized and settled in smTerminalCapture mode. Attempting to authorize a Restaurant or Hotel/Lodging transaction with the SettlementMode; set to 0 (Host Capture) will cause the class throws an exception.

When processing transactions in smTerminalCapture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle classs. Attempting to call the VoidTransaction or Capture methods the class throws an exception.

SoftwareID:   Software Identifier.

This field is used for POS/VAR Capabilities Data. It is assigned by Paymentech at the time of certification.

Default value is "010C".

SystemInformation:   System Information field for Batch Inquiry and Release transactions.

System Information that all software packages must supply to the Paymentech host when sending a Batch Inquiry or Release transaction. Unless Paymentech indicates otherwise, the value of this configuration setting should not be changed. If it is changed, it should meet the specifications below.

The class 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
For example: DIRPAYI110613VERSION6.0

VendorID:   Hardware/Vendor Identifier.

This field is used for POS/VAR Capabilities Data. It is assigned by Paymentech at the time of certification.

Default value is "0076".

VoiceAuthCode:   When VoiceAuthCode contains a value, the class will send a Force transaction to the Paymentech system.

A Force (Prior) transaction is an ActivateCard, AddValue, or RedeemCard transaction submitted with an approval code obtained via the Voice Auth Center. These online transactions will only be approved if the VoiceAuthCode submitted in the request matches that of the Authorization Code generated by the Voice Auth Center.

Please note that Forced transactions cannot be voided with VoidTransaction. This is because the balance of the Gift Card is adjusted at the time of the Voice Authorization. Although this Force transaction does not have an effect on a card's balance, it is necessary in order to keep the Point Of Sale and the Host in balance with one another.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class 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.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback:   Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

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]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

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 class throws 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 class throws an exception instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "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 class 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/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting.

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.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

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

MaxHeaders:   Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies:   Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

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 class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

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

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate:   Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallListener:   If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the 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).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

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.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

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.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback
UseNTLMv2:   Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

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.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. 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-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

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.

SSLContextProtocol:   The protocol used when getting an SSLContext instance.

Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Note: This value must be set after SSLProvider is set.

Example values: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); Possible values when SSLProvider is set to latform include:

  • SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_RC4_128_SHA
  • SSL_RSA_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_WITH_DES_CBC_SHA
  • SSL_RSA_WITH_NULL_MD5
  • SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
  • SSL_DHE_RSA_WITH_DES_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
  • SSL_RSA_WITH_NULL_SHA
  • SSL_DH_anon_WITH_RC4_128_MD5
  • SSL_RSA_WITH_RC4_128_MD5
  • SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_NULL_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
  • TLS_ECDH_anon_WITH_RC4_128_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_EXPORT_WITH_RC4_40_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDH_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDH_anon_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_NULL_SHA256
  • TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
  • TLS_KRB5_WITH_RC4_128_MD5
  • TLS_ECDHE_ECDSA_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_RC4_128_SHA
  • TLS_EMPTY_RENEGOTIATION_INFO_SCSV
  • TLS_KRB5_WITH_3DES_EDE_CBC_MD5
  • TLS_KRB5_WITH_RC4_128_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_NULL_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_DES_CBC_MD5
  • TLS_KRB5_EXPORT_WITH_RC4_40_MD5
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
  • TLS_ECDH_anon_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_NULL_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_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.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the 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 class 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.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

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.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

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

SSLTrustManagerFactoryAlgorithm:   The algorithm to be used to create a TrustManager through TrustManagerFactory.

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class throws 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.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

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)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

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"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "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 rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

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

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • 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.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class 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 (Ptechgiftcard Class)

PTechGiftCard Errors

432   Invalid Index
501   Property length is invalid
504   Luhn digit check failed.
505   Card date invalid.
506   Card expired.
511   Property is set with invalid data.
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.

Paymentech Server Errors:

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 field will contain "E", the error code will be contained in the ApprovalCode field, and the description in Text

Paymentech Issuer Errors

ApprovalCodeTextDescription
200Auth DeclinedCardholder's bank did not approve transaction.
201Call Voice OperAuthorizer needs more information for approval.
202Hold - CallCard issuer does not want that card used. Call for further instructions.
203Call Voice OperAuthorizer didn't respond within allotted time.
204Invalid Card NoAccount #/mag stripe is invalid.
205Invalid Exp. DateExpiration date is either incorrect format or prior to today.
206Invalid ICA NoInvalid International Control Account number.
207Invalid ABA NoInvalid American Banking Association number.
208Invalid PIN NoThe Personal ID Number for a debit transaction is incorrect.
209Invalid Bank MID The Bank Merchant ID is incorrect.
210Invalid Term NoThe merchant ID is not valid or active.
211Invalid AmountAmount is either: equal to 0, has no decimal, has decimal in wrong place, or has multiple decimals.
213Invalid Tran FmtThe transaction format isn't valid, typically invalid SIC code
214Call Voice OperAuthorization center cannot be reached.
215Lost/Stolen CardCard has been reported lost or stolen.
216Invalid PINPersonal ID code is incorrect.
217Over Credit FlrAmount requested exceeds credit limit.
218Request DeniedTransaction is not valid for this authorizer.
220Not Online to XXFatal communications error.
221Auth Down-RetryDebit authorizer temporarily unavailable.
222Auth DeclinedVehicle not found in positive file.
223Invalid Pin NoDriver # not found in positive file.
224Auth DeclinedCard is on private label negative file.
225Card Not AllowedMerchant does not accept this card.
226PL Setup ReqdMerchant not set up for Private Label.
227BIN Not AllowedMerchant cannot accept this Private Label BIN range.
228Card Not AllowedMerchant cannot accept this card.
229Inv Merc Rstrct CodeRestriction code field contains invalid data.
230Prod RestrictedMerchant attempted a product code not permitted by this merchant.
231Prod Not On FileMerchant attempted a product code that does not exist on host.
232Auth DeclinedInvalid card type for Prior Auth sale.
233Auth DeclinedTerminal Type not supported.
234Auth DeclinedT&E card used for Sale when merchant only allows Auth Only.
235*Request Denied*Prior Auth selected with no Auth code provided.
238Invalid Driver NumberThe Driver Number entered is invalid.
247PIN Not SelectedEBT recipient has not selected a PIN for this card.
248Unmatch Vch InfoVoucher submitted does not match one previously issued.
248CVC2/CID ERRORCVC2 or CID entered was not valid for the card number.
249Tran Not DefinedThis type of transaction is not allowed for this type of card.
257Block Act Not AlwdThe merchant.is not allowed to process Stored Value Block Activations
258Incorrect Act AmtThe activation amount requested does not match the predenominated amount for the card.
292Auth Down - RetryAuthorizer is not responding.
293Auth Busy - RetryAuthorizer not available at this time.
294Auth Busy - RetryAuthorizer not available at this time.
297Auth Error - RetryAuthorizer not available at this time.
298Err - Pls RetryDebit authorizer experienced an error.
299Err - Pls RetryDebit authorizer experienced an error.

Paymentech Format Errors

ApprovalCodeTextDescription
300Invalid Term IDThe length of the merchant ID is incorrect or contains invalid data.
301Invalid FunctionTran code is incorrect or wrong length.
302Invalid CardMag stripe contains invalid data or account # is greater than 19 digits
303Invalid Exp. DateCard has expired, month was not 01-12 or year was not 00-99.
304Invalid Action CodeAction code is longer than 1 digit.
305Amt Entry ErrorAmount less than .01 or greater than 99999.99 or contained non- numeric data.
306Invalid PINIncorrect PIN block length.
307Invalid Card Invalid card type or account number.
308Auth # Not EnteredAuth code was not entered on a Prior Auth, Incremental or Rev.
309Invalid Down Pay IndInsurance down payment indicator is invalid.
310Policy # Wrong LenInsurance policy number is incorrect length.
311Invalid Ind CodeIndustry type must be RE or DM.
312Invalid FunctionTran code is invalid or contains alpha data.
313Entry Mode InvalidPOS Entry mode is less than 01 or greater than 04.
314Invalid Industry DataThe Industry Specific field contains invalid data.
315Inv Fleet DataThe Fleet Card field contains invalid data.
316Invalid Sys InfoThe System Information field contains invalid data.
317Invalid FormatPayment Service indicator or Transaction ID is invalid.
318Inv Transaction ClassTransaction class not "F" for financial transaction.
319Inv PIN CapabilityPin capability code field contains invalid data.
320Inv/Missing Retr RefRetrieval Reference # is missing or contains alpha data.
321Inv MSDIMarket Specific Data field contains invalid data.
322Invalid DurationMarket specific data field Duration is 00, blank or missing.
323Inv Pref Cust IndPreferred Customer indicator contains invalid data.
324Inv MO/TO NumberMail/Telephone Order number is invalid (InvoiceNumber must have a value).
325Inv Sale/Chg Des/FolioHotel Sale Code, Charge Descriptor or Folio contains invalid data.
326Inv Mult Clr Seq NoMultiple Clearing sequence number is invalid.
327Inv Purch Card DataPurchasing card field contains invalid data.
328Inv Input/Use VRUInsurance transaction not from VRU.
329Invalid EC Data 329Invalid Electronic Commerce Data.
330INV Function or Multiple FS or Unknown TKNIndicates system problem, notify Paymentech Network Services or Multiple field separators received without required data or A token of unknown definition was received
331INV TKN ValueInvalid token value was received.
332CVD Data ErrorError with the cardholder verification data received; invalid value or not allowable for this card for this transaction.
333TKN Data ErrorIndicates system problem, notify Paymentech Network Services.
359Invalid Sequence NumberThe SequenceNumber must be a number between 0 and 2400.

Paymentech Host / Setup Errors

ApprovalCodeTextDescription
400Invalid Term IDMerchant ID not found in merchant file.
401Invalid Term IDMerchant ID not found in terminal file.
402Term Not ActiveActive flag for merchant set to "N".
403Invalid Act CodeMerchant not set up for cash advance function.
404Void Not AllowedThe transaction requested for voiding is not an EFT transaction.
405Ref Num Not FoundTransaction requested for reversal not found.
406Proc Error 7The host can't clear all transaction records for the requested Batch Release.
407Too Many BatchesThere are 999 open batches for this merchant.
408Release BatchCurrent batch has 999 records. Release batch before continuing.
409Invalid FunctionDebit transaction requested but debit flag is set to "N".
410Invalid Term IDThe Terminal ID portion of the merchant ID is incorrect.
411Invalid Term IDThe maximum retries for this merchant have been exceeded.
412Proc Error 13Unable to read reference number file.
413Proc Error 14413
414Proc Error 15414
415Invalid Function 415
416Invalid FunctionMerchant is Authorization Only and a debit record was sent.
417Invalid FunctionPrivate label flag is "N" but a private label account number was sent.
418Please Try AgainIncorrect debit working key.
419Invalid Function Manually entered transactions are not allowed for this terminal ID.
420Amount Too LargeMaximum sale amount exceeded.
421Amount Too LargeMaximum return amount exceeded.
422Invalid Term IDHost couldn't read terminal file within specified time.
423Proc Error 24Host couldn't read reference number file within specified time.
424Invalid Term IDTransaction open flag has been set to "Y" within prior 3 minutes.
425Invalid FunctionCash management not allowed for this merchant ID.
426Rev Not AllowedHost found no batch number matching the one sent.
427Rev Not AllowedHost found no transactions meeting the specifications sent.
428Dscv Not AllowedMerchant not set up for Discover transactions.
429Rev Not AllowedThe batch containing the transaction to void has been released.
430Dscv Not AllowedMerchant not set up for Discover.
431DC Not AllowedMerchant not set up for Diners Club.
432CB Not AllowedMerchant not set up for Carte Blanche.
433Invalid KeyNo AMEX subscriber number, process control ID or product code set up
434Invalid KeyFuture use.
435Failed-Plz CallDebit transaction being sent to an authorizer not set up on host file.
436Failed-Plz CallDebit security key does not exist on the security management file.
437Failed-Plz CallFailure occurred during encryption/decryption of PIN.
438Failed-Plz CallError occurred while generating a debit working key.
439Failed-Plz CallThe DB (debit) sponsor institution on the merchant file is not set up on sponsor file.
440Failed-Plz CallThe network set up on the sponsoring bank file for this institution is not set up on the host's network file.
441Failed-Plz CallThe host is unable to communicate with decryption device.
442JCB Not AllowedJCB CD flag on merchant record not set up for JCB transactions.
443JCB Not AllowedJCB subscriber number not set up for JCB transactions.
444Bank Not On FileDebit BIN not set up for this merchant in routing table.
445No Sponsor InstNo valid sponsorship was found on Merchant record.
446Failed Plz CallFuture use.
447WX Not AllowedMerchant not set up to accept WEX.
448Amount Too LargeAmount exceeds maximum limit.
449Reenter OdometerOdometer was 000000 or contained non-numeric data.
450Duplicate TranNo ACK reversal was followed by a duplicate request
451Tran Not AllowedRequested transaction type is not allowed for this card/merchant.
452Bat Already RelsBatch has already been released.
453Invalid Rtng IndInvalid Routing Indicator field.
454AX Not AllowedAMEX not allowed.
999Invalid MerchantMerchant number not on file.

Paymentech Debit / EBT Specific Errors

ApprovalCodeTextDescription
602Call Voice OpAuth center cannot be reached.
692Auth Down-Retry Debit authorizer temporarily unavailable.
693Auth Busy-Retry Queue for debit authorizer too long.
694Auth Busy-Retry Debit authorizer not responding in time.

Paymentech Batch Management Errors (use the ErrorCode configuration setting to retrieve this information from the PTechHostSettle class.

ErrorCodeTextDescription
105Invalid Term IDMerchant ID on a Batch Inquiry or Release is incorrect.
106Term Not ActiveActive flag for the merchant ID is set to N.
107No TransactionsA Batch Inquiry or Release was requested but no open batch exists.
108Bat Already RelsA second batch release was attempted.
109Batch Not FoundRequested batch does not exist.

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.

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 class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
303   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).