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.

Class Name

DPaymentsSDK_GlobalTransactionSearch

Procedural Interface

 dpaymentssdk_globaltransactionsearch_open();
 dpaymentssdk_globaltransactionsearch_close($res);
 dpaymentssdk_globaltransactionsearch_register_callback($res, $id, $function);
 dpaymentssdk_globaltransactionsearch_get_last_error($res);
 dpaymentssdk_globaltransactionsearch_get_last_error_code($res);
 dpaymentssdk_globaltransactionsearch_set($res, $id, $index, $value);
 dpaymentssdk_globaltransactionsearch_get($res, $id, $index);
 dpaymentssdk_globaltransactionsearch_do_config($res, $configurationstring);
 dpaymentssdk_globaltransactionsearch_do_gettransactionsummary($res);
 dpaymentssdk_globaltransactionsearch_do_interrupt($res);
 dpaymentssdk_globaltransactionsearch_do_reset($res);
 dpaymentssdk_globaltransactionsearch_do_search($res);

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

Password for authentication with the Global Payments Server .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 1 );


dpaymentssdk_globaltransactionsearch_set($res, 1, $value );

Default Value

''

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_GlobalTransactionSearch Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 2 );


dpaymentssdk_globaltransactionsearch_set($res, 2, $value );

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

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 3 );


dpaymentssdk_globaltransactionsearch_set($res, 3, $value );

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

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 4 );


dpaymentssdk_globaltransactionsearch_set($res, 4, $value );

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

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 5 );


dpaymentssdk_globaltransactionsearch_set($res, 5, $value );

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

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 6 );


dpaymentssdk_globaltransactionsearch_set($res, 6, $value );

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

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 7 );


dpaymentssdk_globaltransactionsearch_set($res, 7, $value );

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

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 8 );


dpaymentssdk_globaltransactionsearch_set($res, 8, $value );

Default Value

''

Remarks

This property contains a user name, 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

SearchApprovalCode Property (DPaymentsSDK_GlobalTransactionSearch Class)

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

Object Oriented Interface

public function getSearchApprovalCode();


public function setSearchApprovalCode($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 9 );


dpaymentssdk_globaltransactionsearch_set($res, 9, $value );

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

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

Object Oriented Interface

public function getSearchBeginDate();


public function setSearchBeginDate($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 10 );


dpaymentssdk_globaltransactionsearch_set($res, 10, $value );

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

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

Object Oriented Interface

public function getSearchCardNumber();


public function setSearchCardNumber($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 11 );


dpaymentssdk_globaltransactionsearch_set($res, 11, $value );

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

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

Object Oriented Interface

public function getSearchCardType();


public function setSearchCardType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 12 );


dpaymentssdk_globaltransactionsearch_set($res, 12, $value );

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

The CustomerId included in the original transaction.

Object Oriented Interface

public function getSearchCustomerId();


public function setSearchCustomerId($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 13 );


dpaymentssdk_globaltransactionsearch_set($res, 13, $value );

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

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

Object Oriented Interface

public function getSearchEndDate();


public function setSearchEndDate($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 14 );


dpaymentssdk_globaltransactionsearch_set($res, 14, $value );

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

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

Object Oriented Interface

public function getSearchExcludeCardType();


public function setSearchExcludeCardType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 15 );


dpaymentssdk_globaltransactionsearch_set($res, 15, $value );

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

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

Object Oriented Interface

public function getSearchExcludePaymentType();


public function setSearchExcludePaymentType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 16 );


dpaymentssdk_globaltransactionsearch_set($res, 16, $value );

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

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

Object Oriented Interface

public function getSearchExcludeResponseCode();


public function setSearchExcludeResponseCode($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 17 );


dpaymentssdk_globaltransactionsearch_set($res, 17, $value );

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

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

Object Oriented Interface

public function getSearchExcludeTransType();


public function setSearchExcludeTransType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 18 );


dpaymentssdk_globaltransactionsearch_set($res, 18, $value );

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

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

Object Oriented Interface

public function getSearchExcludeVoid();


public function setSearchExcludeVoid($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 19 );


dpaymentssdk_globaltransactionsearch_set($res, 19, $value );

Default Value

false

Remarks

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

Data Type

Boolean

SearchInvoiceNumber Property (DPaymentsSDK_GlobalTransactionSearch Class)

The InvoiceNumber that was included in the original transaction.

Object Oriented Interface

public function getSearchInvoiceNumber();


public function setSearchInvoiceNumber($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 20 );


dpaymentssdk_globaltransactionsearch_set($res, 20, $value );

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

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

Object Oriented Interface

public function getSearchNameOnCard();


public function setSearchNameOnCard($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 21 );


dpaymentssdk_globaltransactionsearch_set($res, 21, $value );

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

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

Object Oriented Interface

public function getSearchPaymentType();


public function setSearchPaymentType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 22 );


dpaymentssdk_globaltransactionsearch_set($res, 22, $value );

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

The unique payment reference number assigned to the transaction.

