Skip to main content
POST
/
api
/
adm
/
reportTransactions
/
search
Search Transaction Reports
curl --request POST \
  --url https://localhost:44371/api/adm/reportTransactions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "returnAllIfCountLessThan": 123,
  "offset": 123,
  "limit": 123,
  "filter": {
    "tags": [
      {
        "label": "<string>",
        "item": {
          "value": "<string>",
          "condition": "Equals"
        }
      }
    ],
    "id": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "week": [
      {
        "value": 123,
        "condition": "Equals"
      }
    ],
    "month": [
      {
        "value": 123,
        "condition": "Equals"
      }
    ],
    "eventId": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "resultCode": [
      {
        "value": "Undefined",
        "condition": "Equals"
      }
    ],
    "eventType": [
      {
        "value": "Authorize",
        "condition": "Equals"
      }
    ],
    "eventResult": [
      {
        "value": "Pending",
        "condition": "Equals"
      }
    ],
    "eventWeek": [
      {
        "value": 123,
        "condition": "Equals"
      }
    ],
    "eventMonth": [
      {
        "value": 123,
        "condition": "Equals"
      }
    ],
    "validCVV": [
      {
        "value": true,
        "condition": "Equals"
      }
    ],
    "ccType": [
      {
        "value": "VISA",
        "condition": "Equals"
      }
    ],
    "projectName": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "dateTime": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "time": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "date": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "year": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "eventDateTime": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "eventTime": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "eventDate": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "eventYear": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "ip": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "fingerprint": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "email": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "ccLast4": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "ccExpirationDate": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingFirstName": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingLastName": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingAddressLine1": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingAddressLine2": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingCity": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingState": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingZip": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "billingCountry": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryFirstName": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryLastName": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryAddressLine1": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryAddressLine2": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryCity": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryState": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryZip": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ],
    "deliveryCountry": [
      {
        "value": "<string>",
        "condition": "Equals"
      }
    ]
  },
  "order": {
    "tags": [
      {
        "index": 123,
        "option": "Asc",
        "label": "<string>"
      }
    ],
    "projectName": {
      "index": 123,
      "option": "Asc"
    },
    "id": {
      "index": 123,
      "option": "Asc"
    },
    "dateTime": {
      "index": 123,
      "option": "Asc"
    },
    "time": {
      "index": 123,
      "option": "Asc"
    },
    "date": {
      "index": 123,
      "option": "Asc"
    },
    "week": {
      "index": 123,
      "option": "Asc"
    },
    "month": {
      "index": 123,
      "option": "Asc"
    },
    "year": {
      "index": 123,
      "option": "Asc"
    },
    "resultCode": {
      "index": 123,
      "option": "Asc"
    },
    "eventId": {
      "index": 123,
      "option": "Asc"
    },
    "eventType": {
      "index": 123,
      "option": "Asc"
    },
    "eventResult": {
      "index": 123,
      "option": "Asc"
    },
    "eventDateTime": {
      "index": 123,
      "option": "Asc"
    },
    "eventTime": {
      "index": 123,
      "option": "Asc"
    },
    "eventDate": {
      "index": 123,
      "option": "Asc"
    },
    "eventWeek": {
      "index": 123,
      "option": "Asc"
    },
    "eventMonth": {
      "index": 123,
      "option": "Asc"
    },
    "eventYear": {
      "index": 123,
      "option": "Asc"
    },
    "ip": {
      "index": 123,
      "option": "Asc"
    },
    "fingerprint": {
      "index": 123,
      "option": "Asc"
    },
    "validCVV": {
      "index": 123,
      "option": "Asc"
    },
    "billingFirstName": {
      "index": 123,
      "option": "Asc"
    },
    "billingLastName": {
      "index": 123,
      "option": "Asc"
    },
    "email": {
      "index": 123,
      "option": "Asc"
    },
    "ccType": {
      "index": 123,
      "option": "Asc"
    },
    "ccLast4": {
      "index": 123,
      "option": "Asc"
    },
    "ccExpirationDate": {
      "index": 123,
      "option": "Asc"
    },
    "billingAddressLine1": {
      "index": 123,
      "option": "Asc"
    },
    "billingAddressLine2": {
      "index": 123,
      "option": "Asc"
    },
    "billingCity": {
      "index": 123,
      "option": "Asc"
    },
    "billingState": {
      "index": 123,
      "option": "Asc"
    },
    "billingZip": {
      "index": 123,
      "option": "Asc"
    },
    "billingCountry": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryFirstName": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryLastName": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryAddressLine1": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryAddressLine2": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryCity": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryState": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryZip": {
      "index": 123,
      "option": "Asc"
    },
    "deliveryCountry": {
      "index": 123,
      "option": "Asc"
    }
  },
  "timeZoneId": "<string>"
}
'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Performs flexible search across transaction report data with support for multiple filter combinations. Optimized for performance with large transaction volumes, making it suitable for administrative search interfaces and transaction lookup operations.

​
Input

  • Body: model (ReportTransactionSearchQueryRequest, required) — Search parameters including:
    • searchText (string, optional) — Text search for transaction ID, customer email, etc.
    • minAmount (decimal, optional) — Minimum transaction amount filter.
    • maxAmount (decimal, optional) — Maximum transaction amount filter.
    • startDate (string/date, optional) — Start of date range.
    • status (string, optional) — Transaction status filter.
    • limit (int, optional) — Maximum records to return (default: 20).
    • offset (int, optional) — Number of records to skip for pagination.

​
Output

Returns a ReportTransactionSearchQueryResponse containing matching transactions.

​
Example Request

POST /api/admin/reportTransactions/search
Content-Type: application/json
Authorization: Bearer {token}

{
  "searchText": "[email protected]",
  "minAmount": 100.00,
  "maxAmount": 500.00,
  "startDate": "2025-01-01",
  "status": "Approved",
  "limit": 50,
  "offset": 0
}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "transactions": [
    {
      "transactionId": "TX123456",
      "amount": 250.00,
      "customerEmail": "[email protected]",
      "status": "Approved",
      "transactionDate": "2025-01-15T14:30:00Z"
    }
  ],
  "totalCount": 1
}

​
Errors

  • 400 Bad Request — Invalid search parameters or filter combinations.
  • 401 Unauthorized — Missing or invalid authentication token.

​
Notes

  • Search is case-insensitive and supports partial matching on text fields.
  • Results are paginated; use limit and offset for large result sets.
  • Empty results return success with empty transactions array.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

The search request with filters for transaction ID, customer, amount, date range, status, and pagination.

Represents the parameters used to search for individual transaction records.

​
companyId
string<guid>
required

Identifier of the company that owns the search data.

Minimum string length: 1
​
startDate
string<date-time>
required

Inclusive start date for the search window.

Minimum string length: 1
​
endDate
string<date-time>
required

Inclusive end date for the search window.

Minimum string length: 1
​
returnAllIfCountLessThan
integer<int32>

Threshold that determines when pagination should be bypassed.

​
offset
integer<int32>

Number of rows to skip when paging.

​
limit
integer<int32>

Maximum number of rows to return.

​
filter
object

Collection of field and tag filters applied to the search.

​
order
object

Sort instructions for the search results.

​
timeZoneId
string | null

Time zone used to interpret StartDate and EndDate. Default value: Eastern Standard Time

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Represents the response envelope returned from a transaction search query.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]
​
total
integer<int32>

Total number of records matching the request.