curl --request POST \
  --url 'https://example.com/registry/allocation/v2/settlement-factory' \
  --header 'Content-Type: application/json' \
  --data '{"choiceArguments":{},"excludeDebugFields":false}'

{
  "factoryId": "string",
  "choiceContext": {
    "choiceContextData": {},
    "disclosedContracts": [
      {}
    ]
  }
}

POST

registry

allocation

settlement-factory

curl --request POST \
  --url 'https://example.com/registry/allocation/v2/settlement-factory' \
  --header 'Content-Type: application/json' \
  --data '{"choiceArguments":{},"excludeDebugFields":false}'

{
  "factoryId": "string",
  "choiceContext": {
    "choiceContextData": {},
    "disclosedContracts": [
      {}
    ]
  }
}

Allocation V2 API

Settlement factory

OpenAPISince 0.6.11

Get the factory and choice context for settling allocations using the SettlementFactory_SettleBatch choice. Registries MAY limit the size of the settlement requests that they support. To ensure wide compatibility with apps, registries MUST support all settlement requests that involve at most 25 transfer legs.

Protocol Details

Operation IDgetSettlementFactory

Published0.7.4

SpecificationDownload OpenAPI

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.

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. Asset implementations SHOULD avoid that this value depends on contract-ids passed in the choice arguments, so that clients can prefetch choice contexts when chaining multiple token standard actions together in a single Daml transaction.

400

application/json

string

required

404

application/json

string

required

409

application/json

string

required

History

Introduced0.6.11

curl --request POST \
  --url 'https://example.com/registry/allocation/v2/settlement-factory' \
  --header 'Content-Type: application/json' \
  --data '{"choiceArguments":{},"excludeDebugFields":false}'

{
  "factoryId": "string",
  "choiceContext": {
    "choiceContextData": {},
    "disclosedContracts": [
      {}
    ]
  }
}

⌘I

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

Settlement factory

Settlement factory

Protocol Details

Inputs

Request body

Outputs

200

400

404

409

History

​Settlement factory

​Protocol Details

​Inputs

​Request body

​Outputs

​200

​400

​404

​409

​History

Settlement factory

Protocol Details

Inputs

Request body

Outputs

200

400

404

409

History