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 SearchBeginDate and SearchEndDate properties. All other search criteria properties are optional. However, if you wish to retrieve information for one particular transaction, set the SearchPNRef property instead. All other properties will be ignored if the SearchPNRef property is set. The results of your search will be contained in the SearchResults collection.

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

Property List

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

Method List

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

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.

Config Settings

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

Password Property (GlobalTransactionSearch Class)

Password for authentication with the Global Payments Server .

Syntax

• C++
• C
• Qt

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

ProxyAuthScheme Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

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

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

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

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

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

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

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

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

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

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

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

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

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

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

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchApprovalCode Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchApprovalCode();
int SetSearchApprovalCode(const char* lpszSearchApprovalCode);

Unicode (Windows)
LPWSTR GetSearchApprovalCode();
INT SetSearchApprovalCode(LPCWSTR lpszSearchApprovalCode);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchBeginDate Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchBeginDate();
int SetSearchBeginDate(const char* lpszSearchBeginDate);

Unicode (Windows)
LPWSTR GetSearchBeginDate();
INT SetSearchBeginDate(LPCWSTR lpszSearchBeginDate);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchCardNumber Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchCardNumber();
int SetSearchCardNumber(const char* lpszSearchCardNumber);

Unicode (Windows)
LPWSTR GetSearchCardNumber();
INT SetSearchCardNumber(LPCWSTR lpszSearchCardNumber);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchCardType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchCardType();
int SetSearchCardType(const char* lpszSearchCardType);

Unicode (Windows)
LPWSTR GetSearchCardType();
INT SetSearchCardType(LPCWSTR lpszSearchCardType);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchCustomerId Property (GlobalTransactionSearch Class)

The CustomerId included in the original transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchCustomerId();
int SetSearchCustomerId(const char* lpszSearchCustomerId);

Unicode (Windows)
LPWSTR GetSearchCustomerId();
INT SetSearchCustomerId(LPCWSTR lpszSearchCustomerId);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchEndDate Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchEndDate();
int SetSearchEndDate(const char* lpszSearchEndDate);

Unicode (Windows)
LPWSTR GetSearchEndDate();
INT SetSearchEndDate(LPCWSTR lpszSearchEndDate);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchExcludeCardType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchExcludeCardType();
int SetSearchExcludeCardType(const char* lpszSearchExcludeCardType);

Unicode (Windows)
LPWSTR GetSearchExcludeCardType();
INT SetSearchExcludeCardType(LPCWSTR lpszSearchExcludeCardType);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludePaymentType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchExcludePaymentType();
int SetSearchExcludePaymentType(const char* lpszSearchExcludePaymentType);

Unicode (Windows)
LPWSTR GetSearchExcludePaymentType();
INT SetSearchExcludePaymentType(LPCWSTR lpszSearchExcludePaymentType);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludeResponseCode Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchExcludeResponseCode();
int SetSearchExcludeResponseCode(const char* lpszSearchExcludeResponseCode);

Unicode (Windows)
LPWSTR GetSearchExcludeResponseCode();
INT SetSearchExcludeResponseCode(LPCWSTR lpszSearchExcludeResponseCode);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludeTransType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchExcludeTransType();
int SetSearchExcludeTransType(const char* lpszSearchExcludeTransType);

Unicode (Windows)
LPWSTR GetSearchExcludeTransType();
INT SetSearchExcludeTransType(LPCWSTR lpszSearchExcludeTransType);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchExcludeVoid Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchExcludeVoid();
int SetSearchExcludeVoid(int bSearchExcludeVoid);

Unicode (Windows)
BOOL GetSearchExcludeVoid();
INT SetSearchExcludeVoid(BOOL bSearchExcludeVoid);

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

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

SearchInvoiceNumber Property (GlobalTransactionSearch Class)

The InvoiceNumber that was included in the original transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchInvoiceNumber();
int SetSearchInvoiceNumber(const char* lpszSearchInvoiceNumber);

Unicode (Windows)
LPWSTR GetSearchInvoiceNumber();
INT SetSearchInvoiceNumber(LPCWSTR lpszSearchInvoiceNumber);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchNameOnCard Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchNameOnCard();
int SetSearchNameOnCard(const char* lpszSearchNameOnCard);

