Programs

Get program wallet statement

Returns a running-balance statement of a program wallet's ledger activity for one asset, with opening and closing balances for the window. This report does not accept created_after or created_before.

get/v1/programs/{program_id}/statement

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/programs/{program_id}/statement
  • Auth: HTTP bearer

Path parameters

program_idstring uuid required

The program's id.

Query parameters

asset_idstring uuid required

Asset to produce the statement for

bucketstring

Scope the statement (rows and running balance) to one or more buckets. Accepts one or more comma-separated values from AVAILABLE, HELD, DEFERRED (for example AVAILABLE,DEFERRED); rows and the running balance are scoped to the union of the listed buckets. Omitted, the statement covers all buckets

period_startstring date-time

Start of the statement period, inclusive, RFC 3339, applied to the posting time.

period_endstring date-time

End of the statement period, inclusive, RFC 3339, applied to the posting time.

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

Response

Statement page with running balances

asset_idstring uuid

Asset the statement covers

bucketstring

The buckets this statement covers, as a comma-separated list in the order you requested, with duplicates removed, for example "AVAILABLE,DEFERRED". Omitted when the statement covers all buckets; the running balance is then the total across buckets.

closing_balancestring

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

opening_balancestring

Scope balance immediately before the period ("0" when no period_start is given)

period_endstring

End of the statement period, when provided

period_startstring

Start of the statement period, when provided

Example response

{
  "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
  "bucket": "AVAILABLE",
  "closing_balance": "350",
  "data": [
    {
      "action_type": "CREDIT",
      "amount": "100",
      "bucket": "AVAILABLE",
      "created_at": "2027-01-15T10:30:00Z",
      "created_by_api_key_id": "d2f4a6c8-0e1b-4a35-9c7d-b3e5f7a9c124",
      "description": "Points earned",
      "event_id": "e5dc1b6a-7f3d-4e2a-8c1b-9a0f4d7e6c05",
      "event_timestamp": "2027-01-15T10:30:00Z",
      "journal_entry_id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
      "posting_id": "8c1e3a5b-7d92-4f04-a6b8-d0f2c4e6a826",
      "reference_id": "auth_7f3a9c21",
      "rule_id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03",
      "running_balance": "350"
    }
  ],
  "opening_balance": "250",
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  },
  "period_end": "2027-12-31T23:59:59Z",
  "period_start": "2027-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.