Get Transactions

Description

Queries transaction history for the authenticated project. Returns transaction records including payment details, status, amounts, timestamps, and processor responses. Commonly used for transaction status checks, reconciliation, customer service inquiries, and financial reporting.

Input

Path Parameter: projectId (guid, required) — Project identifier matching authenticated API key.
Query Parameter: id (guid, optional) — Optional transaction ID to retrieve specific transaction.

Output

Returns a TransactionQueryResponse containing matching transactions or an empty list if none found.

Example Request

GET /api/payment/projects/{projectId}/transactions?id={transactionId}
Authorization: Bearer {project-api-key}

Example Response

{
  "success": true,
  "entries": [
    {
      "id": "7b8c9d0e-1234-5678-9abc-def012345678",
      "amount": 99.99,
      "status": "Approved",
      "maskedCardNumber": "************1111"
    }
  ]
}

Errors

400 Bad Request — Invalid project or transaction ID format.
401 Unauthorized — Invalid API key.
404 Not Found — Project not found.

Notes

Card numbers are always masked for PCI compliance.
CVV values are never stored or returned.
Results are scoped to the authenticated project only.

Authorizations

Authorization

string

header

required

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

Path Parameters

projectId

string<guid>

required

The unique identifier of the project for which to retrieve transactions (must match authenticated API key).

Query Parameters

string<guid> | null

Optional transaction identifier to retrieve a specific transaction; omit to retrieve all transactions for the project.

Response

Always returned. Check the success property in the response body to determine if the query 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

Path Parameters

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

Path Parameters

Query Parameters

Response

Description

Input

Output

Example Request

Example Response

Errors

Notes