Retrieve Transactions report

Payment API - SourceTransactionsReport - API specification- calling our Payment API POST api/sourceTransactionsReport and /api/exportSourceTransactionsReport will return transaction history details by Integration Source.

Key Details:

• API Version: v1

• Endpoint: /api/sourceTransactionsReport and /api/exportSourceTransactionsReport

• Method: POST

• Purpose: Returns a transaction details.

Responses:

• 200 (Success): Returns a report details.

• 400 (Bad Request): Failure to create throws exception.

Components:

• TransactionReportDetails Response: Returns the transaction report details.

• BrokenRule: Represents an error in report creation with an error code and message.

• ProblemDetails: Details for any error response, including status, title, and description.

For the above two endpoint URLs: /api/sourceTransactionsReport will return the report data as a JSON response, and /api/exportSourceTransactionsReport will return the same data as a CSV.

Body Parameter Definitions:

Parameter	Description	Notes	Required?
Filters	--	--	Yes
Name	Name of the column to be filtered.	String, refer to response data field names for possible values	Yes
Operation	Which constraint operation to use when applying the filter.	Integer, see list of possible values below	Yes
Values	Array of filter terms to search for using the selected name and operation type.	String	Yes
SortColumns	--	--	No
Name	Name of the column by which to sort the results.	String, refer to response data field names for possible values	No
Descending	Determines if the sort will be ascending or descending.	Boolean	No
Order	If sorting by multiple columns, this determines the order in which the sorting is applied.	Integer, required when more than one sorting column is present	Yes*
PageSize	How many records to return per page.	Integer	No
PageIndex	Which page of results to return. Starts at 1 (0 will also return the first page).	Integer	Yes
Format	Export endpoint only: determines which file type the report will be exported to.	Valid values: "csv" or "excel"	Yes

Operation Field Values:

Value	Name	Description
2	ExactMatch	Filters for records that exactly match the provided search term.
3	StartsWith	Filters for records that start with the provided search term.
4	EndsWith	Filters for records that end with the provided search term.
5	Contains	Filters for records that contain the provided search term.
6	Before	Used for date-type columns, finds records where the date is prior to the provided date.
7	After	Used for date-type columns, finds records where the date is after the provided date.
9	GreaterThan	Compares numbers. Filters for records that are greater than the provided search term.
10	LessThan	Compares numbers. Filters for records that are less than the provided search term.
11	Equals	Compares numbers. Filters for records that are equal to the provided search term.
12	GreaterThanEqual	Compares numbers. Filters for records that are equal to or greater than the provided search term.
13	LessThanEqual	Compares numbers. Filters for records that are equal to or less than the provided search term.
18	NotContains	Inverse of Contains.
19	NotExactMatch	Inverse of ExactMatch.
20	NotStarts	Inverse of StartsWith.
21	NotEnds	Inverse of EndsWith.
22	NotEquals	Inverse of Equals.

Retrieve Transaction Report details

Example Request:

Here is a Sample request to get transactions report filters by PaymentDate after (operation 7 = After) January 1st 2026 (2026-01-01) sorted by PaymentDate column desc, returning pageIndex 1 and page size 1000 records:

POST /api/sourceTransactionsReport
{
  "Filters": [
    {
      "Name": "PaymentDate",
      "Operation": 7,
      "Values": [
        "2026-01-01"
      ]
    }
  ],
  "SortColumns": [
    {
      "Name": "PaymentDate",
      "Descending": true,
      "Order": 0
    }
  ],
  "PageSize": 1000,
  "PageIndex": 1
}

See report api here:

Reports