List account obligations

What the workspace and the LP owe each other on this account, with status and deadline, optionally for one window or one trade; 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/obligations

List a venue account's settlement obligations

cURL

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

200

{
  "items": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "consequence": "overdue",
      "dueAt": "2023-11-07T05:31:56Z",
      "metAmount": "<string>",
      "obligationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "origin": {
        "kind": "windowSnapshot",
        "originId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 123
      },
      "payee": "workspace",
      "payer": "workspace",
      "policyVersion": 123,
      "readAt": "2023-11-07T05:31:56Z",
      "remainingAmount": "<string>",
      "revision": 123,
      "state": "open",
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceId": "<string>",
      "arrivalAt": "2023-11-07T05:31:56Z",
      "consequencePolicy": {
        "grace": "disabled",
        "lateFee": "disabled",
        "rollover": "disabled",
        "source": "<string>",
        "tradingBlock": "disabled",
        "version": 123
      },
      "dueRefusal": "<string>",
      "dueState": "notDue",
      "lateFundsAmount": "<string>",
      "latePayment": true,
      "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"
      },
      "needsReview": true,
      "observedAt": "2023-11-07T05:31:56Z",
      "originalWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "overdueSince": "2023-11-07T05:31:56Z",
      "payInDifference": {
        "amount": "<string>",
        "direction": "over"
      },
      "remindersPaused": true,
      "closure": {
        "reason": "keptAtVenue",
        "recordedAt": "2023-11-07T05:31:56Z",
        "fromWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "intoWindowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "keepRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "nettedAmount": "<string>"
      },
      "dispute": {
        "note": "<string>",
        "openedAt": "2023-11-07T05:31:56Z",
        "openedBy": "<string>",
        "priorState": "open",
        "openedByName": "<string>"
      },
      "dueBasis": "clock",
      "metAt": "2023-11-07T05:31:56Z",
      "tradeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "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

windowId · string<uuid>

tradeId · string<uuid>

cursor · string<uuid>

limit · integer<int32> · default: 50

Required range: 1 <= x <= 200

Response

200

application/json

items · object[] · required

Show child attributes

readAt · string<date-time> · required

nextCursor · string | null