Skip to main content
GET
Get participant rollforward
Returns how one participant’s balance changed between from and to. The response has one row for each asset the participant has used by to. Each row gives opening_balance, closing_balance, and how the balance changed, split into named amounts such as issued, redeemed, redemption_reversals, and expired. Use it to print the rewards summary on a cardholder’s statement for one billing cycle without classifying statement rows yourself. from and to are required. Both bounds are inclusive and select entries by the posting’s created_at, the same way the participant statement does. The response repeats from and to exactly as you sent them, including fractional seconds. Pass asset_id to return one asset. For every row, the amounts add up to closing_balance - opening_balance. Every change is counted in one of them, and if the ledger contains activity they cannot cover, the request fails instead of returning a wrong figure. Balances include AVAILABLE, HELD, and DEFERRED, so bucket_movements_net is always 0, while transfers_net can be positive or negative. A settlement for less than the pending amount shows the difference in issuance_returns; it does not count as issued and then returned.
For what each amount counts and how they add up, see Participant rollforward in 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

from
string<date-time>
required

Period start (inclusive, RFC 3339)

to
string<date-time>
required

Period end (inclusive, RFC 3339)

asset_id
string<uuid>

Filter to a single asset

Response

Participant rollforward

Period rollforward of one participant's balances, one row per asset. Every line is attributed to journal action types; lines sum exactly to closing − opening per row (no plug line).

data
object[]

Rollforward rows, one per asset the participant has ledger activity in at or before to

from
string

Period start (inclusive, RFC 3339), echoed from the request with any fractional seconds preserved, so replaying the echoed bounds returns the same figures

Example:

"2026-01-01T00:00:00Z"

pagination
object

Pagination metadata for list responses

participant_id
string<uuid>

Participant the rollforward covers

Example:

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

to
string

Period end (inclusive, RFC 3339), echoed from the request with any fractional seconds preserved, so replaying the echoed bounds returns the same figures

Example:

"2026-01-31T23:59:59.999999Z"