Journal Entries

List journal entries

List journal entries (double-entry audit trail).

get/v1/journal-entries

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/journal-entries
  • Auth: HTTP bearer

Query parameters

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.

program_idstring uuid

Filter by program ID

event_idstring uuid

Filter by event ID

rule_idstring uuid

Filter by rule ID

participant_idstring uuid

Filter by participant ID (mutually exclusive with group_id and external_id)

group_idstring uuid

Filter by group ID (mutually exclusive with participant_id and external_id)

external_idstring

Filter by external ID (mutually exclusive with participant_id and group_id)

asset_idstring uuid

Filter by asset ID

bucket'AVAILABLE' | 'HELD' | 'DEFERRED'

Return only entries that affect this balance bucket

created_afterstring date-time

Return only records created after this time, RFC 3339.

created_beforestring date-time

Return only records created before this time, RFC 3339.

min_amountstring

Filter by posting amount >= min_amount (signed: positive=credit, negative=debit)

max_amountstring

Filter by posting amount <= max_amount (signed: positive=credit, negative=debit)

action_type'CREDIT' | 'DEBIT' | 'TRANSFER' | 'HOLD' | 'RELEASE' | 'FORFEIT' | 'EXPIRATION' | 'REDEMPTION' | 'REVERSAL' | 'BURN' | 'FUND' | 'ADJUSTMENT' | 'MATURITY' | 'VOID_PENDING'

Return only entries for this ledger action

reference_idstring

Filter by reference_id correlation key

Response

List of journal entries (postings omitted)

Example response

{
  "data": [
    {
      "action_type": "HOLD",
      "created_at": "2027-01-15T10:30:00Z",
      "description": "Purchase reward: 10 POINTS",
      "entry_hash": "b3a1d9f8c2e4a7b6d1e3f5a8c9b2d4e6f7a1b3c5d7e9f2a4b6c8d0e1f3a5b7c9",
      "event_id": "e5dc1b6a-7f3d-4e2a-8c1b-9a0f4d7e6c05",
      "id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
      "postings": [
        {
          "amount": "100.00",
          "asset_symbol": "POINTS",
          "bucket": "AVAILABLE",
          "created_at": "2027-01-15T10:30:00Z",
          "entity_type": "PARTICIPANT",
          "group_id": "0b9e7d3c-5a41-4f68-a2c7-81e4d6b3f907",
          "id": "8c1e3a5b-7d92-4f04-a6b8-d0f2c4e6a826",
          "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
          "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01"
        }
      ],
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "program_name": "Q1 Sales Bonus",
      "reference_id": "auth_12345",
      "rule_id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

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