GlobalTransactionSearch Class

Properties Methods Events Config Settings Errors

The GlobalTransactionSearch class 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

GlobalTransactionSearch

Remarks

This class 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 BeginDate and EndDate fields. All other search criteria fields are optional. However, if you wish to retrieve information for one particular transaction, set the PNRef field instead. All other fields will be ignored if the PNRef field is set. The results of your search will be contained in the SearchResults collection.

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

Property List

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


Password	Password for authentication with the Global Payments Server .
Proxy	A set of properties related to proxy access.
SearchCriteria	Specifies criteria to filter the transaction search.
SearchResults	Contains a collection of transactions that matched the SearchCriteria .
Server	Global Payments transaction server.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
SummaryResults	Contains summary results for all payment types.
Timeout	The timeout for the class.
UserId	UserId for authentication with the Global Payments Server .
VendorNumber	The merchant's RP/Vendor number.

Method List

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


Config	Sets or retrieves a configuration setting.
GetTransactionSummary	Retrieves a payment type transaction summary that matches the specified SearchCriteria .
Interrupt	This method interrupts the current method.
Reset	Clears all properties to their default values.
Search	Retrieves a list of payments that match the specified SearchCriteria .

Event List

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


Error	Fired when information is available about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
Status	Shows the progress of the Global Payments connection.

Config Settings

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


RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
SearchCriteriaBatchNumber	Filters a Search or TransactionSummary based on the BatchNumber.
SearchCriteriaCardBreakdown	Identifies whether to breakdown Transaction Summaries by card type.
SearchCriteriaCustomerId	Filters a Search based on the CustomerId.
SearchCriteriaIncludeCustomFields	Identifies whether to include custom fields in the Search results.
SearchCriteriaPONumber	Filters a Search based on the PONumber.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Password Property (GlobalTransactionSearch Class)

