Skip to main content
GET
Get group wallet statement
Returns a running-balance statement for one group and one asset. The asset_id query parameter is required. Each row represents one posting and includes the signed movement amount, bucket, journal entry, and running balance. from and to select rows by the journal entry’s system ingestion time. They do not reset the running-balance calculation. opening_balance is the scoped balance immediately before from, and closing_balance is the scoped balance as of to. Pass bucket to scope rows and balances to AVAILABLE, HELD, or DEFERRED. Pass program_id to scope movements, opening and closing balances, and running balances to journal entries attributed to that program. This filter follows journal activity attribution, not a lot’s original issuer lineage. Journal entries without a program_id, such as system-attributed activity, are excluded from a program-scoped statement. A successful response contains data, opening_balance, closing_balance, and pagination. Treat missing or malformed fields as an error rather than substituting an empty movement list or zero balance.
For statement and audit-trail usage, see the Reporting guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

Query Parameters

program_id
string<uuid>

Scope movements and balances to this program

asset_id
string<uuid>
required

Asset to produce the statement for

bucket
enum<string>

Scope the statement (rows and running balance) to a single bucket

Available options:
AVAILABLE,
HELD,
DEFERRED
from
string<date-time>

Start of statement window (RFC 3339) — selects returned rows on system ingestion time

to
string<date-time>

End of statement window (RFC 3339) — selects returned rows on system ingestion time

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

Response

Statement page with running balances

asset_id
string<uuid>

Asset the statement covers

Example:

"550e8400-e29b-41d4-a716-446655440000"

bucket
string

Bucket scope, when the statement was requested for a single bucket. Absent when the statement covers all buckets (running balance is then the total across buckets).

Example:

"AVAILABLE"

closing_balance
string

Scope balance as of the end of the window (the current balance when no to is given). Always equals the as-of(to) balance for the same entity/asset/bucket scope, regardless of pagination.

Example:

"350"

data
object[]

Statement lines, oldest first

from
string

Start of the statement window, when provided

Example:

"2024-01-01T00:00:00Z"

opening_balance
string

Scope balance immediately before the window ("0" when no from is given)

Example:

"250"

pagination
object

Pagination metadata for fetching subsequent statement pages

to
string

End of the statement window, when provided

Example:

"2024-02-01T00:00:00Z"