Skip to main content
POST
/
custody-commissions
/
consume
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "commission123",
  "registeredConsumers": [
    "consumer1",
    "consumer2"
  ],
  "createdAt": "2024-03-20T12:00:00Z",
  "updatedAt": "2024-03-20T12:00:00Z"
}

Body

application/json
​
identifier
string
required

The identifier of the custody commission to consume

Example:

"commission123"

​
consumedBy
string
required

The ID of the consumer consuming the commission

Example:

"consumer123"

Response

The custody commission has been successfully consumed

​
id
string
required

The unique identifier of the custody commission

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
identifier
string
required

The unique identifier for this commission

Example:

"commission123"

​
registeredConsumers
string[]
required

List of registered consumer IDs

Example:
["consumer1", "consumer2"]
​
createdAt
string<date-time>
required

When the custody commission was created

Example:

"2024-03-20T12:00:00Z"

​
updatedAt
string<date-time>
required

When the custody commission was last updated

Example:

"2024-03-20T12:00:00Z"