2013

Using the Reporting API
Performing Searches
2
20 Gateway Reporting Developer Guide
Performing Searches
Using the Reporting API, you can search for transaction data by any of the following search
names.
 TransactionIDSearch
 BatchIDSearch
 AccountNumberSearch
 CommentSearch
 AccountNumberRefSearch
 PurchaseOrderSearch
 RecurringBillingProfileIDSearch
 RecurringBillingProfileNameSearch
 RecurringBillingAccountNumberSearch
 RecurringBillingCommentSearch
 RecurringBillingAmountSearch
Step 1. Run the search request
To run a search request, call runSearchRequest with the following parameters.
runSearchRequest(searchName, reportParam(s), pageSize)
runSearchResponse returns the reportId for this search as well as the statusCode
and statusMsg. The reportId returned is valid for up to 120 days.
Step 2. Get the metadata
Request to get the search metadata by calling getMetaDataRequest. See “Step 2. Get the
metadata” on page 15.
Step 3. Get the report data
Request to get the search data by calling getDataRequest. See “Step 3. Get the report
data” on page 15.
searchName One of the search names listed above, for example,
TransactionIDSearch.
reportParam(s) paramName and paramValue of one or more input parameters for this
search. See
Appendix C, “Report Parameters,” for the required and
optional parameters.
pageSize Number of rows of data per page. Default is 50.