Skip to main content
GET
Get transaction

Authorizations

X-Api-Key
string
header
required

Path Parameters

transaction_id
string
required

Transaction identifier

Example:

"txn_k8m2p4q7r1"

Response

Transaction details

Represents the contractual energy volumes to be transferred between buyer and seller under a contract. Transactions are immutable — corrections produce a new version that supersedes the previous one.

id
string
required

Unique transaction identifier

Example:

"txn_k8m2p4q7r1"

type
enum<string>
required

Transaction type

Available options:
ppa
Example:

"ppa"

contract_id
string
required

Parent contract identifier

Example:

"con_a1b2c3d4"

status
enum<string>
required

Transaction status

Available options:
valid,
invalid,
superseded
Example:

"valid"

version
integer
required

Version number (starts at 1, increments on correction)

Example:

2

sender
object
required

The sending party of a transaction

receiver
object
required

The receiving party of a transaction

delivery_start
string<date-time>
required

ISO 8601 delivery period start (UTC)

Example:

"2026-01-15T14:00:00Z"

delivery_end
string<date-time>
required

ISO 8601 delivery period end (UTC)

Example:

"2026-01-15T14:15:00Z"

slot_number
integer
required

Quarter-hour slot number within the delivery day (1–96, or up to 100 on DST days)

Required range: 1 <= x <= 100
Example:

57

volume
number
required

Energy volume in MWh (3 decimal places)

Example:

12.5

created_at
string<date-time>
required

ISO 8601 creation timestamp

Example:

"2026-01-14T18:00:00Z"

previous_transaction_id
string | null

ID of the transaction this version supersedes

Example:

"txn_j5n3w8v2x6"