Unicode (Windows)
LPWSTR GetSearchNameOnCard();
INT SetSearchNameOnCard(LPCWSTR lpszSearchNameOnCard);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchPaymentType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchPaymentType();
int SetSearchPaymentType(const char* lpszSearchPaymentType);

Unicode (Windows)
LPWSTR GetSearchPaymentType();
INT SetSearchPaymentType(LPCWSTR lpszSearchPaymentType);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchPNRef Property (GlobalTransactionSearch Class)

The unique payment reference number assigned to the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchPNRef();
int SetSearchPNRef(const char* lpszSearchPNRef);

Unicode (Windows)
LPWSTR GetSearchPNRef();
INT SetSearchPNRef(LPCWSTR lpszSearchPNRef);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchRegisterNumber Property (GlobalTransactionSearch Class)

The RegisterNumber associated with the original transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchRegisterNumber();
int SetSearchRegisterNumber(const char* lpszSearchRegisterNumber);

Unicode (Windows)
LPWSTR GetSearchRegisterNumber();
INT SetSearchRegisterNumber(LPCWSTR lpszSearchRegisterNumber);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchResponseCode Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResponseCode();
int SetSearchResponseCode(const char* lpszSearchResponseCode);

Unicode (Windows)
LPWSTR GetSearchResponseCode();
INT SetSearchResponseCode(LPCWSTR lpszSearchResponseCode);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchSettleDate Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchSettleDate();
int SetSearchSettleDate(const char* lpszSearchSettleDate);

Unicode (Windows)
LPWSTR GetSearchSettleDate();
INT SetSearchSettleDate(LPCWSTR lpszSearchSettleDate);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchSettleFlag Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchSettleFlag();
int SetSearchSettleFlag(int bSearchSettleFlag);

Unicode (Windows)
BOOL GetSearchSettleFlag();
INT SetSearchSettleFlag(BOOL bSearchSettleFlag);

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

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

SearchSettleMessage Property (GlobalTransactionSearch Class)

The settlement ID or message returned from the host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchSettleMessage();
int SetSearchSettleMessage(const char* lpszSearchSettleMessage);

Unicode (Windows)
LPWSTR GetSearchSettleMessage();
INT SetSearchSettleMessage(LPCWSTR lpszSearchSettleMessage);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchTransactionAmount Property (GlobalTransactionSearch Class)

The original TransactionAmount of the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchTransactionAmount();
int SetSearchTransactionAmount(const char* lpszSearchTransactionAmount);

Unicode (Windows)
LPWSTR GetSearchTransactionAmount();
INT SetSearchTransactionAmount(LPCWSTR lpszSearchTransactionAmount);

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

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

Default Value

""

Remarks

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

This property is not applicable for Transaction Summaries.

Data Type

String

SearchTransactionType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchTransactionType();
int SetSearchTransactionType(const char* lpszSearchTransactionType);

Unicode (Windows)
LPWSTR GetSearchTransactionType();
INT SetSearchTransactionType(LPCWSTR lpszSearchTransactionType);

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

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

Default Value

""

Remarks

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

Valid values when SearchPaymentType is 0 (Credit) are:

Valid values when SearchPaymentType is 1 (Debit) are:

Valid values when SearchPaymentType is 2 (EBT) are:

This property is not applicable for Transaction Summaries.

Data Type

String

SearchUserId Property (GlobalTransactionSearch Class)

The user who originated the transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchUserId();
int SetSearchUserId(const char* lpszSearchUserId);

Unicode (Windows)
LPWSTR GetSearchUserId();
INT SetSearchUserId(LPCWSTR lpszSearchUserId);

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

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

Default Value

""

Remarks

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

Data Type

String

SearchResultCount Property (GlobalTransactionSearch Class)

The number of records in the SearchResult arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchResultCount();

Unicode (Windows)
INT GetSearchResultCount();

int dpaymentssdk_globaltransactionsearch_getsearchresultcount(void* lpObj);

int GetSearchResultCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SearchResultApprovalCode
• SearchResultAuthorizedAmount
• SearchResultAVSResultCode
• SearchResultBatchNumber
• SearchResultCardExpDate
• SearchResultCardNumber
• SearchResultCardPresent
• SearchResultCardType
• SearchResultCashBackAmount
• SearchResultClientIP
• SearchResultCustomerId
• SearchResultCustomerStreet
• SearchResultCustomerZip
• SearchResultCVVResultCode
• SearchResultEntryMode
• SearchResultError
• SearchResultGratuityAmount
• SearchResultHostCode
• SearchResultInvoiceNumber
• SearchResultLastModified
• SearchResultNameOnCard
• SearchResultOriginalPNRef
• SearchResultPaymentType
• SearchResultPNRef
• SearchResultProcessorId
• SearchResultRegisterNumber
• SearchResultResellerKey
• SearchResultResponseCode
• SearchResultResponseMessage
• SearchResultSettleDate
• SearchResultSettleFlag
• SearchResultTotalAmount
• SearchResultTransactionDate
• SearchResultTransactionId
• SearchResultTransactionKey
• SearchResultTransactionType
• SearchResultUserId
• SearchResultVendorNumber
• SearchResultVoidFlag

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

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

Data Type

Integer

SearchResultApprovalCode Property (GlobalTransactionSearch Class)