Object Oriented Interface

public function getSearchPNRef();


public function setSearchPNRef($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 23 );


dpaymentssdk_globaltransactionsearch_set($res, 23, $value );

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

The RegisterNumber associated with the original transaction.

Object Oriented Interface

public function getSearchRegisterNumber();


public function setSearchRegisterNumber($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 24 );


dpaymentssdk_globaltransactionsearch_set($res, 24, $value );

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

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

Object Oriented Interface

public function getSearchResponseCode();


public function setSearchResponseCode($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 25 );


dpaymentssdk_globaltransactionsearch_set($res, 25, $value );

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

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

Object Oriented Interface

public function getSearchSettleDate();


public function setSearchSettleDate($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 26 );


dpaymentssdk_globaltransactionsearch_set($res, 26, $value );

Default Value

''

Remarks

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

Data Type

String

SearchSettleFlag Property (DPaymentsSDK_GlobalTransactionSearch Class)

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

Object Oriented Interface

public function getSearchSettleFlag();


public function setSearchSettleFlag($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 27 );


dpaymentssdk_globaltransactionsearch_set($res, 27, $value );

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

The settlement ID or message returned from the host.

Object Oriented Interface

public function getSearchSettleMessage();


public function setSearchSettleMessage($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 28 );


dpaymentssdk_globaltransactionsearch_set($res, 28, $value );

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

The original TransactionAmount of the transaction.

Object Oriented Interface

public function getSearchTransactionAmount();


public function setSearchTransactionAmount($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 29 );


dpaymentssdk_globaltransactionsearch_set($res, 29, $value );

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

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

Object Oriented Interface

public function getSearchTransactionType();


public function setSearchTransactionType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 30 );


dpaymentssdk_globaltransactionsearch_set($res, 30, $value );

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

The user who originated the transactions.

Object Oriented Interface

public function getSearchUserId();


public function setSearchUserId($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 31 );


dpaymentssdk_globaltransactionsearch_set($res, 31, $value );

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

The number of records in the SearchResult arrays.

Object Oriented Interface

public function getSearchResultCount();

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 32 );

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

Contains the transaction authorization code from the card issuer.

Object Oriented Interface

