Skip to main content
GET
List transactions (identified + optionally unidentified) for an integration

Authorizations

x-api-key
string
header
required

Partner API key (platform- or merchant-scoped). Contract key-enforces context.merchant_id.

Path Parameters

integrationId
string<uuid>
required

The calling integration's id. MUST match the integration the API key is scoped to; mismatch → 401/403 (cross-tenant isolation).

Query Parameters

status
enum<string>

Filter by transaction status.

Available options:
pending,
completed,
failed,
partially_refunded,
refunded
include_unidentified
boolean
default:false

When true, merge in transactions from anonymous sessions (no resolved customer). Default false (identified only).

branch_id
string<uuid>

Filter to a single branch.

created_from
string<date-time>

Inclusive lower bound on createdAt (RFC3339).

created_to
string<date-time>

Inclusive upper bound on createdAt (RFC3339).

cursor
string

Opaque cursor from a prior page's meta.next_cursor.

limit
integer
default:50

Page size (default 50, max 200).

Required range: 1 <= x <= 200

Response

A page of transaction summaries.

The response is of type any.