Overview
Architecture
Getting started
Observability
Contributing
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": []
}Search Transaction Reports
Searches optimized transaction report data using flexible filters including text search, amount ranges, dates, and status for administrative lookups and analysis.
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 aReportTransactionSearchQueryResponse 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
The access token received from the authorization server in the OAuth 2.0 flow.
Body
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.
Identifier of the company that owns the search data.
1Inclusive start date for the search window.
1Inclusive end date for the search window.
1Threshold that determines when pagination should be bypassed.
Number of rows to skip when paging.
Maximum number of rows to return.
Collection of field and tag filters applied to the search.
Show child attributes
Show child attributes
Filters applied to custom tag labels.
Show child attributes
Show child attributes
Tag label being filtered. Should match a tag label defined within the reporting configuration to produce results.
Filter condition applied to the tag. Specifies both the comparison operator and target value for the selected tag label.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction identifiers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to calendar week numbers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to calendar month numbers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to event identifiers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction result codes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Undefined, ChargeworxAcceptedProcessorAccepted, ChargeworxDeclinedProcessorAccepted, ChargeworxDeclinedProcessorRejected, Exception Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction event types.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Authorize, Captured, CreditCaptured, CreditAuthorize, AuthorizeReverse, PreAuthorize, ChargeBackCredit, ChargeBackDebit, ChargebackInquiry Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction event outcomes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Pending, Accepted, Rejected Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar week of the event timestamp.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar month of the event timestamp.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to CVV validation results.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card types.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
VISA, MasterCard, AmericanExpress, Discover Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to project names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to full transaction timestamps. Allowed format: MM/dd/yyyy hh:mm tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the time-of-day component of the transaction timestamp. Allowed format: hh:mm:ss tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the transaction calendar date component. Allowed format: MM/dd/yyyy
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the transaction calendar year component.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to full event timestamps. Allowed format: MM/dd/yyyy hh:mm tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the time-of-day component of event timestamps. Allowed format: hh:mm:ss tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar date component of event timestamps. Allowed format: MM/dd/yyyy
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar year component of event timestamps.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to client IP addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to device fingerprint values.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to payer email addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card last four digits.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card expiration dates.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing first names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing last names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing address line 1.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing address line 2.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing cities.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing states or provinces.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing postal codes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing countries.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery recipient first names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery recipient last names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery address line 1.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery address line 2.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery cities.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery states or provinces.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery postal codes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery countries.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Sort instructions for the search results.
Show child attributes
Show child attributes
Ordering configuration for tag-based dimensions.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Tag label being sorted. Should reference an existing tag definition to ensure the order-by clause resolves correctly.
Ordering configuration for Project Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Transaction ID.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Date Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Date.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Week.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Month.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Year.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Result Code.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event ID.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Type.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Result.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Date Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Date.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Week.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Month.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Year.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for IP Address.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Fingerprint.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for CVV Status.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing First Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Last Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Email.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Type.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Last 4.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Expiration Date.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Address Line 1.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Address Line 2.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing City.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing State.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Zip.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Country.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery First Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Last Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Address Line 1.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Address Line 2.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery City.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery State.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Zip.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Country.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc 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.
Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents the response envelope returned from a transaction search query.
True if the operation completed successfully; false if an error occurred.
true
Result code indicating the outcome of the operation.
Unknown, Success, BadRequest, Unauthorized, NotFound, Error 200
Human-readable error message when an error occurs.
null
Collection of entities matching the query criteria.
Show child attributes
Show child attributes
Identifier of the project associated with the transaction.
Name of the project associated with the transaction.
Unique identifier of the transaction.
Timestamp of the transaction.
Result code summarizing the transaction outcome.
Undefined, ChargeworxAcceptedProcessorAccepted, ChargeworxDeclinedProcessorAccepted, ChargeworxDeclinedProcessorRejected, Exception Identifier of the transaction event.
Event type representing the transaction lifecycle stage.
Authorize, Captured, CreditCaptured, CreditAuthorize, AuthorizeReverse, PreAuthorize, ChargeBackCredit, ChargeBackDebit, ChargebackInquiry Outcome recorded for the event.
Pending, Accepted, Rejected Timestamp of the event.
Client IP address observed for the transaction.
Device fingerprint hash captured at the time of payment.
Indicates whether CVV verification succeeded.
Email address recorded for the payer.
Credit card brand used in the transaction.
VISA, MasterCard, AmericanExpress, Discover Last four digits of the credit card number.
Credit card expiration date formatted as MM/YY.
Four-digit expiration year for the credit card.
Two-digit expiration month for the credit card.
Billing contact first name.
Billing contact last name.
Primary billing street address line.
Secondary billing street address line.
Billing city.
Billing state or province.
Billing postal or ZIP code.
Billing country.
First name of the delivery recipient.
Last name of the delivery recipient.
Primary delivery street address line.
Secondary delivery street address line.
Delivery city.
Delivery state or province.
Delivery postal or ZIP code.
Delivery country.
Number of payment authorization events.
Total monetary amount authorized for payments.
Number of payment settlement events.
Total monetary amount settled for payments.
Number of refund authorization events.
Total monetary amount authorized for refunds.
Number of refund settlement events.
Total monetary amount settled for refunds.
Number of payment reverse authorization events.
Total monetary amount reversed from payment authorizations.
Number of chargeback events recorded.
Total monetary amount of chargebacks.
Net transaction amount.
Timestamp of the earliest event.
Timestamp of the most recent event.
Total number of individual events.
Type of the most recent event.
Authorize, Captured, CreditCaptured, CreditAuthorize, AuthorizeReverse, PreAuthorize, ChargeBackCredit, ChargeBackDebit, ChargebackInquiry Outcome recorded for the most recent event.
Pending, Accepted, Rejected Raw JSON payload containing the tag data.
[]Total number of records matching the request.