Transfer Instruction OpenAPI Reference

POST /registry/transfer-instruction/v1/transfer-factory

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

Example request:

POST /registry/transfer-instruction/v1/transfer-factory HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "choiceArguments": {},
    "excludeDebugFields": true
}

Status Codes:

• 200 OK –

  ok

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "factoryId": "string",
      "transferKind": "self",
      "choiceContext": {
          "choiceContextData": {},
          "disclosedContracts": [
              {
                  "templateId": "string",
                  "contractId": "string",
                  "createdEventBlob": "string",
                  "synchronizerId": "string",
                  "debugPackageName": "string",
                  "debugPayload": {},
                  "debugCreatedAt": "2025-08-21T13:48:50.766699"
              }
          ]
      }
  }
  

• 400 Bad Request –

  bad request

  Example response:

  HTTP/1.1 400 Bad Request
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

• 404 Not Found –

  not found

  Example response:

  HTTP/1.1 404 Not Found
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

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

Get the choice context to accept a transfer instruction.

Parameters:

• transferInstructionId (string) – The contract ID of the transfer instruction to accept.

Example request:

POST /registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/accept HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "meta": {}
}

Status Codes:

• 200 OK –

  ok

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "choiceContextData": {},
      "disclosedContracts": [
          {
              "templateId": "string",
              "contractId": "string",
              "createdEventBlob": "string",
              "synchronizerId": "string",
              "debugPackageName": "string",
              "debugPayload": {},
              "debugCreatedAt": "2025-08-21T13:48:50.766699"
          }
      ]
  }
  

• 400 Bad Request –

  bad request

  Example response:

  HTTP/1.1 400 Bad Request
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

• 404 Not Found –

  not found

  Example response:

  HTTP/1.1 404 Not Found
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

POST /registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/reject

Get the choice context to reject a transfer instruction.

Parameters:

• transferInstructionId (string) – The contract ID of the transfer instruction to reject.

Example request:

POST /registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/reject HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "meta": {}
}

Status Codes:

• 200 OK –

  ok

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "choiceContextData": {},
      "disclosedContracts": [
          {
              "templateId": "string",
              "contractId": "string",
              "createdEventBlob": "string",
              "synchronizerId": "string",
              "debugPackageName": "string",
              "debugPayload": {},
              "debugCreatedAt": "2025-08-21T13:48:50.766699"
          }
      ]
  }
  

• 400 Bad Request –

  bad request

  Example response:

  HTTP/1.1 400 Bad Request
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

• 404 Not Found –

  not found

  Example response:

  HTTP/1.1 404 Not Found
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

POST /registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw

Get the choice context to withdraw a transfer instruction.

Parameters:

• transferInstructionId (string) – The contract ID of the transfer instruction to withdraw.

Example request:

POST /registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "meta": {}
}

Status Codes:

• 200 OK –

  ok

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "choiceContextData": {},
      "disclosedContracts": [
          {
              "templateId": "string",
              "contractId": "string",
              "createdEventBlob": "string",
              "synchronizerId": "string",
              "debugPackageName": "string",
              "debugPayload": {},
              "debugCreatedAt": "2025-08-21T13:48:50.766699"
          }
      ]
  }
  

• 400 Bad Request –

  bad request

  Example response:

  HTTP/1.1 400 Bad Request
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

• 404 Not Found –

  not found

  Example response:

  HTTP/1.1 404 Not Found
  Content-Type: application/json
  
  {
      "error": "string"
  }
  

Comments