PreparePayFee builds a Canton transaction whose only purpose is to pay a fee — for example a DvP settlement fee or an allocation fee — and returns the prepared transaction hash for the agent to sign locally with its Ed25519 key.
This is the fee-payment counterpart to PrepareTransaction. It follows the same prepare → sign → execute model as ordinary transactions but is scoped to fee-only operations.
When to use it
Use this method when an operation requires a fee leg as a separate signed transaction — for example, beforeProposeDvp or Allocate in the DvP flow. Operations that bundle a fee internally (most multicall and transfer flows) use PrepareTransaction instead.
Request
Explicit amulet contract IDs to consume for the fee. If omitted, the server selects amulets automatically.
Message-level signature from the cloud agent — see Authentication.
Response
Opaque server-assigned ID. Pass this into
ExecutePayFee.See also
ExecutePayFee— phase 2, submit the signed fee transaction.- Transaction flow — the full prepare/sign/execute model used by general transactions.
PayDvpFee,PayAllocFee— high-level operations layered on top of this flow.