Contains the transaction authorization code from the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultApprovalCode(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultApprovalCode(INT iSearchResultIndex);

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

QString GetSearchResultApprovalCode(int iSearchResultIndex);

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

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

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

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

Data Type

String

SearchResultAuthorizedAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultAuthorizedAmount(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultAuthorizedAmount(INT iSearchResultIndex);

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

QString GetSearchResultAuthorizedAmount(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

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

Data Type

String

SearchResultAVSResultCode Property (GlobalTransactionSearch Class)

Contains the address verification result code from the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultAVSResultCode(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultAVSResultCode(INT iSearchResultIndex);

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

QString GetSearchResultAVSResultCode(int iSearchResultIndex);

Default Value

""

Remarks

Contains the address verification result code from the card issuer.

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

* These values are Visa specific.

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

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

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

Data Type

String

SearchResultBatchNumber Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultBatchNumber(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultBatchNumber(INT iSearchResultIndex);

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

QString GetSearchResultBatchNumber(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultCardExpDate Property (GlobalTransactionSearch Class)

Contains the credit card expiration date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCardExpDate(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCardExpDate(INT iSearchResultIndex);

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

QString GetSearchResultCardExpDate(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultCardNumber Property (GlobalTransactionSearch Class)

Contains the credit card number used in the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCardNumber(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCardNumber(INT iSearchResultIndex);

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

QString GetSearchResultCardNumber(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultCardPresent Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchResultCardPresent(int iSearchResultIndex);

Unicode (Windows)
BOOL GetSearchResultCardPresent(INT iSearchResultIndex);

int dpaymentssdk_globaltransactionsearch_getsearchresultcardpresent(void* lpObj, int searchresultindex);

bool GetSearchResultCardPresent(int iSearchResultIndex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

SearchResultCardType Property (GlobalTransactionSearch Class)

Indicates the card type or payment method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCardType(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCardType(INT iSearchResultIndex);

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

QString GetSearchResultCardType(int iSearchResultIndex);

Default Value

""

Remarks

Indicates the card type or payment method.

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

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

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

Data Type

String

SearchResultCashBackAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCashBackAmount(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCashBackAmount(INT iSearchResultIndex);

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

QString GetSearchResultCashBackAmount(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultClientIP Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultClientIP(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultClientIP(INT iSearchResultIndex);

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

QString GetSearchResultClientIP(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultCustomerId Property (GlobalTransactionSearch Class)

Identifies the customer that initiated the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCustomerId(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCustomerId(INT iSearchResultIndex);

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

QString GetSearchResultCustomerId(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultCustomerStreet Property (GlobalTransactionSearch Class)

Contains the billing street address of the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCustomerStreet(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCustomerStreet(INT iSearchResultIndex);

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

QString GetSearchResultCustomerStreet(int iSearchResultIndex);

Default Value

""

Remarks

Contains the billing street address of the credit card.

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

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

Data Type

String

SearchResultCustomerZip Property (GlobalTransactionSearch Class)

Contains the billing zip code of the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCustomerZip(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCustomerZip(INT iSearchResultIndex);

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

QString GetSearchResultCustomerZip(int iSearchResultIndex);

Default Value

""

Remarks

Contains the billing zip code of the credit card.

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

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

Data Type

String

SearchResultCVVResultCode Property (GlobalTransactionSearch Class)

Contains the card verification result code from the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultCVVResultCode(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultCVVResultCode(INT iSearchResultIndex);

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

QString GetSearchResultCVVResultCode(int iSearchResultIndex);

Default Value

""

Remarks

Contains the card verification result code from the card issuer.

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

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

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

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

Data Type

String

SearchResultEntryMode Property (GlobalTransactionSearch Class)

Indicates whether the card was swiped or manually keyed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchResultEntryMode(int iSearchResultIndex);

Unicode (Windows)
INT GetSearchResultEntryMode(INT iSearchResultIndex);

EM_NOT_SPECIFIED(0), 
EM_MANUAL_ENTRY(1), 
EM_SWIPED_ENTRY(2)

int dpaymentssdk_globaltransactionsearch_getsearchresultentrymode(void* lpObj, int searchresultindex);

int GetSearchResultEntryMode(int iSearchResultIndex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

SearchResultError Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultError(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultError(INT iSearchResultIndex);

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

QString GetSearchResultError(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultGratuityAmount Property (GlobalTransactionSearch Class)

Contains the tip portion of the TotalAmount .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultGratuityAmount(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultGratuityAmount(INT iSearchResultIndex);

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

QString GetSearchResultGratuityAmount(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultHostCode Property (GlobalTransactionSearch Class)

Action code returned by Global Payments.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultHostCode(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultHostCode(INT iSearchResultIndex);

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

QString GetSearchResultHostCode(int iSearchResultIndex);

Default Value

""

Remarks

Action code returned by Global Payments.

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

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

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

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

Data Type

String

SearchResultInvoiceNumber Property (GlobalTransactionSearch Class)

Contains the transactions invoice number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultInvoiceNumber(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultInvoiceNumber(INT iSearchResultIndex);

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

QString GetSearchResultInvoiceNumber(int iSearchResultIndex);

Default Value

""

Remarks

Contains the transactions invoice number.

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

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

Data Type

String

SearchResultLastModified Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultLastModified(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultLastModified(INT iSearchResultIndex);

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

QString GetSearchResultLastModified(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultNameOnCard Property (GlobalTransactionSearch Class)

Contains the cardholder's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultNameOnCard(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultNameOnCard(INT iSearchResultIndex);

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

QString GetSearchResultNameOnCard(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultOriginalPNRef Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultOriginalPNRef(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultOriginalPNRef(INT iSearchResultIndex);

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

QString GetSearchResultOriginalPNRef(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultPaymentType Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultPaymentType(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultPaymentType(INT iSearchResultIndex);

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

QString GetSearchResultPaymentType(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultPNRef Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultPNRef(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultPNRef(INT iSearchResultIndex);

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

QString GetSearchResultPNRef(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultProcessorId Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultProcessorId(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultProcessorId(INT iSearchResultIndex);

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

QString GetSearchResultProcessorId(int iSearchResultIndex);

Default Value

""

Remarks

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

Contains the name of the processing platform.

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

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

Data Type

String

SearchResultRegisterNumber Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultRegisterNumber(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultRegisterNumber(INT iSearchResultIndex);

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

QString GetSearchResultRegisterNumber(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultResellerKey Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultResellerKey(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultResellerKey(INT iSearchResultIndex);

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

QString GetSearchResultResellerKey(int iSearchResultIndex);

Default Value

""

Remarks

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

Contains the primary key of the Reseller table.

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

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

Data Type

String

SearchResultResponseCode Property (GlobalTransactionSearch Class)

Contains the transaction result code from the Global Transport Gateway.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultResponseCode(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultResponseCode(INT iSearchResultIndex);

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

QString GetSearchResultResponseCode(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultResponseMessage Property (GlobalTransactionSearch Class)

Contains a human-readable response message concerning the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultResponseMessage(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultResponseMessage(INT iSearchResultIndex);

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

QString GetSearchResultResponseMessage(int iSearchResultIndex);

Default Value

""

Remarks

Contains a human-readable response message concerning the transaction.

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

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

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

Data Type

String

SearchResultSettleDate Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultSettleDate(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultSettleDate(INT iSearchResultIndex);

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

QString GetSearchResultSettleDate(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultSettleFlag Property (GlobalTransactionSearch Class)

Indicates whether or not the transaction has been settled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchResultSettleFlag(int iSearchResultIndex);

Unicode (Windows)
BOOL GetSearchResultSettleFlag(INT iSearchResultIndex);

int dpaymentssdk_globaltransactionsearch_getsearchresultsettleflag(void* lpObj, int searchresultindex);

bool GetSearchResultSettleFlag(int iSearchResultIndex);

Default Value

FALSE

Remarks

Indicates whether or not the transaction has been settled.

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

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

Data Type

Boolean

SearchResultTotalAmount Property (GlobalTransactionSearch Class)

Contains the total amount of the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultTotalAmount(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultTotalAmount(INT iSearchResultIndex);

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

QString GetSearchResultTotalAmount(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultTransactionDate Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultTransactionDate(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultTransactionDate(INT iSearchResultIndex);

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

QString GetSearchResultTransactionDate(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultTransactionId Property (GlobalTransactionSearch Class)

Card issuer's Transaction Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultTransactionId(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultTransactionId(INT iSearchResultIndex);

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

QString GetSearchResultTransactionId(int iSearchResultIndex);

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

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

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

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

Data Type

String

SearchResultTransactionKey Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultTransactionKey(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultTransactionKey(INT iSearchResultIndex);

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

QString GetSearchResultTransactionKey(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SearchResultTransactionType Property (GlobalTransactionSearch Class)

Contains the transaction type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultTransactionType(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultTransactionType(INT iSearchResultIndex);

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

QString GetSearchResultTransactionType(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultUserId Property (GlobalTransactionSearch Class)

Contains the username used to process the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultUserId(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultUserId(INT iSearchResultIndex);

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

QString GetSearchResultUserId(int iSearchResultIndex);

Default Value

""

Remarks

Contains the username used to process the transaction.

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

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

Data Type

String

SearchResultVendorNumber Property (GlobalTransactionSearch Class)

Contains a number which uniquely identifies a merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchResultVendorNumber(int iSearchResultIndex);

Unicode (Windows)
LPWSTR GetSearchResultVendorNumber(INT iSearchResultIndex);

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

QString GetSearchResultVendorNumber(int iSearchResultIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SearchResultVoidFlag Property (GlobalTransactionSearch Class)

Indicates whether or not the transaction has been voided.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchResultVoidFlag(int iSearchResultIndex);

Unicode (Windows)
BOOL GetSearchResultVoidFlag(INT iSearchResultIndex);

int dpaymentssdk_globaltransactionsearch_getsearchresultvoidflag(void* lpObj, int searchresultindex);

bool GetSearchResultVoidFlag(int iSearchResultIndex);

Default Value

FALSE

Remarks

Indicates whether or not the transaction has been voided.

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

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

Data Type

Boolean

Server Property (GlobalTransactionSearch Class)

Global Payments transaction server.

Syntax

• C++
• C
• Qt

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

SSLAcceptServerCertEncoded Property (GlobalTransactionSearch Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

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

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (GlobalTransactionSearch Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

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

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

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

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

Default Value

"MY"

Remarks

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

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

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

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

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (GlobalTransactionSearch Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

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

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

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

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (GlobalTransactionSearch Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

0

Remarks

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

Possible values are:

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

SSLServerCertEncoded Property (GlobalTransactionSearch Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

SummaryCount Property (GlobalTransactionSearch Class)

The number of records in the SummaryResult arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryCount();

Unicode (Windows)
INT GetSummaryCount();

int dpaymentssdk_globaltransactionsearch_getsummarycount(void* lpObj);

int GetSummaryCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SummaryResultAuthorizationAmount
• SummaryResultAuthorizationCount
• SummaryResultCaptureAmount
• SummaryResultCaptureCount
• SummaryResultForceCaptureAmount
• SummaryResultForceCaptureCount
• SummaryResultPaymentType
• SummaryResultPostAuthAmount
• SummaryResultPostAuthCount
• SummaryResultRefundAmount
• SummaryResultRefundCount
• SummaryResultRepeatSaleAmount
• SummaryResultRepeatSaleCount
• SummaryResultSaleAmount
• SummaryResultSaleCount
• SummaryResultTotalCount

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

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

Data Type

Integer

SummaryResultAuthorizationAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultAuthorizationAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultAuthorizationAmount(INT iSummaryIndex);

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

QString GetSummaryResultAuthorizationAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SummaryResultAuthorizationCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultAuthorizationCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultAuthorizationCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultauthorizationcount(void* lpObj, int summaryindex);

int GetSummaryResultAuthorizationCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SummaryResultCaptureAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultCaptureAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultCaptureAmount(INT iSummaryIndex);

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

QString GetSummaryResultCaptureAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

SummaryResultCaptureCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultCaptureCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultCaptureCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultcapturecount(void* lpObj, int summaryindex);

int GetSummaryResultCaptureCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

SummaryResultForceCaptureAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultForceCaptureAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultForceCaptureAmount(INT iSummaryIndex);

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

QString GetSummaryResultForceCaptureAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SummaryResultForceCaptureCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultForceCaptureCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultForceCaptureCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultforcecapturecount(void* lpObj, int summaryindex);

int GetSummaryResultForceCaptureCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SummaryResultPaymentType Property (GlobalTransactionSearch Class)

The type of transactions being summarized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultPaymentType(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultPaymentType(INT iSummaryIndex);

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

QString GetSummaryResultPaymentType(int iSummaryIndex);

Default Value

""

Remarks

The type of transactions being summarized.

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

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

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

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

Data Type

String

SummaryResultPostAuthAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultPostAuthAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultPostAuthAmount(INT iSummaryIndex);

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

QString GetSummaryResultPostAuthAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SummaryResultPostAuthCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultPostAuthCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultPostAuthCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultpostauthcount(void* lpObj, int summaryindex);

int GetSummaryResultPostAuthCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SummaryResultRefundAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultRefundAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultRefundAmount(INT iSummaryIndex);

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

QString GetSummaryResultRefundAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SummaryResultRefundCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultRefundCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultRefundCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultrefundcount(void* lpObj, int summaryindex);

int GetSummaryResultRefundCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SummaryResultRepeatSaleAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultRepeatSaleAmount(INT iSummaryIndex);

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

QString GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SummaryResultRepeatSaleCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultRepeatSaleCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultrepeatsalecount(void* lpObj, int summaryindex);

int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SummaryResultSaleAmount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultSaleAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultSaleAmount(INT iSummaryIndex);

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

QString GetSummaryResultSaleAmount(int iSummaryIndex);

Default Value

""

Remarks

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

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

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

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

Data Type

String

SummaryResultSaleCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultSaleCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultSaleCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresultsalecount(void* lpObj, int summaryindex);

int GetSummaryResultSaleCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SummaryResultTotalCount Property (GlobalTransactionSearch Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultTotalCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultTotalCount(INT iSummaryIndex);

int dpaymentssdk_globaltransactionsearch_getsummaryresulttotalcount(void* lpObj, int summaryindex);

int GetSummaryResultTotalCount(int iSummaryIndex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

Timeout Property (GlobalTransactionSearch Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (GlobalTransactionSearch Class)

UserId for authentication with the Global Payments Server .

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• SearchCriteriaBatchNumber
• SearchBeginDate
• SearchCriteriaCardBreakdown
• SearchEndDate
• SearchRegisterNumber
• SearchUserId

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)

Interrupt the current method.

Syntax

• C++
• C
• Qt

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

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

Reset Method (GlobalTransactionSearch Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

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

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

Search Method (GlobalTransactionSearch Class)

Retrieves a list of payments that match the specified SearchCriteria .

Syntax

• C++
• C
• Qt

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 properties are optional. To retrieve information for one particular transaction, set the SearchPNRef property. All other properties will be ignored if the SearchPNRef property is set. The results of your search will be contained in the SearchResults collection.

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

Error Event (GlobalTransactionSearch Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

Config Settings (GlobalTransactionSearch Class)

GlobalTransactionSearch Config Settings

TCPClient Config Settings

SSL Config Settings

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