public function getSearchResultApprovalCode($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 33 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultAuthorizedAmount($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 34 , $searchresultindex);

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

Contains the address verification result code from the card issuer.

Object Oriented Interface

public function getSearchResultAVSResultCode($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 35 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultBatchNumber($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 36 , $searchresultindex);

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

Contains the credit card expiration date.

Object Oriented Interface

public function getSearchResultCardExpDate($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 37 , $searchresultindex);

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

Contains the credit card number used in the transaction.

Object Oriented Interface

public function getSearchResultCardNumber($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 38 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultCardPresent($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 39 , $searchresultindex);

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

Indicates the card type or payment method.

Object Oriented Interface

public function getSearchResultCardType($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 40 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultCashBackAmount($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 41 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultClientIP($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 42 , $searchresultindex);

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

Identifies the customer that initiated the transaction.

Object Oriented Interface

public function getSearchResultCustomerId($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 43 , $searchresultindex);

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

Contains the billing street address of the credit card.

Object Oriented Interface

public function getSearchResultCustomerStreet($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 44 , $searchresultindex);

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

Contains the billing zip code of the credit card.

Object Oriented Interface

public function getSearchResultCustomerZip($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 45 , $searchresultindex);

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

Contains the card verification result code from the card issuer.

Object Oriented Interface

public function getSearchResultCVVResultCode($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 46 , $searchresultindex);

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

Indicates whether the card was swiped or manually keyed.

Object Oriented Interface

public function getSearchResultEntryMode($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 47 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultError($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 48 , $searchresultindex);

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

Contains the tip portion of the TotalAmount .

Object Oriented Interface

public function getSearchResultGratuityAmount($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 49 , $searchresultindex);

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

Action code returned by Global Payments.

Object Oriented Interface

public function getSearchResultHostCode($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 50 , $searchresultindex);

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

Contains the transactions invoice number.

Object Oriented Interface

public function getSearchResultInvoiceNumber($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 51 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultLastModified($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 52 , $searchresultindex);

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

Contains the cardholder's name.

Object Oriented Interface

public function getSearchResultNameOnCard($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 53 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultOriginalPNRef($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 54 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultPaymentType($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 55 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultPNRef($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 56 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultProcessorId($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 57 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultRegisterNumber($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 58 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultResellerKey($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 59 , $searchresultindex);

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

Contains the transaction result code from the Global Transport Gateway.

Object Oriented Interface

public function getSearchResultResponseCode($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 60 , $searchresultindex);

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

Contains a human-readable response message concerning the transaction.

Object Oriented Interface

public function getSearchResultResponseMessage($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 61 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultSettleDate($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 62 , $searchresultindex);

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

Indicates whether or not the transaction has been settled.

Object Oriented Interface

public function getSearchResultSettleFlag($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 63 , $searchresultindex);

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

Contains the total amount of the transaction.

Object Oriented Interface

public function getSearchResultTotalAmount($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 64 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultTransactionDate($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 65 , $searchresultindex);

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

Card issuer's Transaction Reference Number.

Object Oriented Interface

public function getSearchResultTransactionId($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 66 , $searchresultindex);

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

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

Object Oriented Interface

public function getSearchResultTransactionKey($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 67 , $searchresultindex);

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

Contains the transaction type.

Object Oriented Interface

public function getSearchResultTransactionType($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 68 , $searchresultindex);

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

Contains the username used to process the transaction.

Object Oriented Interface

public function getSearchResultUserId($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 69 , $searchresultindex);

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

Contains a number which uniquely identifies a merchant.

Object Oriented Interface

public function getSearchResultVendorNumber($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 70 , $searchresultindex);

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

Indicates whether or not the transaction has been voided.

Object Oriented Interface

public function getSearchResultVoidFlag($searchresultindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 71 , $searchresultindex);

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

Global Payments transaction server.

Object Oriented Interface

public function getServer();


public function setServer($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 72 );


dpaymentssdk_globaltransactionsearch_set($res, 72, $value );

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

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 74 );


dpaymentssdk_globaltransactionsearch_set($res, 74, $value );

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

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 102 );


dpaymentssdk_globaltransactionsearch_set($res, 102, $value );

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

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 118 );


dpaymentssdk_globaltransactionsearch_set($res, 118, $value );

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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_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.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 119 );


dpaymentssdk_globaltransactionsearch_set($res, 119, $value );

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

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 120 );


dpaymentssdk_globaltransactionsearch_set($res, 120, $value );

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

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 121 );


dpaymentssdk_globaltransactionsearch_set($res, 121, $value );

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 displayed below.

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

Data Type

String

SSLProvider Property (DPaymentsSDK_GlobalTransactionSearch Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 129 );


dpaymentssdk_globaltransactionsearch_set($res, 129, $value );

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

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 131 );

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

The number of records in the SummaryResult arrays.

Object Oriented Interface

public function getSummaryCount();

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 158 );

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

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

Object Oriented Interface

public function getSummaryResultAuthorizationAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 159 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultAuthorizationCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 160 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultCaptureAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 161 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultCaptureCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 162 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultForceCaptureAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 163 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultForceCaptureCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 164 , $summaryindex);

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

The type of transactions being summarized.

Object Oriented Interface

public function getSummaryResultPaymentType($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 165 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultPostAuthAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 166 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultPostAuthCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 167 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultRefundAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 168 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultRefundCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 169 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultRepeatSaleAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 170 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultRepeatSaleCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 171 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultSaleAmount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 172 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultSaleCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 173 , $summaryindex);

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

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

Object Oriented Interface

public function getSummaryResultTotalCount($summaryindex);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 174 , $summaryindex);

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 175 );


dpaymentssdk_globaltransactionsearch_set($res, 175, $value );

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

UserId for authentication with the Global Payments Server .

Object Oriented Interface

public function getUserId();


public function setUserId($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 176 );


dpaymentssdk_globaltransactionsearch_set($res, 176, $value );

Default Value

''

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (DPaymentsSDK_GlobalTransactionSearch Class)

The merchant's RP/Vendor number.

Object Oriented Interface

public function getVendorNumber();


public function setVendorNumber($value);

Procedural Interface

dpaymentssdk_globaltransactionsearch_get($res, 177 );


dpaymentssdk_globaltransactionsearch_set($res, 177, $value );

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_globaltransactionsearch_do_config($res, $configurationstring);

Remarks

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

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

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

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

GetTransactionSummary Method (DPaymentsSDK_GlobalTransactionSearch Class)

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

Object Oriented Interface

public function doGetTransactionSummary();

Procedural Interface

dpaymentssdk_globaltransactionsearch_do_gettransactionsummary($res);

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

Interrupt Method (DPaymentsSDK_GlobalTransactionSearch Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_globaltransactionsearch_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_GlobalTransactionSearch Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_globaltransactionsearch_do_reset($res);

Remarks

This method clears all properties to their default values.

Search Method (DPaymentsSDK_GlobalTransactionSearch Class)

Retrieves a list of payments that match the specified SearchCriteria .

Object Oriented Interface

public function doSearch();

Procedural Interface

dpaymentssdk_globaltransactionsearch_do_search($res);

Remarks

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

Error Event (DPaymentsSDK_GlobalTransactionSearch Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_globaltransactionsearch_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (DPaymentsSDK_GlobalTransactionSearch Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_globaltransactionsearch_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_globaltransactionsearch_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_GlobalTransactionSearch Class)

Shows the progress of the Global Payments connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_globaltransactionsearch_register_callback($res, 4, array($this, 'fireStatus'));

Parameter List

 'message'

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (GlobalTransactionSearch Class)

GlobalTransactionSearch Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors