GlobalTransactionSearch Component

Properties   Methods   Events   Config Settings   Errors  

The GlobalTransactionSearch component is used to search for transactions made using the Global Transport Direct API. It can search for transactions in the open batch or in any previously closed batch.

Syntax

TibcGlobalTransactionSearch

Remarks

This component can be used to search for all the transactions made from your Global Payments account, and returns transactions that match your specified SearchCriteria. To do a search, first set your UserId, Password, and VendorNumber. If you're submitting test transactions and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com"). Now set the SearchCriteria to the transactions you're looking for, and call Search. At the minimum, you must specify a start and end date range in the SearchBeginDate and SearchEndDate properties. All other search criteria properties are optional. However, if you wish to retrieve information for one particular transaction, set the SearchPNRef property instead. All other properties will be ignored if the SearchPNRef property is set. The results of your search will be contained in the SearchResults collection.

This component can also return a transaction summary for all transactions that match your SearchCriteria by calling the GetTransactionSummary method. The SearchBeginDate and SearchEndDate are still required for transaction summaries, but only a subset of SearchCriteria properties may be used to restrict the results. See GetTransactionSummary for details.

Property List


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

PasswordPassword for authentication with the Global Payments Server .
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
SearchApprovalCodeIf provided, only those transactions matching the specified ApprovalCode will be included in the search results.
SearchBeginDateThe start of the date range in which to search for transactions.
SearchCardNumberIf specified, only those transactions with the matching card number will be included in the search result.
SearchCardTypeIf specified, only transactions made with the matching the CardType will be included in the search results.
SearchCustomerIdThe CustomerId included in the original transaction.
SearchEndDateThe end of the date range in which to search for transactions.
SearchExcludeCardTypeIf specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results.
SearchExcludePaymentTypeIf specified, any transaction matching the ExcludePaymentType will be excluded from the search results.
SearchExcludeResponseCodeIf specified, any transactions matching the ExcludeResponseCode will be excluded from the search results.
SearchExcludeTransTypeIf specified, any transaction matching the ExcludeTransType will be excluded from the search results.
SearchExcludeVoidIndicates whether or not to exclude void transactions from the search results.
SearchInvoiceNumberThe InvoiceNumber that was included in the original transaction.
SearchNameOnCardCardholder's name as it is appears on the card.
SearchPaymentTypeOnly transactions matching the PaymentType will be included in the search results.
SearchPNRefThe unique payment reference number assigned to the transaction.
SearchRegisterNumberThe RegisterNumber associated with the original transaction.
SearchResponseCodeIf specified, only those transactions with the matching response code will be included in the search results.
SearchSettleDateThe date of the settlement in MM/DD/YYYY or YYYY-MMDD format.
SearchSettleFlagIndicates whether you wish to retrieve settled transactions or unsettled transactions.
SearchSettleMessageThe settlement ID or message returned from the host.
SearchTransactionAmountThe original TransactionAmount of the transaction.
SearchTransactionTypeIf provided, only those transactions matching the TransactionType will be included.
SearchUserIdThe user who originated the transactions.
SearchResultCountThe number of records in the SearchResult arrays.
SearchResultApprovalCodeContains the transaction authorization code from the card issuer.
SearchResultAuthorizedAmountIn the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.
SearchResultAVSResultCodeContains the address verification result code from the card issuer.
SearchResultBatchNumberThe number of the batch this transaction is currently contained in.
SearchResultCardExpDateContains the credit card expiration date.
SearchResultCardNumberContains the credit card number used in the transaction.
SearchResultCardPresentIndicates whether or not this was a card-present transaction.
SearchResultCardTypeIndicates the card type or payment method.
SearchResultCashBackAmountContains the cash back amount for a debit or EBT transaction.
SearchResultClientIP* No longer supported as the underlying Global API has changed.
SearchResultCustomerIdIdentifies the customer that initiated the transaction.
SearchResultCustomerStreetContains the billing street address of the credit card.
SearchResultCustomerZipContains the billing zip code of the credit card.
SearchResultCVVResultCodeContains the card verification result code from the card issuer.
SearchResultEntryModeIndicates whether the card was swiped or manually keyed.
SearchResultError* No longer supported as the underlying Global API has changed.
SearchResultGratuityAmountContains the tip portion of the TotalAmount .
SearchResultHostCodeAction code returned by Global Payments.
SearchResultInvoiceNumberContains the transactions invoice number.
SearchResultLastModifiedContains the date and time on which the transaction was last modified.
SearchResultNameOnCardContains the cardholder's name.
SearchResultOriginalPNRefContains the Global Transport Gateway PNRef on which the current transaction is based.
SearchResultPaymentType* No longer supported as the underlying Global API has changed.
SearchResultPNRefContains a number which uniquely identifies the transaction in the Global Transport system.
SearchResultProcessorId* No longer supported as the underlying Global API has changed.
SearchResultRegisterNumberA number that uniquely identifies the register or computer on which the transaction was performed.
SearchResultResellerKey* No longer supported as the underlying Global API has changed.
SearchResultResponseCodeContains the transaction result code from the Global Transport Gateway.
SearchResultResponseMessageContains a human-readable response message concerning the transaction.
SearchResultSettleDate* No longer supported as the underlying Global API has changed.
SearchResultSettleFlagIndicates whether or not the transaction has been settled.
SearchResultTotalAmountContains the total amount of the transaction.
SearchResultTransactionDate* No longer supported as the underlying Global API has changed.
SearchResultTransactionIdCard issuer's Transaction Reference Number.
SearchResultTransactionKey* No longer supported as the underlying Global API has changed.
SearchResultTransactionTypeContains the transaction type.
SearchResultUserIdContains the username used to process the transaction.
SearchResultVendorNumberContains a number which uniquely identifies a merchant.
SearchResultVoidFlagIndicates whether or not the transaction has been voided.
ServerGlobal Payments transaction server.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SummaryCountThe number of records in the SummaryResult arrays.
SummaryResultAuthorizationAmountContains the dollar amount authorized for all transactions for the indicated PaymentType .
SummaryResultAuthorizationCount* No longer supported as the underlying Global API has changed.
SummaryResultCaptureAmountContains the dollar amount captured for all transactions for the indicated PaymentType .
SummaryResultCaptureCountContains the transaction count of all transactions that have been settled for the indicated PaymentType .
SummaryResultForceCaptureAmount* No longer supported as the underlying Global API has changed.
SummaryResultForceCaptureCount* No longer supported as the underlying Global API has changed.
SummaryResultPaymentTypeThe type of transactions being summarized.
SummaryResultPostAuthAmount* No longer supported as the underlying Global API has changed.
SummaryResultPostAuthCount* No longer supported as the underlying Global API has changed.
SummaryResultRefundAmount* No longer supported as the underlying Global API has changed.
SummaryResultRefundCount* No longer supported as the underlying Global API has changed.
SummaryResultRepeatSaleAmount* No longer supported as the underlying Global API has changed.
SummaryResultRepeatSaleCount* No longer supported as the underlying Global API has changed.
SummaryResultSaleAmount* No longer supported as the underlying Global API has changed.
SummaryResultSaleCount* No longer supported as the underlying Global API has changed.
SummaryResultTotalCountContains the total count of all transactions for the indicated PaymentType .
TimeoutA timeout for the component.
UserIdUserId for authentication with the Global Payments Server .
VendorNumberThe merchant's RP/Vendor number.

