Reports
interface Reports
Methods
Get the batch totals for a particular site/date range, returning a standard format for all processors.
Get the approved batch totals for a particular site/date range, returning standard format for all processors.
Get the transactions in a specific batch, returning a standard BatchTransaction.
Gets daily summary for a clientid/siteid/date range.
Get the unforced authonly transactions for a particular site/date range, returning a standard BatchTransaction.
Get all transactions in the current unsettled batch, returning a standard BatchTransaction.
Get the details of a specific transaction with the same format as SearchTransactions.
Search all transactions for specific properties, standardized to match GetTransactionDetails.
Details
at line 31
mixed
getBatchHistory(GetBatchHistoryRequest $request, bool $timeout = false)
Get the batch totals for a particular site/date range, returning a standard format for all processors.
GetBatchHistory returns records representing data for each batch within the specified date range. Each record represents a batch of transactions, and contains a unique Batch ID that can be provided to GetClosedBatchTransactions to retrieve the actual transactions in that batch.
at line 47
mixed
getBatchSummary(GetBatchSummaryRequest $request, bool $timeout = false)
Get the approved batch totals for a particular site/date range, returning standard format for all processors.
GetBatchSummary iterates through batches in the specified date range and creates summations for the batches within the requested range. Transaction counts, gross sales, gross refunds and net income are returned whenever possible.
at line 63
mixed
getClosedBatchTransactions(GetClosedBatchTransactionsRequest $request, bool $timeout = false)
Get the transactions in a specific batch, returning a standard BatchTransaction.
GetClosedBatchTransactions lists the individual credit card transactions for the siteid and batched specified. A BatchTransaction item is returned for each transaction in the batch. Note that batches only contain credit/ debit card transactions and not check or gift card transactions.
at line 77
mixed
getDailySummary(GetDailySummaryRequest $request, bool $timeout = false)
Gets daily summary for a clientid/siteid/date range.
Produces transaction counts and amounts for the date range specified. Check, gift and card totals are listed separately, where card totals are broken out by brand (Visa/MasterCard/Discover, etc).
at line 95
mixed
getOpenAuths(GetOpenAuthsRequest $request, bool $timeout = false)
Get the unforced authonly transactions for a particular site/date range, returning a standard BatchTransaction.
Returns a BatchTransaction record for each AUTH that has not been VOIDed or FORCEd. Each of the auths will not be funded until the FORCE is performed. This command requires a DATE/TIME rather than just DATE. The format for DATE/TIME is in .NET/Microsoft SQL format of either 24-hour format as “MM/DD/YYYY HH:MM:SS.mmm” or the same format as 12-hour, with AM or PM appended to the date/time.
at line 110
mixed
getOpenBatch(GetOpenBatchRequest $request, bool $timeout = false)
Get all transactions in the current unsettled batch, returning a standard BatchTransaction.
Returns one BatchTransaction record for each transaction in the current batch. Note that for most processors, transactions in the open batch can still be VOIDed, UPDATEd, or have TIPEDIT performed.
at line 125
mixed
getTransactionDetails(GetTransactionDetailsRequest $request, bool $timeout = false)
Get the details of a specific transaction with the same format as SearchTransactions.
Returns a standard Transaction item, with all of the details needed to reprint a receipt or identify the type of transaction as card, check, or gift.
at line 143
mixed
searchTransactions(SearchTransactionsRequest $request, bool $timeout = false)
Search all transactions for specific properties, standardized to match GetTransactionDetails.
Returns a standard Transaction item for each item in the search criteria. Transaction search is done by date range. Just the count, or the transactions themselves can be returned. A maximum can be set so that the return set is limited. The order can be reversed by specifying “reverseorder” in the search criteria, which causes the items to be returned with the most recent first.