List account movements

Deposits to and withdrawals from the venue account that settle obligations, newest first, optionally for one window; page with cursor. lastSuccessfulReadAt and observationState say how current the recorded movements are. A member session also refreshes them from the LP’s history; an API key or OAuth client reads the recorded movements and never starts that refresh. 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/movements

List a venue account's settlement movements

cURL

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

200

{
  "movements": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "correlationState": "pending",
      "direction": "intoVenue",
      "evidence": "<unknown>",
      "finalityState": "observed",
      "lastSuccessfulReadAt": "2023-11-07T05:31:56Z",
      "movementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "observedAt": "2023-11-07T05:31:56Z",
      "occurredAt": "2023-11-07T05:31:56Z",
      "revision": 123,
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "blockHash": "<string>",
      "confirmations": 1,
      "destinationFinancialAccountId": "<string>",
      "lpTransferId": "<string>",
      "network": "<string>",
      "requiredConfirmations": 1,
      "sourceFinancialAccountId": "<string>",
      "transferIndex": 1,
      "txHash": "<string>",
      "walletTransferId": "<string>"
    }
  ],
  "observationState": "<string>",
  "completeness": "complete",
  "lastSuccessfulReadAt": "2023-11-07T05:31:56Z",
  "nextCursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "observationPeriod": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z"
  },
  "reasonCode": "<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>

cursor · string<uuid>

limit · integer<int32>

Required range: x >= 0

maxAge · integer<int64>

Required range: x >= 0

Response

200

application/json

movements · object[] · required

Show child attributes

observationState · string · required

completeness · null | enum<string>

Whether the LP's last successful history read covered the whole window. unconfirmed: the LP documents no page cap or cursor, so an empty answer is not proof that nothing moved. Null before the first read.

Available options: complete, unconfirmed, partial

lastSuccessfulReadAt · string<date-time> | null

nextCursor · string<uuid> | null

observationPeriod · null | object

Show child attributes

reasonCode · string | null