Skip to content

Reference

ledger.getTransactionById

POST /v2/updates/transaction-by-id — fetch one transaction by update id with transactionFormat filters.

Calls POST /v2/updates/transaction-by-id. Body GetTransactionByIdParams: updateId, transactionFormat (eventFormat + transactionShape per TransactionFormatSchema).

Receiver: await canton.ledger.getTransactionById

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Minimal example

const tx = await canton.ledger.getTransactionById({
  updateId: 'UPDATE_ID',
  transactionFormat: {
    transactionShape: 'TRANSACTION_SHAPE_LEDGER_EFFECTS',
    eventFormat: { filtersByParty: {}, verbose: true },
  },
});

Parameters — GetTransactionByIdParams

See schemas/operations/updates.tsupdateId, transactionFormat required.

Returns — GetTransactionByIdResponse

OpenAPI transaction JSON.

Auth and party

Read-as visibility for filtered parties inside transactionFormat.eventFormat.

See also

Source

operations/v2/updates/get-transaction-by-id.ts