Skip to main content
GET
/
v1
/
journal-entries
/
{id}
Get a journal entry
curl --request GET \
  --url https://api.scrip.dev/v1/journal-entries/{id} \
  --header 'X-API-Key: <api-key>'
{
  "action_type": "HOLD",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by_api_key_id": "550e8400-e29b-41d4-a716-446655440003",
  "description": "Purchase reward: 10 POINTS",
  "entry_hash": "b3a1d9f8c2e4a7b6d1e3f5a8c9b2d4e6f7a1b3c5d7e9f2a4b6c8d0e1f3a5b7c9",
  "event_id": "550e8400-e29b-41d4-a716-446655440002",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "postings": [
    {
      "amount": "100.00",
      "asset_symbol": "POINTS",
      "bucket": "AVAILABLE",
      "created_at": "2024-01-15T10:30:00Z",
      "entity_type": "PARTICIPANT",
      "group_id": "550e8400-e29b-41d4-a716-446655440011",
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "participant_id": "550e8400-e29b-41d4-a716-446655440010",
      "program_id": "550e8400-e29b-41d4-a716-446655440012"
    }
  ],
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "program_name": "Q1 Sales Bonus",
  "reference_id": "auth_12345"
}
Returns a single journal entry by ID, including all of its postings. Each posting contains the account, asset, signed amount, and bucket. Postings within a journal entry always sum to zero, reflecting the double-entry nature of the ledger. Each entry includes an entry_hash field, a SHA-256 seal that chains it to the previous entry in the organization’s ledger. This hash covers the entry’s metadata and all postings, making the ledger tamper-evident. Use this endpoint to inspect the full breakdown of a specific transaction. The event_id on the entry links back to the event that triggered it, and the reference_id (when present) links hold and release operations together for correlation.
For usage patterns and examples, 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

Journal entry ID

Response

Journal entry with postings

A journal entry with its metadata and double-entry postings

​
action_type
string

Ledger action type (e.g. CREDIT, DEBIT, HOLD, RELEASE, FORFEIT)

Example:

"HOLD"

​
created_at
string<date-time>

When this entry was created (RFC 3339)

Example:

"2024-01-15T10:30:00Z"

​
created_by_api_key_id
string<uuid>

API key that created this entry (null if triggered by a rule)

Example:

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

​
description
string

Human-readable explanation of the entry's purpose

Example:

"Purchase reward: 10 POINTS"

​
entry_hash
string

SHA-256 hash sealing this entry into the organization's hash chain

Example:

"b3a1d9f8c2e4a7b6d1e3f5a8c9b2d4e6f7a1b3c5d7e9f2a4b6c8d0e1f3a5b7c9"

​
event_id
string<uuid>

Event that triggered this entry (null if created via direct API call)

Example:

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

​
id
string<uuid>

Unique identifier for this journal entry

Example:

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

​
postings
object[]

Double-entry postings (always sum to zero). Omitted in list responses.

​
program_id
string<uuid>

Program this entry belongs to

Example:

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

​
program_name
string

Display name of the program

Example:

"Q1 Sales Bonus"

​
reference_id
string

Correlation ID linking holds to releases

Example:

"auth_12345"