TSYS Batch Transactions Report

get

https://sandbox-api.prioritycommerce.com/v1/checkout/report/v1/tsys/batch/transactions

Retrieve the TSYS Batch Transactions Report. Results are restricted to the PCE API key's authorized merchant scope and the supported criteria below. Amount criteria apply to amount; date-range criteria apply to batchDate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort

string

Defaults to batchDate:desc

Sort by field[:asc|desc]. A direction omitted by the caller defaults to ascending. Field names are processor-specific.

from

int32

≥ 0

Defaults to 0

Zero-based number of matching records to skip.

size

int32

1 to 100

Defaults to 10

Records per page. For isExport=true, the downstream export page size; the accumulated response may contain more records.

accountNumbers

array of strings

Filter reports based on account numbers provided. Optional array of strings, serialized as comma-separated values in one query parameter. Preserve leading zeros. Only accounts within the API key's authorized scope can contribute results. Omit to apply no additional account filter.

accountNumbers

string

Wildcard search across authorizationCode, cardNumber.mask. The handler fixes these fields; enter the value to search for.

minAmount

string

Inclusive lower bound on amount, supplied as a numeric string.

maxAmount

string

Exclusive upper bound on amount, supplied as a numeric string.

startDate

date

Start calendar date in YYYY-MM-DD format. Normalized to 00:00:00.000 UTC. With dr_type=abs, bounds batchDate. Defaults to the date two years before today.

endDate

date

End calendar date in YYYY-MM-DD format. Normalized to 23:59:59.999 UTC. With dr_type=abs, bounds batchDate. Defaults to today.

dr_type

string

enum

Defaults to abs

Date-range mode for batchDate. abs uses startDate/endDate; rel requires nonzero dr_count and dr_unit and uses a look-back window ending now.

Allowed:

dr_count

float

Magnitude of the relative look-back window. Use with dr_type=rel and dr_unit. Must be nonzero so the wrapper forwards it.

dr_unit

string

enum

Relative date-range unit; use with dr_type=rel and dr_count. Case matters: m means minutes and M means months.

batchNumber

integer

Filter by a single batch number. Additional batchDate and account criteria can disambiguate batches.

batchDate

string

Exact batchDate filter, in addition to date-range criteria.

cardType

string

Card-type filter on cardType. Supply processor-specific values as a comma-separated string; any disables this filter. The handler expands discover to include discover fq, and american express to include american express optblue and amex.

type

string

Transaction-type filter on transactionTypeDescription. Supply processor-specific values as a comma-separated string; any disables this filter.

isExport

boolean

Defaults to false

Accumulate downstream export pages into one JSON report. This is not a CSV download or an unlimited export. The implementation stops requesting further pages after its accumulated-count threshold is crossed (the last whole page can bring the count to 10,000 or more). Compare recordCount with totalRecords.

Responses

default

PCE authentication/authorization error, request-validation error or report-service error. Missing or invalid x-api-key values are rejected by PCE. The wrapper's error payload is not specified by the MXM repository.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful JSON report response.