Skip to main content
GET
/
api
/
settlement
/
status
Settlement
curl --request GET \
  --url https://api.compose.market/api/settlement/status \
  --header 'x-session-user-address: <x-session-user-address>'
{
  "hasActiveBudget": true,
  "budget": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.compose.market/llms.txt

Use this file to discover all available pages before exploring further.

Settlement routes are operational endpoints for deferred payment state.

​
Routes

MethodPathAuthDescription
GET/api/settlement/statusSession headersReturns pending settlement state for one user and chain.
POST/api/settlement/batchInternalRuns batch settlement.

​
Headers

​
x-session-user-address
string
required
Required for GET /api/settlement/status.
​
x-chain-id
number
Chain ID for GET /api/settlement/status. Defaults to the active chain when omitted.
​
x-internal-secret
string
Required for POST /api/settlement/batch.

​
Response

​
hasActiveBudget
boolean
Whether a session budget exists for the requested wallet and chain.
​
budget
object
Budget details when hasActiveBudget is true.