APG PayAPG Paydocs

Ledgers and journals

Get journal

GET/journals/{journalId}
Request
GEThttps://api.tst.au.apgpay.dev/journals/{journalId}
curl -X GET https://api.tst.au.apgpay.dev/journals/{journalId} \
  -H "Authorization: Bearer $API_KEY"

Return one journal: its five-part identity, and the ledger it clears into.

Permissions

Required permission
systemJournals:query

Requires the `query` action on `systemJournals` for the supplied runtime context

Path parameters

journalIdstring
required

Responses

The response is a tagged shape: type is always "SjnlViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "SjnlViewAttributes"
journalIdSjnlIdrequired

Identifier of a system journal.

Example sjnl_9f2Kd8QpLzXw

What identifies this journal. Five fields that only mean anything together.

systemLedgerIdSldgId

The ledger this journal contributes to, set the first time it is cleared.

Example sldg_9f2Kd8QpLzXw

clearanceTimeZonestringrequired

IANA time zone the clearing date is measured in.

lastClearanceDatestring (date)

The most recent date entries were cleared from this journal.

Example 2026-08-19

lastClearanceAtstring (date-time)

For journals that clear more often than daily, when the last clearance happened.

Example 2026-08-19T04:21:07Z

ownerNamestring

The name of the business whose funds this journal records.

Example Ada Lovelace

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "SjnlViewAttributes",
  "journalId": "sjnl_9f2Kd8QpLzXw",
  "businessKey": {
    "type": "SjnlBusinessKeyAttributes",
    "ownerType": "Merchant",
    "ownerIdentifier": "string",
    "category": "General",
    "clearanceSystem": "string",
    "currency": "AUD"
  },
  "systemLedgerId": "sldg_9f2Kd8QpLzXw",
  "clearanceTimeZone": "string",
  "lastClearanceDate": "2026-08-19",
  "lastClearanceAt": "2026-08-19T04:21:07Z",
  "ownerName": "Ada Lovelace",
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses