GlobalTransactionSearch Control
Properties Methods Events Configuration Settings Errors
The GlobalTransactionSearch component is used to search for transactions made using the Global Transport Direct API. It can search for transactions in the open batch or in any previously closed batch.
Syntax
GlobalTransactionSearch
Remarks
This control 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 control 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 control with short descriptions. Click on the links for further details.
| Password | Password for authentication with the Global Payments Server . |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| SearchApprovalCode | If provided, only those transactions matching the specified ApprovalCode will be included in the search results. |
| SearchBeginDate | The start of the date range in which to search for transactions. |
| SearchCardNumber | If specified, only those transactions with the matching card number will be included in the search result. |
| SearchCardType | If specified, only transactions made with the matching the CardType will be included in the search results. |
| SearchCustomerId | The CustomerId included in the original transaction. |
| SearchEndDate | The end of the date range in which to search for transactions. |
| SearchExcludeCardType | If specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results. |
| SearchExcludePaymentType | If specified, any transaction matching the ExcludePaymentType will be excluded from the search results. |
| SearchExcludeResponseCode | If specified, any transactions matching the ExcludeResponseCode will be excluded from the search results. |
| SearchExcludeTransType | If specified, any transaction matching the ExcludeTransType will be excluded from the search results. |
| SearchExcludeVoid | Indicates whether or not to exclude void transactions from the search results. |
| SearchInvoiceNumber | The InvoiceNumber that was included in the original transaction. |
| SearchNameOnCard | Cardholder's name as it is appears on the card. |
| SearchPaymentType | Only transactions matching the PaymentType will be included in the search results. |
| SearchPNRef | The unique payment reference number assigned to the transaction. |
| SearchRegisterNumber | The RegisterNumber associated with the original transaction. |
| SearchResponseCode | If specified, only those transactions with the matching response code will be included in the search results. |
| SearchSettleDate | The date of the settlement in MM/DD/YYYY or YYYY-MMDD format. |
| SearchSettleFlag | Indicates whether you wish to retrieve settled transactions or unsettled transactions. |
| SearchSettleMessage | The settlement ID or message returned from the host. |
| SearchTransactionAmount | The original TransactionAmount of the transaction. |
| SearchTransactionType | If provided, only those transactions matching the TransactionType will be included. |
| SearchUserId | The user who originated the transactions. |
| SearchResultCount | The number of records in the SearchResult arrays. |
| SearchResultCardExpDate | Contains the credit card expiration date. |
| SearchResultCardNumber | Contains the credit card number used in the transaction. |
| SearchResultCardPresent | Indicates whether or not this was a card-present transaction. |
| SearchResultCashBackAmount | Contains the cash back amount for a debit or EBT transaction. |
| SearchResultClientIP | * No longer supported as the underlying Global API has changed. |
| SearchResultCustomerId | Identifies the customer that initiated the transaction. |
| SearchResultCustomerStreet | Contains the billing street address of the credit card. |
| SearchResultCustomerZip | Contains the billing zip code of the credit card. |
| SearchResultEntryMode | Indicates whether the card was swiped or manually keyed. |
| SearchResultError | * No longer supported as the underlying Global API has changed. |
| SearchResultApprovalCode | Contains the transaction authorization code from the card issuer. |
| SearchResultAuthorizedAmount | In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized. |
| SearchResultAVSResultCode | Contains the address verification result code from the card issuer. |
| SearchResultBatchNumber | The number of the batch this transaction is currently contained in. |
| SearchResultCardType | Indicates the card type or payment method. |
| SearchResultCVVResultCode | Contains the card verification result code from the card issuer. |
| SearchResultHostCode | Action code returned by Global Payments. |
| SearchResultPNRef | Contains a number which uniquely identifies the transaction in the Global Transport system. |
| SearchResultTransactionId | Card issuer's Transaction Reference Number. |
| SearchResultGratuityAmount | Contains the tip portion of the TotalAmount . |
| SearchResultInvoiceNumber | Contains the transactions invoice number. |
| SearchResultLastModified | Contains the date and time on which the transaction was last modified. |
| SearchResultNameOnCard | Contains the cardholder's name. |
| SearchResultOriginalPNRef | Contains the Global Transport Gateway PNRef on which the current transaction is based. |
| SearchResultPaymentType | * No longer supported as the underlying Global API has changed. |
| SearchResultProcessorId | * No longer supported as the underlying Global API has changed. |
| SearchResultRegisterNumber | A number that uniquely identifies the register or computer on which the transaction was performed. |
| SearchResultResellerKey | * No longer supported as the underlying Global API has changed. |
| SearchResultResponseCode | Contains the transaction result code from the Global Transport Gateway. |
| SearchResultResponseMessage | Contains a human-readable response message concerning the transaction. |
| SearchResultSettleDate | * No longer supported as the underlying Global API has changed. |
| SearchResultSettleFlag | Indicates whether or not the transaction has been settled. |
| SearchResultTotalAmount | Contains the total amount of the transaction. |
| SearchResultTransactionDate | * No longer supported as the underlying Global API has changed. |
| SearchResultTransactionKey | * No longer supported as the underlying Global API has changed. |
| SearchResultTransactionType | Contains the transaction type. |
| SearchResultUserId | Contains the username used to process the transaction. |
| SearchResultVendorNumber | Contains a number which uniquely identifies a merchant. |
| SearchResultVoidFlag | Indicates whether or not the transaction has been voided. |
| Server | Global Payments transaction server. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| SummaryCount | The number of records in the SummaryResult arrays. |
| SummaryResultAuthorizationAmount | Contains the dollar amount authorized for all transactions for the indicated PaymentType . |
| SummaryResultAuthorizationCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultCaptureAmount | Contains the dollar amount captured for all transactions for the indicated PaymentType . |
| SummaryResultCaptureCount | Contains the transaction count of all transactions that have been settled for the indicated PaymentType . |
| SummaryResultForceCaptureAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultForceCaptureCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultPaymentType | The type of transactions being summarized. |
| SummaryResultPostAuthAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultPostAuthCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRefundAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRefundCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRepeatSaleAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRepeatSaleCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultSaleAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultSaleCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultTotalCount | Contains the total count of all transactions for the indicated PaymentType . |
| Timeout | A timeout for the component. |
| UserId | UserId for authentication with the Global Payments Server . |
| VendorNumber | The merchant's RP/Vendor number. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| GetTransactionSummary | Retrieves a payment type transaction summary that matches the specified SearchCriteria . |
| Interrupt | Interrupt the current method. |
| Reset | Clears all properties to their default values. |
| Search | Retrieves a list of payments that match the specified SearchCriteria . |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| Status | Shows the progress of the Global Payments connection. |
Configuration Settings
The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.
| SearchCriteriaBatchNumber | Filters a Search or TransactionSummary based on the BatchNumber. |
| SearchCriteriaCardBreakdown | Identifies whether to breakdown Transaction Summaries by card type. |
| SearchCriteriaCustomerId | Filters a Search based on the CustomerId. |
| SearchCriteriaIncludeCustomFields | Identifies whether to include custom fields in the Search results. |
| SearchCriteriaPONumber | Filters a Search based on the PONumber. |
| RawRequest | Returns the request sent to the server for debugging purposes. |
| RawResponse | Returns the response received from the server for debugging purposes. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |