List private-token transfers

get

https://example.com/api/v2/parties/{party}/token-transfers

Returns the requested party's newest private-token transfers that the caller can read.

Path Params

party

string

required

Canton party identifier.

Query Params

assetKind

string

Use 'canton_coin' to select Canton Coin. This cannot be combined with an instrument pair.

instrumentAdmin

string

Private instrument administrator; must be supplied with instrumentId.

instrumentId

string

Private instrument identifier; must be supplied with instrumentAdmin.

pageSize

int32

Maximum transfer legs to return. Defaults to 25 and is limited to 1,000.

orderDesc

boolean

Whether to return newest transfer legs first. Defaults to true.

effectiveAfter

date-time

Include transfers effective at or after this time.

effectiveBefore

date-time

Include transfers effective before this time.

cursor

string

Cursor returned with the previous page.

jwt

string

Ledger API JWT alternative to the jwt header.

nodeId

string

Configured validator-node identifier; defaults to the deployment default.

Headers

jwt

string

Ledger API JWT used to resolve party permissions.

nodeId

string

Configured validator-node identifier alternative to the nodeId query parameter.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

503Service is still starting