Method List


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

ConfigSets or retrieves a configuration setting.
GetTransactionSummaryRetrieves a payment type transaction summary that matches the specified SearchCriteria .
InterruptInterrupt the current method.
ResetClears all properties to their default values.
SearchRetrieves a list of payments that match the specified SearchCriteria .

Event List


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

ErrorFired when information is available about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StatusShows the progress of the Global Payments connection.

Config Settings


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

RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
SearchCriteriaBatchNumberFilters a Search or TransactionSummary based on the BatchNumber.
SearchCriteriaCardBreakdownIdentifies whether to breakdown Transaction Summaries by card type.
SearchCriteriaCustomerIdFilters a Search based on the CustomerId.
SearchCriteriaIncludeCustomFieldsIdentifies whether to include custom fields in the Search results.
SearchCriteriaPONumberFilters a Search based on the PONumber.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
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 component 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.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
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.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Password Property (GlobalTransactionSearch Component)

Password for authentication with the Global Payments Server .

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (GlobalTransactionSearch Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TibcGlobalTransactionSearchProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };
enum TibcGlobalTransactionSearchProxyAuthSchemes { authBasic=0, authDigest=1, authProprietary=2, authNone=3, authNtlm=4, authNegotiate=5 };

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GlobalTransactionSearch Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (GlobalTransactionSearch Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GlobalTransactionSearch Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (GlobalTransactionSearch Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (GlobalTransactionSearch Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TibcGlobalTransactionSearchProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };
enum TibcGlobalTransactionSearchProxySSLs { psAutomatic=0, psAlways=1, psNever=2, psTunnel=3 };

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

psAutomatic (0)Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (GlobalTransactionSearch Component)

This property contains a username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SearchApprovalCode Property (GlobalTransactionSearch Component)

If provided, only those transactions matching the specified ApprovalCode will be included in the search results.

Syntax

__property String SearchApprovalCode = { read=FSearchApprovalCode, write=FSetSearchApprovalCode };

Default Value

""

Remarks

If provided, only those transactions matching the specified ApprovalCode will be included in the search results. This property may contain up to 6 alphanumeric characters and symbols.

Data Type

String

SearchBeginDate Property (GlobalTransactionSearch Component)

The start of the date range in which to search for transactions.

Syntax

__property String SearchBeginDate = { read=FSearchBeginDate, write=FSetSearchBeginDate };

Default Value

""

Remarks

The start of the date range in which to search for transactions. This property is required except when the SearchPNRef property is provided. It may contain up to 19 alphanumeric characters and symbols. The SearchBeginDate of the date range may be in MM/DD/YYYY (or YYYY-MMDD or YYYY-MM-DDThh:mm:ss) format. This date will be converted by the Global Payments system to YYYYMM- DDThh:mm:ss (time is in 24-hour format). If the value set in SearchBeginDate does not contain time information, it will default to midnight on the given date.

Data Type

String

SearchCardNumber Property (GlobalTransactionSearch Component)

If specified, only those transactions with the matching card number will be included in the search result.

Syntax

__property String SearchCardNumber = { read=FSearchCardNumber, write=FSetSearchCardNumber };

Default Value

""

Remarks

If specified, only those transactions with the matching card number will be included in the search result. Wildcards may be used in this property.

Data Type

String

SearchCardType Property (GlobalTransactionSearch Component)

If specified, only transactions made with the matching the CardType will be included in the search results.

Syntax

__property String SearchCardType = { read=FSearchCardType, write=FSetSearchCardType };

Default Value

""

Remarks

If specified, only transactions made with the matching the CardType will be included in the search results. Valid values include:

1 Visa Card.
2 MasterCard card.
3 American Express card.
4 Novus Discover card.
12 PayPal card.
You may set this to a comma separated list of payment types. For instance, a SearchCardType of "1,4" will pull all transactions made with Visa or Discover credit cards.

Data Type

String

SearchCustomerId Property (GlobalTransactionSearch Component)

The CustomerId included in the original transaction.

Syntax

__property String SearchCustomerId = { read=FSearchCustomerId, write=FSetSearchCustomerId };

Default Value

""

Remarks

The CustomerId included in the original transaction. If provided, only those transactions made by the matching customer will be included in the search results.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchEndDate Property (GlobalTransactionSearch Component)

The end of the date range in which to search for transactions.

Syntax

__property String SearchEndDate = { read=FSearchEndDate, write=FSetSearchEndDate };

Default Value

""

Remarks

The end of the date range in which to search for transactions. This property is required except when the SearchPNRef property is provided. It may contain up to 19 alphanumeric characters and symbols. The SearchEndDate of the date range may be in MM/DD/YYYY (or YYYY-MMDD or YYYY-MM-DDThh:mm:ss) format. This date will be converted by the Global Payment system to YYYYMM- DDThh:mm:ss (time is in 24-hour format). If the value set in SearchEndDate does not contain time information, it will be incremented to the next day at midnight such that no transaction on the desired end date will be excluded based on its time.

Data Type

String

SearchExcludeCardType Property (GlobalTransactionSearch Component)

If specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results.

Syntax

__property String SearchExcludeCardType = { read=FSearchExcludeCardType, write=FSetSearchExcludeCardType };

Default Value

""

Remarks

If specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results. Valid values include:

AMEX American Express card.
CARTBLANCH Carte Blanche card.
DEBIT Debit card.
DISCOVER Novus Discover card.
EBT Electronic Benefit Transfer.
MASTERCARD Master card.
VISA Visa card.
You may set this to a comma separated list to exclude multiple payment types. For instance, an SearchExcludeCardType of "VISA,DISCOVER" will ignore all transactions made with Visa or Discover cards.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludePaymentType Property (GlobalTransactionSearch Component)

If specified, any transaction matching the ExcludePaymentType will be excluded from the search results.

Syntax

__property String SearchExcludePaymentType = { read=FSearchExcludePaymentType, write=FSetSearchExcludePaymentType };

Default Value

""

Remarks

If specified, any transaction matching the ExcludePaymentType will be excluded from the search results. Valid values include:

AMEX American Express card.
CARTBLANCH Carte Blanche card.
DEBIT Debit card.
DISCOVER Novus Discover card.
EBT Electronic Benefit Transfer.
MASTERCARD Master card.
VISA Visa card.
SETTLE Excludes requests to settle transactions.
You may set this to a comma separated list to exclude multiple payment types. For instance, an SearchExcludePaymentType of "DEBIT,EBT" will ignore all transactions with either DEBIT or EBT payment types.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludeResponseCode Property (GlobalTransactionSearch Component)

If specified, any transactions matching the ExcludeResponseCode will be excluded from the search results.

Syntax

__property String SearchExcludeResponseCode = { read=FSearchExcludeResponseCode, write=FSetSearchExcludeResponseCode };

Default Value

""

Remarks

If specified, any transactions matching the ExcludeResponseCode will be excluded from the search results. For instance, to exclude all approved transactions and return only declines, set the SearchExcludeResponseCode to "0". (As "0" is the response code for approved transactions).

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludeTransType Property (GlobalTransactionSearch Component)

If specified, any transaction matching the ExcludeTransType will be excluded from the search results.

Syntax

__property String SearchExcludeTransType = { read=FSearchExcludeTransType, write=FSetSearchExcludeTransType };

Default Value

""

Remarks

If specified, any transaction matching the ExcludeTransType will be excluded from the search results. Valid values include:

Adjustment Excludes all tip adjustment transactions.
Authorization Excludes all previously-authorized (pre-auth) transactions.
BalanceInquiry Excludes all balance inquiry transactions.
Capture Excludes all captured transactions.
Credit Excludes all return transactions.
ForceCapture Excludes all force-auth transactions.
GetStatus to make an inquiry to an EBT cards balance.
PostAuth Excludes all post-auth transactions.
RepeatSale Excludes all repeat-sale transactions.
Reversal Excludes all reversal transactions.
Sale Excludes all sale transactions.
Void Excludes all void transactions.
You may set this to a comma separated list to exclude multiple transaction types. For instance, an SearchExcludeTransType of "Credit,Sale" will ignore all transactions with either Credit or Sale transaction types.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludeVoid Property (GlobalTransactionSearch Component)

Indicates whether or not to exclude void transactions from the search results.

Syntax

__property bool SearchExcludeVoid = { read=FSearchExcludeVoid, write=FSetSearchExcludeVoid };

Default Value

false

Remarks

Indicates whether or not to exclude void transactions from the search results.

Data Type

Boolean

SearchInvoiceNumber Property (GlobalTransactionSearch Component)

The InvoiceNumber that was included in the original transaction.

Syntax

__property String SearchInvoiceNumber = { read=FSearchInvoiceNumber, write=FSetSearchInvoiceNumber };

Default Value

""

Remarks

The InvoiceNumber that was included in the original transaction. If provided, only those transactions with matching InvoiceNumber will be included in the search results. Wildcards are allowed.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchNameOnCard Property (GlobalTransactionSearch Component)

Cardholder's name as it is appears on the card.

Syntax

__property String SearchNameOnCard = { read=FSearchNameOnCard, write=FSetSearchNameOnCard };

Default Value

""

Remarks

Cardholder's name as it is appears on the card. If specified, only those transactions with the matching cardholder's name will be included in the search result. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234".

Data Type

String

SearchPaymentType Property (GlobalTransactionSearch Component)

Only transactions matching the PaymentType will be included in the search results.

Syntax

__property String SearchPaymentType = { read=FSearchPaymentType, write=FSetSearchPaymentType };

Default Value

""

Remarks

Only transactions matching the PaymentType will be included in the search results. Valid values include:

Credit Retrieves Credit Card transactions.
Debit Retrieves Debit Card transactions.
EBT Retrieves EBT transactions.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchPNRef Property (GlobalTransactionSearch Component)

The unique payment reference number assigned to the transaction.

Syntax

__property String SearchPNRef = { read=FSearchPNRef, write=FSetSearchPNRef };

Default Value

""

Remarks

The unique payment reference number assigned to the transaction. If this property is provided all other search criteria fields will be ignored.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchRegisterNumber Property (GlobalTransactionSearch Component)

The RegisterNumber associated with the original transaction.

Syntax

__property String SearchRegisterNumber = { read=FSearchRegisterNumber, write=FSetSearchRegisterNumber };

Default Value

""

Remarks

The RegisterNumber associated with the original transaction. If specified, only transactions that were sent with the matching RegisterNumber will be returned in the response. This property may contain up to 10 alphanumeric characters.

Data Type

String

SearchResponseCode Property (GlobalTransactionSearch Component)

If specified, only those transactions with the matching response code will be included in the search results.

Syntax

__property String SearchResponseCode = { read=FSearchResponseCode, write=FSetSearchResponseCode };

Default Value

""

Remarks

If specified, only those transactions with the matching response code will be included in the search results. "0" indicates an approved transaction, anything else is a decline. Note that if you want all the declined transactions you should set SearchExcludeResponseCode to "0" (to exclude all approved transactions) instead.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchSettleDate Property (GlobalTransactionSearch Component)

The date of the settlement in MM/DD/YYYY or YYYY-MMDD format.

Syntax

__property String SearchSettleDate = { read=FSearchSettleDate, write=FSetSearchSettleDate };

Default Value

""

Remarks

The date of the settlement in MM/DD/YYYY or YYYY-MMDD format.

Data Type

String

SearchSettleFlag Property (GlobalTransactionSearch Component)

Indicates whether you wish to retrieve settled transactions or unsettled transactions.

Syntax

__property bool SearchSettleFlag = { read=FSearchSettleFlag, write=FSetSearchSettleFlag };

Default Value

false

Remarks

Indicates whether you wish to retrieve settled transactions or unsettled transactions. If set to true, only transactions that have been settled will be returned. If set to false (default), only transactions that have not been settled will be returned.

Data Type

Boolean

SearchSettleMessage Property (GlobalTransactionSearch Component)

The settlement ID or message returned from the host.

Syntax

__property String SearchSettleMessage = { read=FSearchSettleMessage, write=FSetSearchSettleMessage };

Default Value

""

Remarks

The settlement ID or message returned from the host. If specified, only transactions with a matching SettleMessage value will be returned.

Data Type

String

SearchTransactionAmount Property (GlobalTransactionSearch Component)

The original TransactionAmount of the transaction.

Syntax

__property String SearchTransactionAmount = { read=FSearchTransactionAmount, write=FSetSearchTransactionAmount };

Default Value

""

Remarks

The original TransactionAmount of the transaction. This may be 11 characters in DDDDDDDD.CC format, left-justified with no fill (eg: "1.99"). If specified, only transactions with a matching TransactionAmount will be returned.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchTransactionType Property (GlobalTransactionSearch Component)

If provided, only those transactions matching the TransactionType will be included.

Syntax

__property String SearchTransactionType = { read=FSearchTransactionType, write=FSetSearchTransactionType };

Default Value

""

Remarks

If provided, only those transactions matching the TransactionType will be included.

Valid values when SearchPaymentType is 0 (Credit) are:

1 Retrieves all Sale transactions.
2 Retrieves all Return transactions.
3 Retrieves all Reversal transactions.
4 Retrieves all Void transactions.
5 Retrieves all PreAuth transactions.
6 Retrieves all PostAuth/PreAuth transactions.
7 Retrieves all Force transactions.
9 Retrieves all Adjustment transactions.
10 Retrieves all AVSOnly transactions.
19 Retrieves all CardVerify transactions.

Valid values when SearchPaymentType is 1 (Debit) are:

1 Retrieves all Sale transactions.
2 Retrieves all Return transactions.

Valid values when SearchPaymentType is 2 (EBT) are:

11 Retrieves all CashBenefit transactions.
12 Retrieves all CashBenefitSale transactions.
You may combine set this to a comma separated list to specify multiple types. For instance, a SearchTransactionType of "1,2" will pull all transactions with either Sale or Return transaction types.

This property is not applicable for Transaction Summaries.

Data Type

String

SearchUserId Property (GlobalTransactionSearch Component)

The user who originated the transactions.

Syntax

__property String SearchUserId = { read=FSearchUserId, write=FSetSearchUserId };

Default Value

""

Remarks

The user who originated the transactions. If provided, only those transactions created by the matching User will be included in the search results. Wildcards are allowed.

Data Type

String

SearchResultCount Property (GlobalTransactionSearch Component)

The number of records in the SearchResult arrays.

Syntax

__property int SearchResultCount = { read=FSearchResultCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only and not available at design time.

Data Type

Integer

SearchResultApprovalCode Property (GlobalTransactionSearch Component)

Contains the transaction authorization code from the card issuer.

Syntax

__property String SearchResultApprovalCode[int SearchResultIndex] = { read=FSearchResultApprovalCode };

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

For approved transaction responses (SearchResultCode 0 or 200) the Global Transport Gateway sends a 6-character approval code in the SearchResultApprovalCode property and a human-readable approval message in the SearchResultMessage property. In the case of a decline, the SearchResultApprovalCode will contain an error message. Your application should display the SearchResultApprovalCode as part of the approval message for an approved transaction. For declined responses, the SearchResultHostCode property will contain an additional code that provides detail on the reason for the decline.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultAuthorizedAmount Property (GlobalTransactionSearch Component)

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

Syntax

__property String SearchResultAuthorizedAmount[int SearchResultIndex] = { read=FSearchResultAuthorizedAmount };

Default Value

""

Remarks

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the SearchResultCode will contain "200", the SearchResultMessage will contain "Partial Approval", and the SearchResultMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the SearchResultAuthorizedAmount will contain the amount of the transaction that was authorized, and the SearchResultBalanceDue property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultAVSResultCode Property (GlobalTransactionSearch Component)

Contains the address verification result code from the card issuer.

Syntax

__property String SearchResultAVSResultCode[int SearchResultIndex] = { read=FSearchResultAVSResultCode };

Default Value

""

Remarks

Contains the address verification result code from the card issuer.

When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted SearchResultAVSResultMessage describing the result. The following table lists the possible AVS result codes:

X Exact: Address and nine-digit Zip match.
Y Yes: Address and five-digit Zip match.
A Address: Address matches, Zip does not.
Z 5-digit Zip: 5-digit Zip matches, address doesn't.
W Whole Zip: 9-digit Zip matches, address doesn't.
N No: Neither address nor Zip matches.
U Unavailable: Address information not available.
G Unavailable: Address information not available for international transaction.
R Retry: System unavailable or time-out.
E Error: Transaction unintelligible for AVS or edit error found in the message that prevents AVS from being performed.
S Not Supported: Issuer doesn't support AVS service.
B * Street Match: Street addresses match for international transaction, but postal code doesn't.
C * Street Address: Street addresses and postal code not verified for international transaction.
D * Match: Street addresses and postal codes match for international transaction.
I * Not Verified: Address Information not verified for International transaction.
M * Match: Street addresses and postal codes match for international transaction.
P * Postal Match: Postal codes match for international transaction, but street address doesn't.
0 ** No response sent.
5 Invalid AVS response.

* These values are Visa specific.

** These values are returned by the Global Transport Gateway and not the issuing bank.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultBatchNumber Property (GlobalTransactionSearch Component)

The number of the batch this transaction is currently contained in.

Syntax

__property String SearchResultBatchNumber[int SearchResultIndex] = { read=FSearchResultBatchNumber };

Default Value

""

Remarks

The number of the batch this transaction is currently contained in. If this is a reply to an AuthOnly transaction, the SearchResultBatchNumber property will be blank, as auth-onlys are not added to the open batch until a Capture is performed.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCardExpDate Property (GlobalTransactionSearch Component)

Contains the credit card expiration date.

Syntax

__property String SearchResultCardExpDate[int SearchResultIndex] = { read=FSearchResultCardExpDate };

Default Value

""

Remarks

Contains the credit card expiration date. Typically returned in MMYY format, but may contain up to a 10-character date string.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCardNumber Property (GlobalTransactionSearch Component)

Contains the credit card number used in the transaction.

Syntax

__property String SearchResultCardNumber[int SearchResultIndex] = { read=FSearchResultCardNumber };

Default Value

""

Remarks

Contains the credit card number used in the transaction. This property will be masked out with asterisk (*) characters except for the last four digits.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCardPresent Property (GlobalTransactionSearch Component)

Indicates whether or not this was a card-present transaction.

Syntax

__property bool SearchResultCardPresent[int SearchResultIndex] = { read=FSearchResultCardPresent };

Default Value

false

Remarks

Indicates whether or not this was a card-present transaction.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SearchResultCardType Property (GlobalTransactionSearch Component)

Indicates the card type or payment method.

Syntax

__property String SearchResultCardType[int SearchResultIndex] = { read=FSearchResultCardType };

Default Value

""

Remarks

Indicates the card type or payment method.

For credit card transactions, this property will contain the name of the credit card type. For instance, "VISA", "MASTERCARD", "AMEX", etc. For Debit or Electronic Benefit transactions, this property will contain "DEBIT" or "EBT".

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCashBackAmount Property (GlobalTransactionSearch Component)

Contains the cash back amount for a debit or EBT transaction.

Syntax

__property String SearchResultCashBackAmount[int SearchResultIndex] = { read=FSearchResultCashBackAmount };

Default Value

""

Remarks

Contains the cash back amount for a debit or EBT transaction.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultClientIP Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultClientIP[int SearchResultIndex] = { read=FSearchResultClientIP };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the IP address of the client machine from which the transaction was processed.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCustomerId Property (GlobalTransactionSearch Component)

Identifies the customer that initiated the transaction.

Syntax

__property String SearchResultCustomerId[int SearchResultIndex] = { read=FSearchResultCustomerId };

Default Value

""

Remarks

Identifies the customer that initiated the transaction. This property will only contain data if the merchant has assigned identification numbers to customers.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCustomerStreet Property (GlobalTransactionSearch Component)

Contains the billing street address of the credit card.

Syntax

__property String SearchResultCustomerStreet[int SearchResultIndex] = { read=FSearchResultCustomerStreet };

Default Value

""

Remarks

Contains the billing street address of the credit card.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCustomerZip Property (GlobalTransactionSearch Component)

Contains the billing zip code of the credit card.

Syntax

__property String SearchResultCustomerZip[int SearchResultIndex] = { read=FSearchResultCustomerZip };

Default Value

""

Remarks

Contains the billing zip code of the credit card.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultCVVResultCode Property (GlobalTransactionSearch Component)

Contains the card verification result code from the card issuer.

Syntax

__property String SearchResultCVVResultCode[int SearchResultIndex] = { read=FSearchResultCVVResultCode };

Default Value

""

Remarks

Contains the card verification result code from the card issuer.

This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result, contained in the SearchResultCVVResultMessage property.

The following table lists the possible result codes for this property:

Value Description
M CVV2/CVC2/CID Match
N CVV2/CVC2/CID No Match
P Not Processed
S Issuer indicates that the CV data should be present on the card, but the merchant has indicated that the CV data is not present on the card.
U Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard with the
CV encryption keys.
X Server Provider did not respond

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultEntryMode Property (GlobalTransactionSearch Component)

Indicates whether the card was swiped or manually keyed.

Syntax

__property TibcGlobalTransactionSearchSearchResultEntryModes SearchResultEntryMode[int SearchResultIndex] = { read=FSearchResultEntryMode };
enum TibcGlobalTransactionSearchSearchResultEntryModes { emNotSpecified=0, emManualEntry=1, emSwipedEntry=2 };

Default Value

emNotSpecified

Remarks

Indicates whether the card was swiped or manually keyed. Possible values are:

emNotSpecified (0) No entry mode was specified.
emManualEntry (1) The card was manually keyed.
emSwipedEntry (2) The magnetic strip from the card was read.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SearchResultError Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultError[int SearchResultIndex] = { read=FSearchResultError };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains an error message when a problem occurred during transaction processing.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultGratuityAmount Property (GlobalTransactionSearch Component)

Contains the tip portion of the TotalAmount .

Syntax

__property String SearchResultGratuityAmount[int SearchResultIndex] = { read=FSearchResultGratuityAmount };

Default Value

""

Remarks

Contains the tip portion of the SearchResultTotalAmount. This is not applicable to all industries and transaction types.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultHostCode Property (GlobalTransactionSearch Component)

Action code returned by Global Payments.

Syntax

__property String SearchResultHostCode[int SearchResultIndex] = { read=FSearchResultHostCode };

Default Value

""

Remarks

Action code returned by Global Payments.

Typically, if the transaction is approved, this will be the batch reference number. If the transaction is declined, the SearchResultHostCode will indicate the reason for the decline. The table below lists the possible SearchResultHostCode and SearchResultMessage combinations for error conditions.

SearchResultHostCodeSearchResultMessageDescription
000AP Approved or Completed Successfully.
000AP NEW INFO Approved with updated cardholder data.
000PARTIAL AP Only part of the requested amount was approved.
001CALL AE Refer to American Express.
001CALL DC Refer to Diners Club.
001CALL DISCOVER Refer to Discover.
001CALL ND Call your Visa/MasterCard Voice Authorization Center.
001CALL TK Refer to TeleCheck.
001CALL XXXXXXXXXX Call indicated number.
001ISSUER UNAVAIL Global Payments cannot contact issuing bank for authorization.
002CALL AE Touchtone capture, won't roll to an operator.
002CALL DC Touchtone capture, won't roll to an operator.
002CALL DISCOVER Touchtone capture, won't roll to an operator.
002CALL ND Touchtone capture, won't roll to an operator.
002CALL XXXXXXXXXX Touchtone capture, won't roll to an operator.
002ISSUER UNAVAIL Touchtone capture, won't roll to an operator.
003INVLD MERCH ID Invalid Merchant ID.
004PIC UP Authorization Declined.
005DECLINE Authorization Declined.
005DECLINE NEW INFO Update cardholder data.
005DECLINE TRY LATER Try again in 3 days.
005REVK PAY ORDERED Stop payment of a specific recurring payment.
005STOP PAY ORDERED Stop all future recurring payments.
006REVERSED Requested transaction reversal was successful.
007DECLINE-CV2 FAIL Response for CVV2 failure. Declined. (Visa).
008AP WITH ID Approved with positive ID. Host does not capture this transaction.
012INVLD TRAN CODE Processing code entered is incorrect. Please refer to valid processing code.
013INVLD AMOUNT Amount entered is invalid.
014INVLD ACCT Account number does not pass issuer's edit checks.
014INVLD CODE ACCT Valid account number matched with a transaction code for a different card type.
014INVLD CID American Express CID failure.
019PLEASE RETRY Retry the transaction.
054INVLD EXP DATE Expiration date entered is incorrect.
055PIN INVALID Incorrect PIN entered.
058UNAUTH TRANS Merchant not set up for transaction code used.
075MAX PIN RETRIES Maximum PIN number entry attempts exceeded.
094AP DUPE Transaction entered is a duplicate.
0C1SYSTEM UNAVAILABLE Global Payments Check System unavailable.
0N2INV AMT MATCH The amount entered for a void or adjustment transaction does not match the amount stored in the host for that item.
0N3INV ITEM NUM The item number entered for a void or adjustment transaction is incorrect.
0N4ITEM VOIDED An adjustment or item review was attempted on a transaction previously voided.
0N5MUST BALANCE NOW Terminal has not been balanced within time specified in the Global Payments Merchant Master File for this merchant.
0N6USE DUP THEN BAL Originating device has not been balanced within time specified in the Global Payments Merchant Master File for this merchant, but merchant is set up to perform extra transactions before balancing.
0N7NO DUP FOUND Override transaction is attempted on a non-duplicated transaction.
0N8INVALID DATA Format of the transaction is incorrect.
0NANO TRANS FOUND Reversal transaction is attempted on a transaction that is not in the open batch on the host.
0NCAP NOT CAPTURED Approved but not captured (applies only to credit card transactions)- stand in.
0NEAP AUTH-ONLY Approved but this EDC merchant is not set up to capture this card type (applies only to credit card transactions).
PART AP AUTH-ONLY Only part of the requested amount was approved, but this EDC merchant is not set up to capture this card type (applies only to credit card transactions).
0P1APPROVED Approved debit card transaction.
0P2DB UNAVAIL 02 Global Payments is experiencing a problem.
0P5UNAUTH USER Merchant is not set up for debit on Global Payments Merchant Master File.
0P6INVALID CARD Invalid card number.
0T1EDC UNAVAILABLE EDC application down, try later.
0T2DB UNAVAIL 01 Debit application down, try later.
121EXCEEDS MAX AMT Exceeds withdrawal amount limit.
121EXCEEDS MAX AMT Exceeds withdrawal amount limit.

IMPORTANT: When programmatically validating a transaction's result, the SearchResultCode value should ALWAYS be used instead of any other response messages describing the result. For example, do not use SearchResultHostCode, SearchResultMessage, SearchResultMessageDetail, or any other responses, as these values may vary. This tables is included for informational purposes only.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultInvoiceNumber Property (GlobalTransactionSearch Component)

Contains the transactions invoice number.

Syntax

__property String SearchResultInvoiceNumber[int SearchResultIndex] = { read=FSearchResultInvoiceNumber };

Default Value

""

Remarks

Contains the transactions invoice number.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultLastModified Property (GlobalTransactionSearch Component)

Contains the date and time on which the transaction was last modified.

Syntax

__property String SearchResultLastModified[int SearchResultIndex] = { read=FSearchResultLastModified };

Default Value

""

Remarks

Contains the date and time on which the transaction was last modified.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultNameOnCard Property (GlobalTransactionSearch Component)

Contains the cardholder's name.

Syntax

__property String SearchResultNameOnCard[int SearchResultIndex] = { read=FSearchResultNameOnCard };

Default Value

""

Remarks

Contains the cardholder's name. If no name was specified in the NameOnCard property when the transaction was first authorized, this property will not be returned in a search.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultOriginalPNRef Property (GlobalTransactionSearch Component)

Contains the Global Transport Gateway PNRef on which the current transaction is based.

Syntax

__property String SearchResultOriginalPNRef[int SearchResultIndex] = { read=FSearchResultOriginalPNRef };

Default Value

""

Remarks

Contains the Global Transport Gateway PNRef on which the current transaction is based.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultPaymentType Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultPaymentType[int SearchResultIndex] = { read=FSearchResultPaymentType };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the payment type of this transaction. For instance, "MasterCard", "Visa", "DEBIT", etc.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultPNRef Property (GlobalTransactionSearch Component)

Contains a number which uniquely identifies the transaction in the Global Transport system.

Syntax

__property String SearchResultPNRef[int SearchResultIndex] = { read=FSearchResultPNRef };

Default Value

""

Remarks

Contains a number which uniquely identifies the transaction in the Global Transport system.

This value should be stored by the POS to enable the processing transactions based on a previous transaction. For instance, Capture, Void, Refund, TipAdjustment, etc.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultProcessorId Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultProcessorId[int SearchResultIndex] = { read=FSearchResultProcessorId };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the name of the processing platform.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultRegisterNumber Property (GlobalTransactionSearch Component)

A number that uniquely identifies the register or computer on which the transaction was performed.

Syntax

__property String SearchResultRegisterNumber[int SearchResultIndex] = { read=FSearchResultRegisterNumber };

Default Value

""

Remarks

A number that uniquely identifies the register or computer on which the transaction was performed. If the RegisterNumber was not sent in the authorization, this property will be empty.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultResellerKey Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultResellerKey[int SearchResultIndex] = { read=FSearchResultResellerKey };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the primary key of the Reseller table.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultResponseCode Property (GlobalTransactionSearch Component)

Contains the transaction result code from the Global Transport Gateway.

Syntax

__property String SearchResultResponseCode[int SearchResultIndex] = { read=FSearchResultResponseCode };

Default Value

""

Remarks

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, decline, etc.) When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.

-100Transaction NOT Processed; Generic Host Error.
0Approved.
2Invalid Transaction.
3Invalid Transaction Type.
3Unsupported Transaction Type.
4Invalid Amount.
4Invalid Cash Back Amount.
5Invalid Merchant Information.
6Time Out Waiting for Host Response.
7Field Format Error. See SearchResultMessage and SearchResultMessageDetail for more info.
7Swiped and Card Present transactions are not supported in Card Not Present markets.
8Not a Transaction Server.
11Client Timeout Waiting for Response.
12Decline ITEM VOIDED PREAUTH VOIDED.
14Transaction Type Not Supported In This Version.
19Original Transaction Id, PNRef, or Approval Code Not Found.
20Customer Reference Number Not Found.
22Invalid ABA Number.
23Invalid Account Number.
24Invalid Expiration Date.
25Transaction Type Not Supported by Host.
26Invalid Reference Number or PNRef.
27Invalid Receipt Information.
28Invalid Check Holder Name.
29Invalid Check Number.
30Check DL Verification Requires DL State.
31Cannot perform multiple captures on a PreAuth.
40Not Currently Supported.
50Insufficient Funds Available.
99General Error.
100Invalid Transaction Returned from Host.
101Timeout Value too Small or Invalid Time Out Value.
102Processor Not Available.
103Error Reading Response from Host.
104Timeout waiting for Processor Response.
105Credit Error.
106Host Not Available.
107Duplicate Suppression Timeout.
108Void Error/Cannot void a previously voided or settled transaction.
109Timeout Waiting for Host Response.
110Duplicate Transaction.
111Capture Error.
112Failed AVS Check.
113Cannot Exceed Sales Cap / Requested Refund Exceeds Available Refund Amount.
114Cannot refund a voided transaction.
115Sum of Tax, Tip, and Cash Back amount cannot exceed total Amount.
116Unsupported Card Type.
117Only Sales, Repeat Sales, Force Captures, and Post Authorizations can be refunded.
118The amount of a Pre-Auth Complete (Capture) must be less than or equal to the original amount authorized. Please retry.
200A Partial Authorization of a pre-paid card. This is considered an Approved transaction. Check the SearchResultAuthorizedAmount property for the amount approved. See below for more information.
1000Generic Host Error or General Exception. (Missing or invalid data). See SearchResultMessage and SearchResultMessageDetail for more info.
1001Invalid Login Information.
1002Insufficient Privilege or Invalid Amount.
1002AVS Only transactions are not supported in E-Commerce markets.
1002Debit/EBT Return transactions must provide the PNRef from the original Sale. Please retry.
1002Zip is required for AVS Only transaction type.
1003Invalid Login Blocked.
1004Invalid Login Deactivated.
1005Transaction Type or Service Not Allowed.
1006Unsupported Processor.
1007Invalid Request Message.
1008Invalid Version / The MAC value is required.
1010Payment Type Not Supported.
1011Error Starting Transaction.
1012Error Finishing Transaction.
1013Error Checking Duplicate.
1014No Records To Settle (in the current batch).
1015No Records To Process (in the current batch).

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultResponseMessage Property (GlobalTransactionSearch Component)

Contains a human-readable response message concerning the transaction.

Syntax

__property String SearchResultResponseMessage[int SearchResultIndex] = { read=FSearchResultResponseMessage };

Default Value

""

Remarks

Contains a human-readable response message concerning the transaction.

This value is typically either "Approved" or "Declined", but may also contain a description of any error condition.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultSettleDate Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultSettleDate[int SearchResultIndex] = { read=FSearchResultSettleDate };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the date on which the transaction was settled. This date property is in the format "YYYY-MM-DD HH:MM:SS"

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultSettleFlag Property (GlobalTransactionSearch Component)

Indicates whether or not the transaction has been settled.

Syntax

__property bool SearchResultSettleFlag[int SearchResultIndex] = { read=FSearchResultSettleFlag };

Default Value

false

Remarks

Indicates whether or not the transaction has been settled.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SearchResultTotalAmount Property (GlobalTransactionSearch Component)

Contains the total amount of the transaction.

Syntax

__property String SearchResultTotalAmount[int SearchResultIndex] = { read=FSearchResultTotalAmount };

Default Value

""

Remarks

Contains the total amount of the transaction. This value reflects the SearchResultAuthorizedAmount plus any SearchResultGratuityAmount, less any refunded amount. This amount also may be different from the SearchResultAuthorizedAmount in the case of an AuthOnly transaction followed by a Capture transaction for a different amount.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultTransactionDate Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultTransactionDate[int SearchResultIndex] = { read=FSearchResultTransactionDate };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the date on which the transaction was first made. This date property is in the format "YYYY-MM-DD HH:MM:SS"

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultTransactionId Property (GlobalTransactionSearch Component)

Card issuer's Transaction Reference Number.

Syntax

__property String SearchResultTransactionId[int SearchResultIndex] = { read=FSearchResultTransactionId };

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet Reference Number, American Express Transaction Id, or Discover STAN Id. If returned in the response, this property must be printed on the receipt. Note that this SearchResultTransactionId is not used by Global Payments to reference the transaction. The SearchResultPNRef property is used to track and modify transactions made on the Global Payments system.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultTransactionKey Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SearchResultTransactionKey[int SearchResultIndex] = { read=FSearchResultTransactionKey };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the Global Transport Gateway primary key of the transaction. This is also known as the Card Info Key.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultTransactionType Property (GlobalTransactionSearch Component)

Contains the transaction type.

Syntax

__property String SearchResultTransactionType[int SearchResultIndex] = { read=FSearchResultTransactionType };

Default Value

""

Remarks

Contains the transaction type. For example, "Sale", "Credit", "Void", etc.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultUserId Property (GlobalTransactionSearch Component)

Contains the username used to process the transaction.

Syntax

__property String SearchResultUserId[int SearchResultIndex] = { read=FSearchResultUserId };

Default Value

""

Remarks

Contains the username used to process the transaction.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultVendorNumber Property (GlobalTransactionSearch Component)

Contains a number which uniquely identifies a merchant.

Syntax

__property String SearchResultVendorNumber[int SearchResultIndex] = { read=FSearchResultVendorNumber };

Default Value

""

Remarks

Contains a number which uniquely identifies a merchant. This is also known as the RPNum.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

String

SearchResultVoidFlag Property (GlobalTransactionSearch Component)

Indicates whether or not the transaction has been voided.

Syntax

__property bool SearchResultVoidFlag[int SearchResultIndex] = { read=FSearchResultVoidFlag };

Default Value

false

Remarks

Indicates whether or not the transaction has been voided.

The SearchResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SearchResultCount property.

This property is read-only and not available at design time.

Data Type

Boolean

Server Property (GlobalTransactionSearch Component)

Global Payments transaction server.

Syntax

__property String Server = { read=FServer, write=FSetServer };

Default Value

"https://api.globalpay.com"

Remarks

This is the server to which all transactions are sent. The live URL for Global Payments is "https://api.globalpay.com". For testing and certification purposes you may set this to the test server located at "https://certapia.globalpay.com" instead.

Data Type

String

SSLAcceptServerCertEncoded Property (GlobalTransactionSearch Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (GlobalTransactionSearch Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (GlobalTransactionSearch Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property 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.

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

Data Type

Byte Array

SSLCertStorePassword Property (GlobalTransactionSearch Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (GlobalTransactionSearch Component)

This is the type of certificate store for this certificate.

Syntax

__property TibcGlobalTransactionSearchSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TibcGlobalTransactionSearchSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

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

Note: This store type is not available in Java.

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

Note: This store type is not available in Java.

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

Note: This store type is only available in Java.

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

Note: this store type is only available in Java.

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

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

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

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

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

To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword 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.

Data Type

Integer

SSLCertSubject Property (GlobalTransactionSearch Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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.

Data Type

String

SSLProvider Property (GlobalTransactionSearch Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TibcGlobalTransactionSearchSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };
enum TibcGlobalTransactionSearchSSLProviders { sslpAutomatic=0, sslpPlatform=1, sslpInternal=2 };

Default Value

sslpAutomatic

Remarks

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

Possible values are:

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

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

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

Data Type

Integer

SSLServerCertEncoded Property (GlobalTransactionSearch Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

SummaryCount Property (GlobalTransactionSearch Component)

The number of records in the SummaryResult arrays.

Syntax

__property int SummaryCount = { read=FSummaryCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultAuthorizationAmount Property (GlobalTransactionSearch Component)

Contains the dollar amount authorized for all transactions for the indicated PaymentType .

Syntax

__property String SummaryResultAuthorizationAmount[int SummaryIndex] = { read=FSummaryResultAuthorizationAmount };

Default Value

""

Remarks

Contains the dollar amount authorized for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultAuthorizationCount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultAuthorizationCount[int SummaryIndex] = { read=FSummaryResultAuthorizationCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Authorization-only transactions for the indicated SummaryResultPaymentType. Auth-only transactions are also known as preauth transactions.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultCaptureAmount Property (GlobalTransactionSearch Component)

Contains the dollar amount captured for all transactions for the indicated PaymentType .

Syntax

__property String SummaryResultCaptureAmount[int SummaryIndex] = { read=FSummaryResultCaptureAmount };

Default Value

""

Remarks

Contains the dollar amount captured for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultCaptureCount Property (GlobalTransactionSearch Component)

Contains the transaction count of all transactions that have been settled for the indicated PaymentType .

Syntax

__property int SummaryResultCaptureCount[int SummaryIndex] = { read=FSummaryResultCaptureCount };

Default Value

0

Remarks

Contains the transaction count of all transactions that have been settled for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultForceCaptureAmount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultForceCaptureAmount[int SummaryIndex] = { read=FSummaryResultForceCaptureAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultForceCaptureCount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultForceCaptureCount[int SummaryIndex] = { read=FSummaryResultForceCaptureCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultPaymentType Property (GlobalTransactionSearch Component)

The type of transactions being summarized.

Syntax

__property String SummaryResultPaymentType[int SummaryIndex] = { read=FSummaryResultPaymentType };

Default Value

""

Remarks

The type of transactions being summarized.

This field varies based on the value specified via SearchCriteriaCardBreakdown. When set to 'False', PaymentType will be set to transaction type returned in the response such as "Sale", "Return", "Force", etc.

When set to 'True', PaymentType will be set to the card and transaction type returned in the response and separated by " - " such as "VISA - Force", "MasterCard - Return", "Discover - Sale", etc.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultPostAuthAmount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultPostAuthAmount[int SummaryIndex] = { read=FSummaryResultPostAuthAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultPostAuthCount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultPostAuthCount[int SummaryIndex] = { read=FSummaryResultPostAuthCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultRefundAmount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultRefundAmount[int SummaryIndex] = { read=FSummaryResultRefundAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultRefundCount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultRefundCount[int SummaryIndex] = { read=FSummaryResultRefundCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultRepeatSaleAmount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultRepeatSaleAmount[int SummaryIndex] = { read=FSummaryResultRepeatSaleAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultRepeatSaleCount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultRepeatSaleCount[int SummaryIndex] = { read=FSummaryResultRepeatSaleCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultSaleAmount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultSaleAmount[int SummaryIndex] = { read=FSummaryResultSaleAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultSaleCount Property (GlobalTransactionSearch Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultSaleCount[int SummaryIndex] = { read=FSummaryResultSaleCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultTotalCount Property (GlobalTransactionSearch Component)

Contains the total count of all transactions for the indicated PaymentType .

Syntax

__property int SummaryResultTotalCount[int SummaryIndex] = { read=FSummaryResultTotalCount };

Default Value

0

Remarks

Contains the total count of all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryCount property.

This property is read-only and not available at design time.

Data Type

Integer

Timeout Property (GlobalTransactionSearch Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (GlobalTransactionSearch Component)

UserId for authentication with the Global Payments Server .

Syntax

__property String UserId = { read=FUserId, write=FSetUserId };

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (GlobalTransactionSearch Component)

The merchant's RP/Vendor number.

Syntax

__property String VendorNumber = { read=FVendorNumber, write=FSetVendorNumber };

Default Value

""

Remarks

The Vendor number is also known as the "RP Number" or "RPNum", and is required for search and summary transactions. If you do not know your Vendor/RPNum you may log into your Global Payments virtual terminal, or simply use the GlobalBatchMgr component's CheckSetup method to find it.

Data Type

String

Config Method (GlobalTransactionSearch Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

GetTransactionSummary Method (GlobalTransactionSearch Component)

Retrieves a payment type transaction summary that matches the specified SearchCriteria .

Syntax

void __fastcall GetTransactionSummary();

Remarks

This method retrieves information about all of the past transactions which are currently stored on the Global Payments servers. These results are stored in the SummaryResults collection.

The SearchBeginDate and SearchEndDate are required for transaction summaries, but only the following subset of SearchCriteria properties may be used to restrict the results:

Interrupt Method (GlobalTransactionSearch Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

Reset Method (GlobalTransactionSearch Component)

Clears all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

This method clears all properties to their default values.

Search Method (GlobalTransactionSearch Component)

Retrieves a list of payments that match the specified SearchCriteria .

Syntax

void __fastcall Search();

Remarks

This method performs a search of the Global Payments system, and looks for transactions that match your specified SearchCriteria. All search criteria properties are optional. To retrieve information for one particular transaction, set the SearchPNRef property. All other properties will be ignored if the SearchPNRef property is set. The results of your search will be contained in the SearchResults collection.

Error Event (GlobalTransactionSearch Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibcGlobalTransactionSearchErrorEventParams;
typedef void __fastcall (__closure *TibcGlobalTransactionSearchErrorEvent)(System::TObject* Sender, TibcGlobalTransactionSearchErrorEventParams *e);
__property TibcGlobalTransactionSearchErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter 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 (GlobalTransactionSearch Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibcGlobalTransactionSearchSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibcGlobalTransactionSearchSSLServerAuthenticationEvent)(System::TObject* Sender, TibcGlobalTransactionSearchSSLServerAuthenticationEventParams *e);
__property TibcGlobalTransactionSearchSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (GlobalTransactionSearch Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibcGlobalTransactionSearchSSLStatusEventParams;
typedef void __fastcall (__closure *TibcGlobalTransactionSearchSSLStatusEvent)(System::TObject* Sender, TibcGlobalTransactionSearchSSLStatusEventParams *e);
__property TibcGlobalTransactionSearchSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Status Event (GlobalTransactionSearch Component)

Shows the progress of the Global Payments connection.

Syntax

typedef struct {
  String Message;
} TibcGlobalTransactionSearchStatusEventParams;
typedef void __fastcall (__closure *TibcGlobalTransactionSearchStatusEvent)(System::TObject* Sender, TibcGlobalTransactionSearchStatusEventParams *e);
__property TibcGlobalTransactionSearchStatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

Remarks

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

Config Settings (GlobalTransactionSearch Component)

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

GlobalTransactionSearch Config Settings

RawRequest:   Returns the request sent to the server for debugging purposes.

After an operation this setting may be queried to return the request as it was sent to the server. This is useful for debugging purposes.

RawResponse:   Returns the response received from the server for debugging purposes.

After an operation this setting may be queried to return the response as it was received from the server. This is useful for debugging purposes.

SearchCriteriaBatchNumber:   Filters a Search or TransactionSummary based on the BatchNumber.

This field is used to filter Search or GetTransactionSummary results by the BatchNumber.

SearchCriteriaCardBreakdown:   Identifies whether to breakdown Transaction Summaries by card type.

This field is used by GetTransactionSummary. When set to 'True', the summary results will be broken down by card and transaction type. When set to 'False' (default value), the results will just be broken down by transaction type.

SearchCriteriaCustomerId:   Filters a Search based on the CustomerId.

This field is used to filter Search results by the CustomerId.

SearchCriteriaIncludeCustomFields:   Identifies whether to include custom fields in the Search results.

This field is used to specify whether Search results will contain custom fields. The default value is 'False'.

SearchCriteriaPONumber:   Filters a Search based on the PONumber.

This field is used to filter Search results by the PONumber.

TCPClient Config Settings

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 component will use Timeout for establishing a connection and transmitting/receiving data.

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

This configuration setting is provided for use by components 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 components that do not directly expose Firewall properties.

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 component raises an exception.

Note: This setting is provided for use by components 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 components 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 components 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 component raises an exception.

Note: This setting is provided for use by components 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 component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

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

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 component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

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

This must be set before a connection is attempted. It instructs the component 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 component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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

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.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

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 component will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component 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 component raises an exception.

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

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

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

This setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the OCSP URL from the server certificate's OCSP extension. The component 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 component raises an exception.

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

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

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.

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 component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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 component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

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.

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

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

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

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

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

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 component will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the component raises an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

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 component 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 component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

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

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component 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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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

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

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (GlobalTransactionSearch Component)

GlobalTransactionSearch Errors

432   Invalid index.
501   Invalid length for this property.
502   Invalid data format for this property.
503   Value is out of range.
504   Credit card digit check failed.
505   Card date invalid.
506   Card expired.
519   Corrupt response.
520   Response payload empty.
526   Invalid timeout value.
593   A property required for this transaction is missing.
529   Error in XML response.
533   Internal error constructing payload.

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

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

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

TCPClient Errors

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

SSL Errors

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

TCP/IP Errors

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