List settlement allocations

Returns allocations, newest first. An allocation is a holding set aside for a named
settlement: the owner commits a specific amount of a specific instrument to a
specific transfer leg, and it stops being spendable until the settlement executes
or the allocation is released.

This is the mechanism behind locked on /token/positions. A position's
locked quantity is the sum of its allocated holdings, and this endpoint is what says
why each one is locked and to whom it is committed. If a customer asks why funds
appear unavailable, this is the answer.

settlementId is the join key. It appears on the DvP that requested the allocation
and on every allocation funding it, so the two sides of a settlement can be assembled
without following contract identifiers.

Two deadlines, and missing either fails the settlement.
allocationDeadlineAt is when every leg must be allocated; a settlement with any leg
unallocated past that instant cannot proceed. settlementDeadlineAt is when execution
must have happened. Both come from the settlement's own terms rather than from this
allocation, so all legs of one settlement carry the same pair — which makes them
useful for a countdown, and useless for telling legs apart.

state spans three distinct record types the standard uses in sequence — a request
addressed to the owner, an instruction in progress, and the committed allocation
itself. Only allocated locks the holding.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔑

This endpoint is served under the token tier. A request is refused with 403 if the token tier is not licensed for your account.

For usage guidance, see Positions & Availability Checks.

Query Params
string
length ≤ 128

Return only records belonging to this settlement. The join key between a DvP and the
allocations that fund it — the same value appears on both.

string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only records in which this party takes part, in any role. Matched exactly, so pass the full party identifier.

string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only records in which this party is the sender.

string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only records in which this party is the receiver.

string
length ≤ 65
^[A-Za-z0-9][A-Za-z0-9._:-]{0,64}$

Return only records for this instrument. Matched exactly against the registrar-scheme identifier.

string
enum

Return only allocations in this state.

Allowed:
string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only allocations whose settlement is coordinated by this party.

date-time

Return allocations whose allocation deadline falls at or before this instant.
Combined with state=requested this is the "about to miss its window" query.

string
^[a-zA-Z]+:(asc|desc)$
Defaults to createdAt:desc

Ordering as field:direction. Timestamps default to desc.

integer
1 to 100
Defaults to 20

Maximum number of records to return in this page.

string
length ≤ 2048

Opaque cursor from a previous response's pagination.nextPageToken. Omit for the first page.

Headers
string
length ≤ 128

Optional client-supplied correlation identifier, echoed back in the X-Request-Id response header and requestId body field.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json