GlobalTransSearchCriteria Type
Specifies criteria to filter the transaction search.
Remarks
When performing a Search of transactions using the GlobalTransactionSearch component, this type is used to limit the results to those you are specifically interested in. The BeginDate and EndDate fields are required, unless the PNRef field is set. In that case, all other fields in the GlobalTransSearchCriteria are ignored, and only the PNRef is sent in the search request.
Fields
ApprovalCode String |
If provided, only those transactions matching the specified ApprovalCode will be included in the search results. This field may contain up to 6 alphanumeric characters and symbols. | ||||||||||||||||||||||||||||
BeginDate String |
The start of the date range in which to search for transactions. This field is required except when the PNRef field is provided. It may contain up to 19 alphanumeric characters and symbols. The BeginDate of the date range may be in MM/DD/YYYY (or YYYY-MMDD or YYYY-MM-DDThh:mm:ss) format. This date will be converted by the Global Payments system to YYYYMM- DDThh:mm:ss (time is in 24-hour format). If the value set in BeginDate does not contain time information, it will default to midnight on the given date. | ||||||||||||||||||||||||||||
CardNumber String |
If specified, only those transactions with the matching card number will be included in the search result. Wildcards may be used in this field. | ||||||||||||||||||||||||||||
CardType String |
If specified, only transactions made with the matching the CardType will be included in the search results. Valid values include:
| ||||||||||||||||||||||||||||
CustomerId String |
The CustomerId included in the original transaction. If provided, only those transactions made by the matching customer will be included in the search results. This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
EndDate String |
The end of the date range in which to search for transactions. This field is required except when the PNRef field is provided. It may contain up to 19 alphanumeric characters and symbols. The EndDate of the date range may be in MM/DD/YYYY (or YYYY-MMDD or YYYY-MM-DDThh:mm:ss) format. This date will be converted by the Global Payment system to YYYYMM- DDThh:mm:ss (time is in 24-hour format). If the value set in EndDate does not contain time information, it will be incremented to the next day at midnight such that no transaction on the desired end date will be excluded based on its time. | ||||||||||||||||||||||||||||
ExcludeCardType String |
If specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results. Valid values include:
This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
ExcludePaymentType String |
If specified, any transaction matching the ExcludePaymentType will be excluded from the search results. Valid values include:
This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
ExcludeResponseCode String |
If specified, any transactions matching the ExcludeResponseCode will be excluded from the search results. For instance, to exclude all approved transactions and return only declines, set the ExcludeResponseCode to "0". (As "0" is the response code for approved transactions). This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
ExcludeTransType String |
If specified, any transaction matching the ExcludeTransType will be excluded from the search results. Valid values include:
This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
ExcludeVoid Boolean |
Indicates whether or not to exclude void transactions from the search results. | ||||||||||||||||||||||||||||
InvoiceNumber String |
The InvoiceNumber that was included in the original transaction. If provided, only those transactions with matching InvoiceNumber will be included in the search results. Wildcards are allowed. This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
NameOnCard String |
Cardholder's name as it is appears on the card. If specified, only those transactions with the matching cardholder's name will be included in the search result. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234". | ||||||||||||||||||||||||||||
PaymentType String |
Only transactions matching the PaymentType will be included in the search results. Valid values include:
This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
PNRef String |
The unique payment reference number assigned to the transaction. If this field is provided all other search criteria fields will be ignored. This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
RegisterNumber String |
The RegisterNumber associated with the original transaction. If specified, only transactions that were sent with the matching RegisterNumber will be returned in the response. This field may contain up to 10 alphanumeric characters. | ||||||||||||||||||||||||||||
ResponseCode String |
If specified, only those transactions with the matching response code will be included in the search results. "0" indicates an approved transaction, anything else is a decline. Note that if you want all the declined transactions you should set ExcludeResponseCode to "0" (to exclude all approved transactions) instead. This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
SettleDate String |
The date of the settlement in MM/DD/YYYY or YYYY-MMDD format. | ||||||||||||||||||||||||||||
SettleFlag Boolean |
Indicates whether you wish to retrieve settled transactions or unsettled transactions. If set to true, only transactions that have been settled will be returned. If set to false (default), only transactions that have not been settled will be returned. | ||||||||||||||||||||||||||||
SettleMessage String |
The settlement ID or message returned from the host. If specified, only transactions with a matching SettleMessage value will be returned. | ||||||||||||||||||||||||||||
TransactionAmount String |
The original TransactionAmount of the transaction. This may be 11 characters in DDDDDDDD.CC format, left-justified with no fill (eg: "1.99"). If specified, only transactions with a matching TransactionAmount will be returned. This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
TransactionType String |
If provided, only those transactions matching the TransactionType will be included. Valid values when PaymentType is 0 (Credit) are:
Valid values when PaymentType is 1 (Debit) are:
Valid values when PaymentType is 2 (EBT) are:
This field is not applicable for Transaction Summaries. | ||||||||||||||||||||||||||||
UserId String |
The user who originated the transactions. If provided, only those transactions created by the matching User will be included in the search results. Wildcards are allowed. |
Constructors
[VB.NET] Public GlobalTransSearchCriteria() [C#] public GlobalTransSearchCriteria();