Allocation OpenAPI Reference

POST /registry/allocations/v1/{allocationId}/choice-contexts/execute-transfer

Get the choice context to execute a transfer on an allocation.

Parameters:

  • allocationId (string) – The contract ID of the allocation whose transfer the caller wants to execute.

Example request:

POST /registry/allocations/v1/{allocationId}/choice-contexts/execute-transfer 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/allocations/v1/{allocationId}/choice-contexts/withdraw

Get the choice context to withdraw an allocation.

Parameters:

  • allocationId (string) – The contract ID of the allocation to withdraw.

Example request:

POST /registry/allocations/v1/{allocationId}/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"
}

POST /registry/allocations/v1/{allocationId}/choice-contexts/cancel

Get the choice context to cancel an allocation.

Parameters:

  • allocationId (string) – The contract ID of the allocation to cancel.

Example request:

POST /registry/allocations/v1/{allocationId}/choice-contexts/cancel 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