Skip to content

Reference

lookupTransferCommandStatus

GET scan-proxy transfer command status for a sender party and command nonce (async transfer pipeline).

lookupTransferCommandStatus pairs with lookupTransferCommandCounterByParty when you know both sender and nonce from an in-flight token-standard transfer workflow.

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.lookupTransferCommandStatus.

Minimal example

const status = await canton.validator.lookupTransferCommandStatus({
  sender: 'Alice::1220...',
  nonce: 7,
});

Parameters

  • sender (required, string) — Party that initiated the transfer command (path segment).
  • nonce (required, number) — Command nonce paired with that sender (path segment).

Returns

Object with a string status field describing pipeline state; additional server fields may appear depending on Canton version.

Errors and pitfalls

  • Wrong nonce or unknown sender yields HTTP errors surfaced as ApiError.

Auth and party

Authenticated bearer token; visibility follows Canton scan-proxy rules for transfer-command observability.

See also

Source

src/clients/validator-api/operations/v0/scan-proxy/lookup-transfer-command-status.ts on GitHub.