List account windows

The account’s settlement windows, newest snapshot first, each with its indicative statement once the snapshot is ready: positions, snapshot prices (an unavailable price names its stage and reason) and the minimum-settlement decision. Filter by state; page with cursor. Required API-key scope: settlements_read; an OAuth client needs the same scope. The key’s owner must also be allowed to view the workspace’s settlements.

GET /api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows

List a venue account's settlement windows

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "readAt": "2023-11-07T05:31:56Z",
      "scheduleId": "<string>",
      "scheduleVersion": 123,
      "snapshotAt": "2023-11-07T05:31:56Z",
      "state": "<string>",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "consequencePolicy": {
        "grace": "disabled",
        "lateFee": "disabled",
        "rollover": "disabled",
        "source": "<string>",
        "tradingBlock": "disabled",
        "version": 123
      },
      "dueAt": "2023-11-07T05:31:56Z",
      "dueRefusal": "<string>",
      "dueState": "notDue",
      "lpDelivery": {
        "sends": [
          {
            "amount": "<string>",
            "asset": "<string>",
            "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "occurredAt": "2023-11-07T05:31:56Z",
            "network": "<string>",
            "txHash": "<string>"
          }
        ],
        "state": "awaitingWorkspacePayment",
        "agreementAt": "2023-11-07T05:31:56Z",
        "dueAt": "2023-11-07T05:31:56Z",
        "refusal": "<string>",
        "sla": {
          "seconds": 123,
          "source": "<string>"
        },
        "workspaceFinalAt": "2023-11-07T05:31:56Z"
      },
      "overdueSince": "2023-11-07T05:31:56Z",
      "remindersPaused": true,
      "residuals": [
        {
          "asset": "<string>",
          "dueState": "notDue",
          "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payer": "workspace",
          "remainingAmount": "<string>"
        }
      ],
      "completionAt": "2023-11-07T05:31:56Z",
      "cutoffAt": "2023-11-07T05:31:56Z",
      "failure": {
        "error": "<string>",
        "message": "<string>",
        "component": "<string>",
        "fix": {
          "approvers": [
            {
              "basis": "walletManager",
              "name": "<string>",
              "email": "<string>",
              "roleName": "<string>"
            }
          ],
          "kind": "requestPermission",
          "target": {
            "kind": "walletRight",
            "right": "readAuthority",
            "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "venueId": "<string>"
          },
          "action": "<string>",
          "existingRequest": {
            "createdAt": "2023-11-07T05:31:56Z",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "votesCast": 1,
            "votesRequired": 1
          }
        },
        "lastGoodReadAt": "2023-11-07T05:31:56Z",
        "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "paymentDeadlineAt": "2023-11-07T05:31:56Z",
      "statement": {
        "cutoffStatus": "<string>",
        "cutoffTrades": [
          {
            "boundaryAt": "2023-11-07T05:31:56Z",
            "filledAt": "2023-11-07T05:31:56Z",
            "mayFallInEitherWindow": true,
            "tradeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "lpReadAt": "2023-11-07T05:31:56Z",
        "priceStatus": "<string>",
        "prices": [
          {
            "asset": "<string>",
            "currency": "<string>",
            "price": "<string>",
            "pricedAt": "2023-11-07T05:31:56Z",
            "source": "<string>",
            "status": "available",
            "version": "<string>"
          }
        ],
        "provenance": "<string>",
        "reconstructed": true,
        "releaseEligible": true,
        "rows": [
          {
            "asset": "<string>",
            "availableToTake": "<string>",
            "carriedForwardObligationIds": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "chosenToTakePositive": "<string>",
            "earlierOpenAmount": "<string>",
            "earlierOpenLpDelivery": "<string>",
            "newOwedToWorkspace": "<string>",
            "payAmount": "<string>",
            "position": "<string>"
          }
        ],
        "snapshotAt": "2023-11-07T05:31:56Z",
        "statementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 123,
        "belowMinimum": true,
        "cutoffFailure": {
          "error": "<string>",
          "message": "<string>",
          "component": "<string>",
          "fix": {
            "approvers": [
              {
                "basis": "walletManager",
                "name": "<string>",
                "email": "<string>",
                "roleName": "<string>"
              }
            ],
            "kind": "requestPermission",
            "target": {
              "kind": "walletRight",
              "right": "readAuthority",
              "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "venueId": "<string>"
            },
            "action": "<string>",
            "existingRequest": {
              "createdAt": "2023-11-07T05:31:56Z",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "votesCast": 1,
              "votesRequired": 1
            }
          },
          "lastGoodReadAt": "2023-11-07T05:31:56Z",
          "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "deferredWindows": [
          {
            "rows": [
              {
                "asset": "<string>",
                "availableToTake": "<string>",
                "carriedForwardObligationIds": [
                  "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                ],
                "chosenToTakePositive": "<string>",
                "earlierOpenAmount": "<string>",
                "earlierOpenLpDelivery": "<string>",
                "newOwedToWorkspace": "<string>",
                "payAmount": "<string>",
                "position": "<string>"
              }
            ],
            "snapshotAt": "2023-11-07T05:31:56Z",
            "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "minimumSettlement": {
          "minimumUsd": "<string>",
          "outcome": "belowMinimum",
          "prices": [
            {
              "asset": "<string>",
              "price": "<string>",
              "source": "<string>"
            }
          ],
          "stated": "assumed",
          "netOwedUsd": "<string>"
        },
        "reconstruction": {
          "fillIds": [
            "<string>"
          ],
          "laterReadAt": "2023-11-07T05:31:56Z",
          "movementIds": [
            "<string>"
          ],
          "unexplainedAssets": [
            "<string>"
          ]
        }
      }
    }
  ],
  "readAt": "2023-11-07T05:31:56Z",
  "nextCursor": "<string>"
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

settlements_read · bearer_auth

settlements_read · api_key

Headers

X-Workspace-Id · string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId · string · required

Workspace id

venueAccountId · string<uuid> · required

The venue account's id

Query Parameters

state · enum<string>

Only windows in this snapshot state. A settlement window's snapshot state.

Available options: scheduled, building, ready, retrying, failed

cursor · string

The previous page's nextCursor, unchanged.

limit · integer<int32> · default: 100

Windows per page, 1 to 100 (default 100).

Required range: 1 <= x <= 100

Response

200

application/json

items · object[] · required

Newest snapshot first.

Show child attributes

readAt · string<date-time> · required

nextCursor · string | null

Pass as cursor to read the next page; null on the last page.