Skip to main content
GET
List settlements

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Query Parameters

state
string | null

Filter by settlement state (e.g. COMPLIANCE_CHECKING, SETTLED).

timeout_claimable
boolean | null

Filter on the deadline remedy: true returns only settlements whose deadline passed while deposits were pending (the on-chain claimTimeout is available to either party), false excludes exactly those.

limit
integer
default:50

Maximum number of results.

Required range: 1 <= x <= 200
offset
integer
default:0

Number of results to skip.

Required range: x >= 0

Response

Successful Response

items
SettlementRead · object[]
required
total
integer
required
limit
integer
required
offset
integer
required