Skip to main content
GET
/
api
/
ledger
/
v2
/
{ledger}
/
transactions
/
{id}
Get transaction from a ledger by its ID
curl --request GET \
  --url http://localhost/api/ledger/v2/{ledger}/transactions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "timestamp": "2023-11-07T05:31:56Z",
    "postings": [
      {
        "amount": 100,
        "asset": "COIN",
        "destination": "users:002",
        "source": "users:001"
      }
    ],
    "metadata": {
      "admin": "true"
    },
    "id": 1,
    "reverted": true,
    "insertedAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "reference": "ref:001",
    "revertedAt": "2023-11-07T05:31:56Z",
    "preCommitVolumes": {
      "orders:1": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      },
      "orders:2": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      }
    },
    "postCommitVolumes": {
      "orders:1": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      },
      "orders:2": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      }
    },
    "preCommitEffectiveVolumes": {
      "orders:1": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      },
      "orders:2": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      }
    },
    "postCommitEffectiveVolumes": {
      "orders:1": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      },
      "orders:2": {
        "USD": {
          "input": 100,
          "output": 10,
          "balance": 90
        }
      }
    }
  }
}
Retrieve a specific transaction by its ID, including all postings, metadata, and timestamps.

​
Parameters

ledger: The name of the ledger containing the transaction. (e.g., ledger001) id: The unique transaction ID (auto-incrementing integer assigned at creation). (e.g., 1234) expand: Include additional data. Use volumes to include account volume changes from this transaction. (e.g., volumes) pit: Point-in-time query. Returns the transaction state at this timestamp (useful if metadata was modified after creation). (e.g., 2024-01-15T10:30:00Z)

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
ledger
string
required

Name of the ledger.

Example:

"ledger001"

​
id
integer<bigint>
required

Transaction ID.

Required range: x >= 0
Example:

1234

Query Parameters

​
expand
string
​
pit
string<date-time>

Response

OK

​
data
object
required