Skip to main content
GET
Get journal reference by correlation id

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

correlation_id
string

Correlation identifier to resolve a journal/outbox reference.

Maximum string length: 256

Response

OK

correlationId
string
required

Correlation identifier the reference was resolved by, linking it to the originating run.

Example:

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

id
string
required

UUID of the journal reference record.

Example:

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

postingStatus
string
required

Status the reference recorded for the downstream ledger posting.

Example:

"pending"

externalJournalReferenceId
string

Reference ID assigned by the external ledger/journal system; omitted until posting has been acknowledged.

outboxEventId
string

UUID of the emitted outbox event; omitted when no outbox event was recorded.

Example:

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