Skip to main content
GET
/
v1
/
participants
/
{id}
/
statement
Get participant statement
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/statement \
  --header 'X-API-Key: <api-key>'
{
  "asset_id": "550e8400-e29b-41d4-a716-446655440000",
  "bucket": "AVAILABLE",
  "closing_balance": "350",
  "data": [
    {
      "action_type": "CREDIT",
      "amount": "100",
      "bucket": "AVAILABLE",
      "created_at": "2024-01-15T10:30:00Z",
      "created_by_api_key_id": "770e8400-e29b-41d4-a716-446655440000",
      "description": "Points earned",
      "event_id": "660e8400-e29b-41d4-a716-446655440000",
      "event_timestamp": "2024-01-15T10:30:00Z",
      "journal_entry_id": "550e8400-e29b-41d4-a716-446655440000",
      "posting_id": "880e8400-e29b-41d4-a716-446655440000",
      "running_balance": "350"
    }
  ],
  "from": "2024-01-01T00:00:00Z",
  "opening_balance": "250",
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  },
  "to": "2024-02-01T00:00:00Z"
}
Returns a statement for one participant and one asset: each posting in chronological order with the running balance after it, plus opening and closing balances for the window. asset_id is required. from and to window which rows are returned, but balances always reflect the account’s full history, so a windowed statement’s closing balance equals the participant’s balance as of to. Pass bucket to scope rows and balances to AVAILABLE, HELD, or DEFERRED.
For usage patterns, 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

Participant ID

Query Parameters

​
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"