Search Transactions

Description

Performs flexible search across transaction data for administrative purposes. Supports filtering by multiple criteria to locate specific transactions or generate transaction lists for analysis, refunds, or dispute resolution.

Input

Query Parameters: model (TransactionQueryRequest) — Filtering options including:
- companyProjectId (guid, required) — Filter by company project.
- startDate (string/date, optional) — Start of date range.
- endDate (string/date, optional) — End 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 TransactionQueryResponse containing matching transactions.

Example Request

GET /api/admin/transactions?companyProjectId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startDate=2025-10-01&endDate=2025-10-31&status=Captured&limit=20&offset=0
Authorization: Bearer {admin-token}

Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "amount": 99.99,
      "currency": "USD",
      "status": "Captured",
      "transactionType": "Sale",
      "customerEmail": "[email protected]",
      "transactionDate": "2025-10-15T14:30:00Z",
      "last4": "4242",
      "cardType": "Visa"
    }
  ],
  "totalCount": 1
}

Errors

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

Notes

Results are paginated; use limit and offset for large result sets.
Empty results return success with empty entries array.
Search is case-insensitive for text fields.

Authorizations

Authorization

string

header

required

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

Query Parameters

CompanyProjectId

string<guid> | null

Identifier of the project to limit results to. When omitted, the service uses the project associated with the authenticated client.

string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

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. Wraps the transaction query results returned to payment clients. Includes standard paging metadata inherited from BaseQueryResponse{TModel}.

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.

Show child attributes

entries.id

string<guid>

Unique identifier for this entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

entries.dateCreated

string<date-time>

UTC timestamp when this entity was created.

Example:

"2025-10-30T10:30:00Z"

entries.companyProjectId

string<guid>

Identifier of the company project that owns the transaction. Used to scope transaction lookups to the caller's project and enforce authorization rules.

entries.referenceTransactionId

string<guid> | null

Identifier of a related transaction that the current record depends on. Populated when a follow-up capture, reversal, or refund references an earlier authorization.

entries.totalAmount

number<decimal>

Total amount processed for the transaction. Calculated as the subtotal plus any tax and shipping amounts reported by the payment processor.

entries.totalTax

number<decimal>

Total sales tax collected during the transaction. Mirrors the tax component returned from CyberSource or Payflow for reconciliation.

entries.totalShipping

number<decimal>

Shipping cost attributed to the transaction. Remains zero for services or digital goods that do not incur shipping.

entries.subTotal

number<decimal>

Net subtotal before tax and shipping adjustments. Represents the aggregated item total that the customer approved at checkout.

entries.personAddressId

string<guid> | null

Identifier of the stored billing address referenced by the transaction. Links the payment record back to the person-address profile used during authorization.

entries.renewalAgreement

string | null

Name of the renewal agreement accepted during checkout. Populated for subscription flows where the customer acknowledges recurring billing terms.

entries.type

enum<string>

Transaction action that was executed. Indicates whether the processor treated the request as an authorization, capture, credit, or other operation.

Available options:

Authorize,

Capture,

AuthorizeAndCapture,

CreditAuthorizeAndCapture,

CreditAuthorize,

CreditCapture,

PreAuthorize,

LiabilityChange,

LiabilityAssumption,

ChargeBackCredit,

ChargeBackDebit,

ChargebackInquiry

entries.merchantReference

string | null

Merchant supplied reference used for deduplication. Chargeworx reuses this identifier to prevent duplicate submissions and for reconciliation reporting.

entries.email

string | null

Customer email associated with the transaction. Stored to support receipt delivery and investigation of disputed payments.

Example:

[]

Overview

Architecture

Getting started

Security

API reference

Admin UI

Data

Observability

Deployment

CI/CD

Runbooks

Contributing

Description

Input

Output

Example Request

Example Response

Errors

Notes

Authorizations

Query Parameters

Response

Overview

Architecture

Getting started

Security

API reference

Admin UI

Data

Observability

Deployment

CI/CD

Runbooks

Contributing

​Description

​Input

​Output

​Example Request

​Example Response

​Errors

​Notes

Authorizations

Query Parameters

Response

Description

Input

Output

Example Request

Example Response

Errors

Notes