v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

FirstData Batch Report

Retrieve a report of merchant settlement.

get/fd/batch

Query parameters

sortstring

Allows you to sort the matching results.

searchstring

Search across searchField for this value

frominteger

Defines the number of records to offset

sizeinteger

Defines how many records to return at a time

groupBystring

Defines what field to group by

typestring

Defines what type to filter by

minAmountstring

Defines min amount to filter by

maxAmountstring

Defines max amount to filter by

startDatestring

Defines what date to filter by

endDatestring

Defines what date to filter by

summaryboolean

Defines whether or not we should only return the summary

dr_typestring

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

dr_fromstring date

Lower bound of an absolute date range.

dr_tostring date

Upper bound of an absolute date range.

dr_countstring

Describes the magnitude of a relative date range.

dr_unitstring

Describes the unit of a relative date range.

dr_quickstring

Key descriptor for a quick date range. (today, thisWeek, thisMonth, thisYear, yesterday, previousWeek, previousYear, thisDaySoFar, weekToDate, monthToDate, yearToDate, last_15_m, last_30_m, last_1_h, last_24_h, last_7_d, last_30_day, etc.)

Response

200

recordCountinteger

totalRecordsinteger

Example response

{
  "records": [
    {
      "locationName": "string",
      "accountNumber": "string",
      "transactionType": "string",
      "cardType": "string",
      "cardNumber": "string",
      "entryMode": "string",
      "qualCode": "string",
      "authorizationCode": "string",
      "transactionDate": "2020-07-31T20:19:07.395Z"
    }
  ]
}