Password for authentication with the Global Payments Server .

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* dpaymentssdk_globaltransactionsearch_getpassword(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

Proxy Property (GlobalTransactionSearch Class)

A set of properties related to proxy access.

Syntax

DPaymentsSDKProxy* GetProxy();
int SetProxy(DPaymentsSDKProxy* val);

int dpaymentssdk_globaltransactionsearch_getproxyauthscheme(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int dpaymentssdk_globaltransactionsearch_getproxyautodetect(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* dpaymentssdk_globaltransactionsearch_getproxypassword(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int dpaymentssdk_globaltransactionsearch_getproxyport(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxyport(void* lpObj, int iProxyPort);

char* dpaymentssdk_globaltransactionsearch_getproxyserver(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxyserver(void* lpObj, const char* lpszProxyServer);

int dpaymentssdk_globaltransactionsearch_getproxyssl(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxyssl(void* lpObj, int iProxySSL);

char* dpaymentssdk_globaltransactionsearch_getproxyuser(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

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

Data Type

DPaymentsSDKProxy

SearchCriteria Property (GlobalTransactionSearch Class)

Specifies criteria to filter the transaction search.

Syntax

DPaymentsSDKGlobalTransSearchCriteria* GetSearchCriteria();
int SetSearchCriteria(DPaymentsSDKGlobalTransSearchCriteria* val);

char* dpaymentssdk_globaltransactionsearch_getsearchapprovalcode(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchapprovalcode(void* lpObj, const char* lpszSearchApprovalCode);

char* dpaymentssdk_globaltransactionsearch_getsearchbegindate(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchbegindate(void* lpObj, const char* lpszSearchBeginDate);

char* dpaymentssdk_globaltransactionsearch_getsearchcardnumber(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchcardnumber(void* lpObj, const char* lpszSearchCardNumber);

char* dpaymentssdk_globaltransactionsearch_getsearchcardtype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchcardtype(void* lpObj, const char* lpszSearchCardType);

char* dpaymentssdk_globaltransactionsearch_getsearchcustomerid(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchcustomerid(void* lpObj, const char* lpszSearchCustomerId);

char* dpaymentssdk_globaltransactionsearch_getsearchenddate(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchenddate(void* lpObj, const char* lpszSearchEndDate);

char* dpaymentssdk_globaltransactionsearch_getsearchexcludecardtype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchexcludecardtype(void* lpObj, const char* lpszSearchExcludeCardType);

char* dpaymentssdk_globaltransactionsearch_getsearchexcludepaymenttype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchexcludepaymenttype(void* lpObj, const char* lpszSearchExcludePaymentType);

char* dpaymentssdk_globaltransactionsearch_getsearchexcluderesponsecode(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchexcluderesponsecode(void* lpObj, const char* lpszSearchExcludeResponseCode);

char* dpaymentssdk_globaltransactionsearch_getsearchexcludetranstype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchexcludetranstype(void* lpObj, const char* lpszSearchExcludeTransType);

int dpaymentssdk_globaltransactionsearch_getsearchexcludevoid(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchexcludevoid(void* lpObj, int bSearchExcludeVoid);

char* dpaymentssdk_globaltransactionsearch_getsearchinvoicenumber(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchinvoicenumber(void* lpObj, const char* lpszSearchInvoiceNumber);

char* dpaymentssdk_globaltransactionsearch_getsearchnameoncard(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchnameoncard(void* lpObj, const char* lpszSearchNameOnCard);

char* dpaymentssdk_globaltransactionsearch_getsearchpaymenttype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchpaymenttype(void* lpObj, const char* lpszSearchPaymentType);

char* dpaymentssdk_globaltransactionsearch_getsearchpnref(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchpnref(void* lpObj, const char* lpszSearchPNRef);

char* dpaymentssdk_globaltransactionsearch_getsearchregisternumber(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchregisternumber(void* lpObj, const char* lpszSearchRegisterNumber);

char* dpaymentssdk_globaltransactionsearch_getsearchresponsecode(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchresponsecode(void* lpObj, const char* lpszSearchResponseCode);

char* dpaymentssdk_globaltransactionsearch_getsearchsettledate(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchsettledate(void* lpObj, const char* lpszSearchSettleDate);

int dpaymentssdk_globaltransactionsearch_getsearchsettleflag(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchsettleflag(void* lpObj, int bSearchSettleFlag);

char* dpaymentssdk_globaltransactionsearch_getsearchsettlemessage(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchsettlemessage(void* lpObj, const char* lpszSearchSettleMessage);

char* dpaymentssdk_globaltransactionsearch_getsearchtransactionamount(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchtransactionamount(void* lpObj, const char* lpszSearchTransactionAmount);

char* dpaymentssdk_globaltransactionsearch_getsearchtransactiontype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchtransactiontype(void* lpObj, const char* lpszSearchTransactionType);

char* dpaymentssdk_globaltransactionsearch_getsearchuserid(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsearchuserid(void* lpObj, const char* lpszSearchUserId);

QString GetSearchApprovalCode();
int SetSearchApprovalCode(QString qsSearchApprovalCode);

QString GetSearchBeginDate();
int SetSearchBeginDate(QString qsSearchBeginDate);

QString GetSearchCardNumber();
int SetSearchCardNumber(QString qsSearchCardNumber);

QString GetSearchCardType();
int SetSearchCardType(QString qsSearchCardType);

QString GetSearchCustomerId();
int SetSearchCustomerId(QString qsSearchCustomerId);

QString GetSearchEndDate();
int SetSearchEndDate(QString qsSearchEndDate);

QString GetSearchExcludeCardType();
int SetSearchExcludeCardType(QString qsSearchExcludeCardType);

QString GetSearchExcludePaymentType();
int SetSearchExcludePaymentType(QString qsSearchExcludePaymentType);

QString GetSearchExcludeResponseCode();
int SetSearchExcludeResponseCode(QString qsSearchExcludeResponseCode);

QString GetSearchExcludeTransType();
int SetSearchExcludeTransType(QString qsSearchExcludeTransType);

bool GetSearchExcludeVoid();
int SetSearchExcludeVoid(bool bSearchExcludeVoid);

QString GetSearchInvoiceNumber();
int SetSearchInvoiceNumber(QString qsSearchInvoiceNumber);

QString GetSearchNameOnCard();
int SetSearchNameOnCard(QString qsSearchNameOnCard);

QString GetSearchPaymentType();
int SetSearchPaymentType(QString qsSearchPaymentType);

QString GetSearchPNRef();
int SetSearchPNRef(QString qsSearchPNRef);

QString GetSearchRegisterNumber();
int SetSearchRegisterNumber(QString qsSearchRegisterNumber);

QString GetSearchResponseCode();
int SetSearchResponseCode(QString qsSearchResponseCode);

QString GetSearchSettleDate();
int SetSearchSettleDate(QString qsSearchSettleDate);

bool GetSearchSettleFlag();
int SetSearchSettleFlag(bool bSearchSettleFlag);

QString GetSearchSettleMessage();
int SetSearchSettleMessage(QString qsSearchSettleMessage);

QString GetSearchTransactionAmount();
int SetSearchTransactionAmount(QString qsSearchTransactionAmount);

QString GetSearchTransactionType();
int SetSearchTransactionType(QString qsSearchTransactionType);

QString GetSearchUserId();
int SetSearchUserId(QString qsSearchUserId);

Remarks

When performing a Search of transactions using the Search method, the fields in this property are used to limit the results to those you are specifically interested in. If the PNRef field is set, all other fields in the GlobalTransSearchCriteria are ignored. The following configuration settings are also available for filtering results:

SearchCriteriaBatchNumber
SearchCriteriaCustomerId
SearchCriteriaIncludeCustomFields
SearchCriteriaPONumber

When requesting a transaction summary using the GetTransactionSummary method, the BeginDate and EndDate are still required, but only the following subset of search fields may be used to restrict the results:

SearchCriteriaBatchNumber
BeginDate
SearchCriteriaCardBreakdown
EndDate
RegisterNumber
UserId

Data Type

DPaymentsSDKGlobalTransSearchCriteria

SearchResults Property (GlobalTransactionSearch Class)

Contains a collection of transactions that matched the SearchCriteria .

Syntax

DPaymentsSDKList<DPaymentsSDKGlobalSearchResult>* GetSearchResults();

int dpaymentssdk_globaltransactionsearch_getsearchresultcount(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsearchresultapprovalcode(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultauthorizedamount(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultavsresultcode(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultbatchnumber(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcardexpdate(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcardnumber(void* lpObj, int searchresultindex);

int dpaymentssdk_globaltransactionsearch_getsearchresultcardpresent(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcardtype(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcashbackamount(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultclientip(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcustomerid(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcustomerstreet(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcustomerzip(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultcvvresultcode(void* lpObj, int searchresultindex);

int dpaymentssdk_globaltransactionsearch_getsearchresultentrymode(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulterror(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultgratuityamount(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulthostcode(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultinvoicenumber(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultlastmodified(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultnameoncard(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultoriginalpnref(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultpaymenttype(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultpnref(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultprocessorid(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultregisternumber(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultresellerkey(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultresponsecode(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultresponsemessage(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultsettledate(void* lpObj, int searchresultindex);

int dpaymentssdk_globaltransactionsearch_getsearchresultsettleflag(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulttotalamount(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulttransactiondate(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulttransactionid(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulttransactionkey(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresulttransactiontype(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultuserid(void* lpObj, int searchresultindex);

char* dpaymentssdk_globaltransactionsearch_getsearchresultvendornumber(void* lpObj, int searchresultindex);

int dpaymentssdk_globaltransactionsearch_getsearchresultvoidflag(void* lpObj, int searchresultindex);

int GetSearchResultCount();

QString GetSearchResultApprovalCode(int iSearchResultIndex);

QString GetSearchResultAuthorizedAmount(int iSearchResultIndex);

QString GetSearchResultAVSResultCode(int iSearchResultIndex);

QString GetSearchResultBatchNumber(int iSearchResultIndex);

QString GetSearchResultCardExpDate(int iSearchResultIndex);

QString GetSearchResultCardNumber(int iSearchResultIndex);

bool GetSearchResultCardPresent(int iSearchResultIndex);

QString GetSearchResultCardType(int iSearchResultIndex);

QString GetSearchResultCashBackAmount(int iSearchResultIndex);

QString GetSearchResultClientIP(int iSearchResultIndex);

QString GetSearchResultCustomerId(int iSearchResultIndex);

QString GetSearchResultCustomerStreet(int iSearchResultIndex);

QString GetSearchResultCustomerZip(int iSearchResultIndex);

QString GetSearchResultCVVResultCode(int iSearchResultIndex);

int GetSearchResultEntryMode(int iSearchResultIndex);

QString GetSearchResultError(int iSearchResultIndex);

QString GetSearchResultGratuityAmount(int iSearchResultIndex);

QString GetSearchResultHostCode(int iSearchResultIndex);

QString GetSearchResultInvoiceNumber(int iSearchResultIndex);

QString GetSearchResultLastModified(int iSearchResultIndex);

QString GetSearchResultNameOnCard(int iSearchResultIndex);

QString GetSearchResultOriginalPNRef(int iSearchResultIndex);

QString GetSearchResultPaymentType(int iSearchResultIndex);

QString GetSearchResultPNRef(int iSearchResultIndex);

QString GetSearchResultProcessorId(int iSearchResultIndex);

QString GetSearchResultRegisterNumber(int iSearchResultIndex);

QString GetSearchResultResellerKey(int iSearchResultIndex);

QString GetSearchResultResponseCode(int iSearchResultIndex);

QString GetSearchResultResponseMessage(int iSearchResultIndex);

QString GetSearchResultSettleDate(int iSearchResultIndex);

bool GetSearchResultSettleFlag(int iSearchResultIndex);

QString GetSearchResultTotalAmount(int iSearchResultIndex);

QString GetSearchResultTransactionDate(int iSearchResultIndex);

QString GetSearchResultTransactionId(int iSearchResultIndex);

QString GetSearchResultTransactionKey(int iSearchResultIndex);

QString GetSearchResultTransactionType(int iSearchResultIndex);

QString GetSearchResultUserId(int iSearchResultIndex);

QString GetSearchResultVendorNumber(int iSearchResultIndex);

bool GetSearchResultVoidFlag(int iSearchResultIndex);

Remarks

This property contains the results after a successful call to the Search method. Each GlobalSearchResult in the collection will contain information about a single transaction.

This property is read-only.

Data Type

DPaymentsSDKGlobalSearchResult

Server Property (GlobalTransactionSearch Class)

Global Payments transaction server.

Syntax

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer);

Unicode (Windows)
LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);

char* dpaymentssdk_globaltransactionsearch_getserver(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setserver(void* lpObj, const char* lpszServer);

QString GetServer();
int SetServer(QString qsServer);

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

SSLAcceptServerCert Property (GlobalTransactionSearch Class)

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

Syntax

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_globaltransactionsearch_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_globaltransactionsearch_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_globaltransactionsearch_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_globaltransactionsearch_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

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

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

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

Data Type

DPaymentsSDKCertificate

SSLCert Property (GlobalTransactionSearch Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_globaltransactionsearch_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertissuer(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_globaltransactionsearch_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_globaltransactionsearch_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_globaltransactionsearch_getsslcertstoretype(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_globaltransactionsearch_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertusage(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertversion(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslcertsubject(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_globaltransactionsearch_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_globaltransactionsearch_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

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

Data Type

DPaymentsSDKCertificate

SSLProvider Property (GlobalTransactionSearch Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_globaltransactionsearch_getsslprovider(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

Remarks

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

Possible values are as follows:


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

Additional Notes

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (GlobalTransactionSearch Class)

The server certificate for the last established connection.

Syntax

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_globaltransactionsearch_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_globaltransactionsearch_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertusage(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertversion(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsslservercertsubject(void* lpObj);

int dpaymentssdk_globaltransactionsearch_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

SummaryResults Property (GlobalTransactionSearch Class)

Contains summary results for all payment types.

Syntax

DPaymentsSDKList<DPaymentsSDKGlobalSummaryResult>* GetSummaryResults();

int dpaymentssdk_globaltransactionsearch_getsummarycount(void* lpObj);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultauthorizationamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultauthorizationcount(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultcaptureamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultcapturecount(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultforcecaptureamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultforcecapturecount(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultpaymenttype(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultpostauthamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultpostauthcount(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultrefundamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultrefundcount(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultrepeatsaleamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultrepeatsalecount(void* lpObj, int summaryindex);

char* dpaymentssdk_globaltransactionsearch_getsummaryresultsaleamount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultsalecount(void* lpObj, int summaryindex);

int dpaymentssdk_globaltransactionsearch_getsummaryresulttotalcount(void* lpObj, int summaryindex);

int GetSummaryCount();

QString GetSummaryResultAuthorizationAmount(int iSummaryIndex);

int GetSummaryResultAuthorizationCount(int iSummaryIndex);

QString GetSummaryResultCaptureAmount(int iSummaryIndex);

int GetSummaryResultCaptureCount(int iSummaryIndex);

QString GetSummaryResultForceCaptureAmount(int iSummaryIndex);

int GetSummaryResultForceCaptureCount(int iSummaryIndex);

QString GetSummaryResultPaymentType(int iSummaryIndex);

QString GetSummaryResultPostAuthAmount(int iSummaryIndex);

int GetSummaryResultPostAuthCount(int iSummaryIndex);

QString GetSummaryResultRefundAmount(int iSummaryIndex);

int GetSummaryResultRefundCount(int iSummaryIndex);

QString GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

QString GetSummaryResultSaleAmount(int iSummaryIndex);

int GetSummaryResultSaleCount(int iSummaryIndex);

int GetSummaryResultTotalCount(int iSummaryIndex);

Remarks

This property contains the results after a successful call to the GetTransactionSummary method. Each GlobalSummaryResult in the collection will contain a summary for the payment type specified by the PaymentType field.

This property is read-only.

Data Type

DPaymentsSDKGlobalSummaryResult

Timeout Property (GlobalTransactionSearch Class)

The timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_globaltransactionsearch_gettimeout(void* lpObj);
int dpaymentssdk_globaltransactionsearch_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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 Class)

UserId for authentication with the Global Payments Server .

Syntax

ANSI (Cross Platform)
char* GetUserId();
int SetUserId(const char* lpszUserId);

Unicode (Windows)
LPWSTR GetUserId();
INT SetUserId(LPCWSTR lpszUserId);

char* dpaymentssdk_globaltransactionsearch_getuserid(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setuserid(void* lpObj, const char* lpszUserId);

QString GetUserId();
int SetUserId(QString qsUserId);

Default Value

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (GlobalTransactionSearch Class)

The merchant's RP/Vendor number.

Syntax

ANSI (Cross Platform)
char* GetVendorNumber();
int SetVendorNumber(const char* lpszVendorNumber);

Unicode (Windows)
LPWSTR GetVendorNumber();
INT SetVendorNumber(LPCWSTR lpszVendorNumber);

char* dpaymentssdk_globaltransactionsearch_getvendornumber(void* lpObj);
int dpaymentssdk_globaltransactionsearch_setvendornumber(void* lpObj, const char* lpszVendorNumber);

QString GetVendorNumber();
int SetVendorNumber(QString qsVendorNumber);

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 class's CheckSetup method to find it.

Data Type

String

Config Method (GlobalTransactionSearch Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_globaltransactionsearch_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetTransactionSummary Method (GlobalTransactionSearch Class)

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

Syntax

ANSI (Cross Platform)
int GetTransactionSummary();

Unicode (Windows)
INT GetTransactionSummary();

int dpaymentssdk_globaltransactionsearch_gettransactionsummary(void* lpObj);

int 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 BeginDate and EndDate are required for transaction summaries, but only the following subset of SearchCriteria fields may be used to restrict the results:

SearchCriteriaBatchNumber
BeginDate
SearchCriteriaCardBreakdown
EndDate
RegisterNumber
UserId

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (GlobalTransactionSearch Class)

This method interrupts the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_globaltransactionsearch_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

Reset Method (GlobalTransactionSearch Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_globaltransactionsearch_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

Search Method (GlobalTransactionSearch Class)

Retrieves a list of payments that match the specified SearchCriteria .

Syntax

ANSI (Cross Platform)
int Search();

Unicode (Windows)
INT Search();

int dpaymentssdk_globaltransactionsearch_search(void* lpObj);

int Search();

Remarks

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

Error Handling (C++)

Error Event (GlobalTransactionSearch Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(GlobalTransactionSearchErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} GlobalTransactionSearchErrorEventParams;


Unicode (Windows)
virtual INT FireError(GlobalTransactionSearchErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} GlobalTransactionSearchErrorEventParams;

#define EID_GLOBALTRANSACTIONSEARCH_ERROR 1

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class GlobalTransactionSearchErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(GlobalTransactionSearchErrorEventParams *e);

// Or, subclass GlobalTransactionSearch and override this emitter function.
virtual int FireError(GlobalTransactionSearchErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(GlobalTransactionSearchSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} GlobalTransactionSearchSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(GlobalTransactionSearchSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} GlobalTransactionSearchSSLServerAuthenticationEventParams;

#define EID_GLOBALTRANSACTIONSEARCH_SSLSERVERAUTHENTICATION 2

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class GlobalTransactionSearchSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(GlobalTransactionSearchSSLServerAuthenticationEventParams *e);

// Or, subclass GlobalTransactionSearch and override this emitter function.
virtual int FireSSLServerAuthentication(GlobalTransactionSearchSSLServerAuthenticationEventParams *e) {...}

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

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(GlobalTransactionSearchSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GlobalTransactionSearchSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(GlobalTransactionSearchSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GlobalTransactionSearchSSLStatusEventParams;

#define EID_GLOBALTRANSACTIONSEARCH_SSLSTATUS 3

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class GlobalTransactionSearchSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(GlobalTransactionSearchSSLStatusEventParams *e);

// Or, subclass GlobalTransactionSearch and override this emitter function.
virtual int FireSSLStatus(GlobalTransactionSearchSSLStatusEventParams *e) {...}

Remarks

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

Status Event (GlobalTransactionSearch Class)

Shows the progress of the Global Payments connection.

Syntax

ANSI (Cross Platform)
virtual int FireStatus(GlobalTransactionSearchStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GlobalTransactionSearchStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(GlobalTransactionSearchStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GlobalTransactionSearchStatusEventParams;

#define EID_GLOBALTRANSACTIONSEARCH_STATUS 4

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

class GlobalTransactionSearchStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(GlobalTransactionSearchStatusEventParams *e);

// Or, subclass GlobalTransactionSearch and override this emitter function.
virtual int FireStatus(GlobalTransactionSearchStatusEventParams *e) {...}

Remarks

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

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

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

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

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

Fingerprint
char* (read-only)
Default Value: ""

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

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

FingerprintSHA1
char* (read-only)
Default Value: ""

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

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

FingerprintSHA256
char* (read-only)
Default Value: ""

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

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

Issuer
char* (read-only)
Default Value: ""

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

PrivateKey
char* (read-only)
Default Value: ""

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

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

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

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

PrivateKeyContainer
char* (read-only)
Default Value: ""

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

PublicKey
char* (read-only)
Default Value: ""

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

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

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

PublicKeyLength
int (read-only)
Default Value: 0

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

SerialNumber
char* (read-only)
Default Value: ""

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

SignatureAlgorithm
char* (read-only)
Default Value: ""

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

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

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

ThumbprintSHA1
char* (read-only)
Default Value: ""

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

ThumbprintSHA256
char* (read-only)
Default Value: ""

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

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

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

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

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

UsageFlags
int (read-only)
Default Value: 0

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


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

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

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

Version
char* (read-only)
Default Value: ""

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

Subject
char*
Default Value: ""

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 field 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=example@email.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

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

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

GlobalSearchResult Type

Contains information about a single transaction.

Syntax

DPaymentsSDKGlobalSearchResult (declared in dpaymentssdk.h)

Remarks

The GlobalTransactionSearch class is used to search for individual transactions. This type is used to store the results.

The following fields are available:

Fields

ApprovalCode
char* (read-only)
Default Value: ""

Contains the transaction authorization code from the card issuer.

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

AuthorizedAmount
char* (read-only)
Default Value: ""

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 Code will contain "200", the Message will contain "Partial Approval", and the MessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the AuthorizedAmount will contain the amount of the transaction that was authorized, and the BalanceDue field 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.

AVSResultCode
char* (read-only)
Default Value: ""

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

BatchNumber
char* (read-only)
Default Value: ""

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

CardExpDate
char* (read-only)
Default Value: ""

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

CardNumber
char* (read-only)
Default Value: ""

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

CardPresent
int (read-only)
Default Value: FALSE

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

CardType
char* (read-only)
Default Value: ""

Indicates the card type or payment method.

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

CashBackAmount
char* (read-only)
Default Value: ""

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

ClientIP
char* (read-only)
Default Value: ""

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

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

CustomerId
char* (read-only)
Default Value: ""

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

CustomerStreet
char* (read-only)
Default Value: ""

Contains the billing street address of the credit card.

CustomerZip
char* (read-only)
Default Value: ""

Contains the billing zip code of the credit card.

CVVResultCode
char* (read-only)
Default Value: ""

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 CVVResultMessage field.

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


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

EntryMode
int (read-only)
Default Value: 0

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.

Error
char* (read-only)
Default Value: ""

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

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

GratuityAmount
char* (read-only)
Default Value: ""

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

HostCode
char* (read-only)
Default Value: ""

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 HostCode will indicate the reason for the decline. The table below lists the possible HostCode and Message combinations for error conditions.


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

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

InvoiceNumber
char* (read-only)
Default Value: ""

Contains the transactions invoice number.

LastModified
char* (read-only)
Default Value: ""

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

NameOnCard
char* (read-only)
Default Value: ""

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

OriginalPNRef
char* (read-only)
Default Value: ""

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

PaymentType
char* (read-only)
Default Value: ""

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

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

PNRef
char* (read-only)
Default Value: ""

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.

ProcessorId
char* (read-only)
Default Value: ""

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

Contains the name of the processing platform.

RegisterNumber
char* (read-only)
Default Value: ""

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 field will be empty.

ResellerKey
char* (read-only)
Default Value: ""

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

Contains the primary key of the Reseller table.

ResponseCode
char* (read-only)
Default Value: ""

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.


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

ResponseMessage
char* (read-only)
Default Value: ""

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.

SettleDate
char* (read-only)
Default Value: ""

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

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

SettleFlag
int (read-only)
Default Value: FALSE

Indicates whether or not the transaction has been settled.

TotalAmount
char* (read-only)
Default Value: ""

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

TransactionDate
char* (read-only)
Default Value: ""

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

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

TransactionId
char* (read-only)
Default Value: ""

Card issuer's Transaction Reference Number.

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

TransactionKey
char* (read-only)
Default Value: ""

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

TransactionType
char* (read-only)
Default Value: ""

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

UserId
char* (read-only)
Default Value: ""

Contains the username used to process the transaction.

VendorNumber
char* (read-only)
Default Value: ""

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

VoidFlag
int (read-only)
Default Value: FALSE

Indicates whether or not the transaction has been voided.

Constructors

GlobalSearchResult()

GlobalSummaryResult Type

Contains a summary for a single payment type.

Syntax

DPaymentsSDKGlobalSummaryResult (declared in dpaymentssdk.h)

Remarks

This type will contain a summary for the payment type specified by the PaymentType field. This includes the total dollar amounts and transaction counts of all the Sale, Refund, Force, Auth-only, and Recurring transactions, as well as the total number of transactions made for that particular PaymentType.

The following fields are available:

AuthorizationAmount
AuthorizationCount
CaptureAmount
CaptureCount
ForceCaptureAmount
ForceCaptureCount
PaymentType
PostAuthAmount
PostAuthCount
RefundAmount
RefundCount
RepeatSaleAmount
RepeatSaleCount
SaleAmount
SaleCount
TotalCount

Fields

AuthorizationAmount
char* (read-only)
Default Value: ""

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

AuthorizationCount
int (read-only)
Default Value: 0

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

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

CaptureAmount
char* (read-only)
Default Value: ""

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

CaptureCount
int (read-only)
Default Value: 0

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

ForceCaptureAmount
char* (read-only)
Default Value: ""

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

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

ForceCaptureCount
int (read-only)
Default Value: 0

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

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

PaymentType
char* (read-only)
Default Value: ""

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.

PostAuthAmount
char* (read-only)
Default Value: ""

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

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

PostAuthCount
int (read-only)
Default Value: 0

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

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

RefundAmount
char* (read-only)
Default Value: ""

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

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

RefundCount
int (read-only)
Default Value: 0

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

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

RepeatSaleAmount
char* (read-only)
Default Value: ""

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

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

RepeatSaleCount
int (read-only)
Default Value: 0

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

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

SaleAmount
char* (read-only)
Default Value: ""

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

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

SaleCount
int (read-only)
Default Value: 0

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

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

TotalCount
int (read-only)
Default Value: 0

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

Constructors

GlobalSummaryResult()

GlobalTransSearchCriteria Type

Specifies criteria to filter the transaction search.

Syntax

DPaymentsSDKGlobalTransSearchCriteria (declared in dpaymentssdk.h)

Remarks

When performing a Search of transactions using the GlobalTransactionSearch class, this type is used to limit the results to those you are specifically interested in. The BeginDate and EndDate fields are required, unless the PNRef field is set. In that case, all other fields in the GlobalTransSearchCriteria are ignored, and only the PNRef is sent in the search request.

The following fields are available:

Fields

ApprovalCode
char*
Default Value: ""

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

BeginDate
char*
Default Value: ""

The start of the date range in which to search for transactions. This field is required except when the PNRef field is provided. It may contain up to 19 alphanumeric characters and symbols. The BeginDate 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 BeginDate does not contain time information, it will default to midnight on the given date.

CardNumber
char*
Default Value: ""

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

CardType
char*
Default Value: ""

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 CardType of "1,4" will pull all transactions made with Visa or Discover credit cards.

CustomerId
char*
Default Value: ""

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 field is not applicable for Transaction Summaries.

EndDate
char*
Default Value: ""

The end of the date range in which to search for transactions. This field is required except when the PNRef field is provided. It may contain up to 19 alphanumeric characters and symbols. The EndDate 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 EndDate 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.

ExcludeCardType
char*
Default Value: ""

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 ExcludeCardType of "VISA,DISCOVER" will ignore all transactions made with Visa or Discover cards.

This field is not applicable for Transaction Summaries.

ExcludePaymentType
char*
Default Value: ""

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 ExcludePaymentType of "DEBIT,EBT" will ignore all transactions with either DEBIT or EBT payment types.

This field is not applicable for Transaction Summaries.

ExcludeResponseCode
char*
Default Value: ""

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 ExcludeResponseCode to "0". (As "0" is the response code for approved transactions).

This field is not applicable for Transaction Summaries.

ExcludeTransType
char*
Default Value: ""

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 ExcludeTransType of "Credit,Sale" will ignore all transactions with either Credit or Sale transaction types.

This field is not applicable for Transaction Summaries.

ExcludeVoid
int
Default Value: FALSE

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

InvoiceNumber
char*
Default Value: ""

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 field is not applicable for Transaction Summaries.

NameOnCard
char*
Default Value: ""

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

PaymentType
char*
Default Value: ""

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 field is not applicable for Transaction Summaries.

PNRef
char*
Default Value: ""

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

This field is not applicable for Transaction Summaries.

RegisterNumber
char*
Default Value: ""

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 field may contain up to 10 alphanumeric characters.

ResponseCode
char*
Default Value: ""

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 ExcludeResponseCode to "0" (to exclude all approved transactions) instead.

This field is not applicable for Transaction Summaries.

SettleDate
char*
Default Value: ""

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

SettleFlag
int
Default Value: FALSE

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.

SettleMessage
char*
Default Value: ""

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

TransactionAmount
char*
Default Value: ""

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 field is not applicable for Transaction Summaries.

TransactionType
char*
Default Value: ""

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

Valid values when PaymentType 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 PaymentType is 1 (Debit) are:


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

Valid values when PaymentType 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 TransactionType of "1,2" will pull all transactions with either Sale or Return transaction types.

This field is not applicable for Transaction Summaries.

UserId
char*
Default Value: ""

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.

Constructors

GlobalTransSearchCriteria()

Proxy Type

The proxy the component will connect to.

Syntax

DPaymentsSDKProxy (declared in dpaymentssdk.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

AuthScheme
AutoDetect
Password
Port
Server
SSL
User

Fields

AuthScheme
int
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.

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

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

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

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
int
Default Value: FALSE

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Password
char*
Default Value: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

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

Port
int
Default Value: 80

The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

Server
char*
Default Value: ""

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

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

SSL
int
Default Value: 0

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


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

User
char*
Default Value: ""

A username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

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

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

DPaymentsSDKList Type

Syntax

DPaymentsSDKList<T> (declared in dpaymentssdk.h)

Remarks

DPaymentsSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the GlobalTransactionSearch class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (GlobalTransactionSearch Class)

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

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

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

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

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

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

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

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

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

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

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

FirewallPort: The TCP port for the FirewallHost;.

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

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

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


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

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

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

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

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

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

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

Note: This value is not applicable in macOS.

KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.

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 number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

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

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

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

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

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

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

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

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

LingerTime: Time in seconds to have the connection linger.

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

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

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

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

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

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

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

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on 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.example.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 set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

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


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 configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only 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 configuration 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). OpenSSL recommends the use of 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 the following sequences:

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

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

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

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. 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 class will reuse the context if and only if the following criteria are met:

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

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is 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.

Note: This configuration 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 configuration 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 configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client'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 configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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

This configuration setting enables the cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: 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 the following:

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 Internalinclude the following:

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

Possible values when SSLProvider is set to Internal include the following:

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

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that 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 supported only 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 available only 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, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

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

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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

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

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

This configuration 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 configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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

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

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration 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 ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

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

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

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and 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 configuration setting should be set only 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 configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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

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

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration 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.

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

TLS12SupportedGroups: The supported groups for ECC.

This configuration 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 configuration 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 roundtrip 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 configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only 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 configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"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 configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only 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 that 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 User Datagram Protocol (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 Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

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

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

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

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

Base Config Settings

BuildInfo: Information about the product's build.

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

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:


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

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

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

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

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

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

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

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

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

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (GlobalTransactionSearch Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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 class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

118	Firewall error. The error description contains the 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	Cannot open AttachedFile.

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

TCPClient Errors

100	You cannot change the RemotePort at this time. A connection is in progress.
101	You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102	The RemoteHost address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the LocalPort at this time. A connection is in progress.
107	You cannot change the LocalHost at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	RemotePort cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the class is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
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 nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot 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] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is 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 is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).