Get the choice context to accept a transfer instruction

POST /registry/transfer-instruction/v2/{transferInstructionId}/choice-contexts/accept

Request

curl --request POST \
  --url 'https://example.com/registry/transfer-instruction/v2/{transferInstructionId}/choice-contexts/accept' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{},"excludeDebugFields":false}'

200 response

{
  "choiceContextData": {},
  "disclosedContracts": [
    {}
  ]
}

Transfer Instruction V2 API

Get the choice context to accept a transfer instruction

OpenAPISince 0.6.11

Get the choice context to accept a transfer instruction.

Protocol Details

Operation IDgetTransferInstructionAcceptContext

Published0.7.4

SpecificationDownload OpenAPI

Inputs

Path parameters

transferInstructionId · string · required

The contract ID of the transfer instruction to accept.

Request body

application/json

meta · object

Metadata that will be passed to the choice, and should be incorporated into the choice context. Provided for extensibility.

excludeDebugFields · boolean · default: "False"

If set to true, the response will not include fields prefixed with ‘debug’. Useful to save bandwidth.

Outputs

200

application/json

choiceContextData · object · required

The additional data to use when exercising the choice.

disclosedContracts · DisclosedContract[] · required

The contracts that are required to be disclosed to the participant node for exercising the choice.

400

application/json

error · string · required

404

application/json

error · string · required

409

application/json

error · string · required

History

Introduced0.6.11

Request

curl --request POST \
  --url 'https://example.com/registry/transfer-instruction/v2/{transferInstructionId}/choice-contexts/accept' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{},"excludeDebugFields":false}'

200 response

{
  "choiceContextData": {},
  "disclosedContracts": [
    {}
  ]
}