getExternalPartyBalance

getExternalPartyBalance wraps GET .../external-party/balance?party_id=.... Pass SDK camelCase partyId; the client emits snake_case query encoding expected by the validator.

Setup

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

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

Import and receiver

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

Receiver: canton.validator.getExternalPartyBalance.

Minimal example

const bal = await canton.validator.getExternalPartyBalance({
  partyId: 'Alice::1220...',
});

Parameters

partyId (required, string) — External party identifer mapped to party_id in the URL query string.

Returns

Validator JSON summarizing externally keyed holdings relevant to admin dashboards.

Errors and pitfalls

Unknown party: Returned when validator lacks ledger visibility—inspect logs alongside Canton explorer tooling.

Auth and party

Bearer token granted visibility into external-party balance admin endpoints.

Source

src/clients/validator-api/operations/v0/admin/get-external-party-balance.ts on GitHub.