v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

TSYS Batch Transaction Report

Retrieve a report of batch transactions

get/tsys/batch/transactions

Query parameters

bankNumberstring

Filter reports based on bank number provided

batchDatestring

Filter reports based on batch date provided

batchNumbersstring[]

Filter reports based on batch numbers provided

fromstring

Defines the number of records to offset

groupBystring

Defines what field to group by

searchstring

Search across searchField for this value

sizestring

Defines how many records to return at a time

sortstring

Allows you to sort the matching results.

termIDstring

Filter reports based on terminal id provided

fundingOriginstring

fundingOrigin

excludeFieldsstring

includeFieldsstring

batchNumberinteger

Defines what batch number to filter by

cardTypestring

Defines what cardtype to filter by

endDatestring

Defines what date to filter by

maxAmountstring

Defines max amount to filter by

minAmountstring

Defines min amount to filter by

startDatestring

Defines what date to filter by

summaryboolean

Defines whether or not we should only return the summary

typestring

Defines what type to filter by

dr_countnumber float

Describes the magnitude of a relative date range.

dr_fromstring date

Lower bound of an absolute date range.

dr_quickstring

Key descriptor for a quick date range.

dr_tostring date

Upper bound of an absolute date range.

dr_typestring

Type of date range filter being used. (q, rel, abs)

dr_unitstring

Describes the unit of a relative date range.

Response

200

recordCountinteger

totalRecordsinteger

Example response

{
  "records": [
    {
      "transactionType": "string",
      "cardType": "string",
      "cardNumber": "string",
      "entryMode": "string",
      "qualification": "string",
      "authorizationCode": "string",
      "bankNumber": "string",
      "transactionDate": "2020-08-03T20:10:37.449Z"
    }
  ]
}