List OT settlement instructions (obligations)

A cursor-paginated page of settlement obligations and their funding lifecycle state.

GET /api/v1/siloc/settlement-instructions

List OT settlement instructions (obligations)

cURL

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/settlement-instructions \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "items": [
    {
      "amountCanonical": "<string>",
      "amountRaw": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "depositDeadlineAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "movementDate": "<string>",
      "numCtrlLdl": "<string>",
      "pendingBeyondTwoCycles": true,
      "periodCode": "<string>",
      "product": "<string>",
      "side": "DEBIT",
      "sourceNuOp": "<string>",
      "state": "RECEIVED",
      "traceabilityId": "<string>",
      "numCtrlStr": "<string>",
      "receivedAt": "2023-11-07T05:31:56Z",
      "terminalAt": "2023-11-07T05:31:56Z",
      "terminalSourceEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "terminalTimestampRaw": "<string>",
      "terminalTimestampSource": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

cycleId · string<uuid>

Restrict to one cycle.

state · enum<string>

Filter by lifecycle state.

Available options: RECEIVED, FUNDING_REQUIRED, CREDIT_EXPECTED, SETTLED, FAILED

cursor · string

Opaque pagination cursor.

limit · integer<int64> · default: 50

Page size (default 50, max 200).

Required range: 1 <= x <= 200

Response

200

application/json

OK

hasMore · boolean · required

Whether more pages follow.

items · object[] | null · required

The page of instructions (never null).

Show child attributes

nextCursor · string

Opaque cursor for the next page; empty when exhausted.