Get the factory and choice context for executing a direct transfer
POST
Transfer Instruction API
Get the factory and choice context for executing a direct transfer
OpenAPISince 0.5.10
Protocol Details
Inputs
Request body
application/json
object
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.boolean
default:"False"
If set to true, the response will not include fields prefixed with ‘debug’. Useful to save bandwidth.
Outputs
200
application/json
string
required
The contract ID of the contract implementing the factory interface.
string
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.ChoiceContext
required
The context required to exercise a choice on a contract via an interface. Used to retrieve additional reference data that is passed in via disclosed contracts, which are in turn referred to via their contract ID in the
choiceContextData.400
application/json
string
required
404
application/json
string
required
History
Introduced
0.5.10