Sign in

v1

latestOpenAPI 3.0.02026-07-22343639.7 KB
public

Get the factory and choice context for executing a direct transfer.

post/api/token-standard/v0/registrars/{registrarParty}/registry/transfer-instruction/v1/transfer-factory

Path parameters

registrarPartystring required

The registrar party.

Request body

choiceArgumentsobject required

The arguments that are intended to be passed to the choice provided by the factory. To avoid repeating the Daml type definitions, they are specified as JSON objects. However the concrete format is given by how the choice arguments are encoded using the Daml JSON API (with the extraArgs.context and extraArgs.meta fields set to the empty object).

The choice arguments are provided so that the registry can also provide choice-argument specific contracts, e.g., the configuration for a specific instrument-id.

excludeDebugFieldsboolean

If set to true, the response will not include debug fields.

Response

ok

factoryIdstring required

The contract ID of the contract implementing the factory interface.

transferKind'self' | 'direct' | 'offer' required

The kind of transfer workflow that will be used:

  • offer: offer a transfer to the receiver and only transfer if they accept
  • direct: transfer directly to the receiver without asking them for approval. Only chosen if the receiver has pre-approved direct transfers.
  • self: a self-transfer where the sender and receiver are the same party. No approval is required, and the transfer is typically immediate.