Get account credit

The account’s credit as the Treasury credit card shows it: the provider’s reported line (limit, used, available, overrun), the agreed facility, open credit commitments and the signed positions, each with its own observation time. The caller must be allowed to view the workspace’s wallets and credit; an API key or OAuth client additionally needs treasury_read. Figures come from the account’s last recorded ledger observation; this read makes no provider call (read the account ledger for a live read). A component that could not be read is unavailable with its code, never zero. 403 INSUFFICIENT_WORKSPACE_PERMISSION without permission to view credit; 404 VENUE_ACCOUNT_NOT_FOUND, also for another workspace’s account; 409 VENUE_ACCOUNT_FUNDS_IN_WALLETS for a wallet-based venue; 503 VENUE_ACCOUNT_ELIGIBILITY_UNAVAILABLE when account access cannot be read.

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

Read one venue account's credit

cURL

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

200

{
  "commitments": {
    "observedAt": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "state": "observed",
    "value": {
      "asOf": "2023-11-07T05:31:56Z",
      "items": [
        {
          "creditBackedOutstanding": "<string>",
          "currency": "<string>",
          "exposureCommitted": "<string>"
        }
      ],
      "sourceRevision": "<string>"
    }
  },
  "facility": {
    "observedAt": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "state": "observed",
    "value": {
      "effectiveLimit": {
        "amount": "<string>",
        "source": "lpReported",
        "currency": "<string>"
      },
      "exposureRule": "net",
      "keepPositives": "allowed",
      "termsState": "<string>",
      "version": 123,
      "agreedCap": {
        "amount": "<string>",
        "currency": "<string>"
      }
    }
  },
  "observation": {
    "available": "<string>",
    "limit": "<string>",
    "limitSource": "<string>",
    "observedAt": "2023-11-07T05:31:56Z",
    "overrun": "<string>",
    "source": "<string>",
    "state": "reported",
    "used": "<string>",
    "creditPosition": "<string>",
    "currency": "<string>",
    "exposureRule": "net",
    "utilizationPct": "<string>"
  },
  "positions": {
    "observedAt": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "state": "observed",
    "value": [
      {
        "amount": "<string>",
        "asset": "<string>",
        "assetLogo": {
          "kind": "lp",
          "registryKey": "<string>",
          "state": "registered",
          "workspaceLogoUrl": "<string>"
        },
        "netPosition": "<string>",
        "observedAt": "2023-11-07T05:31:56Z",
        "owed": "<string>",
        "owing": "<string>",
        "available": "<string>",
        "locked": "<string>"
      }
    ]
  },
  "readAt": "2023-11-07T05:31:56Z",
  "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

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

Scopes

treasury_read · bearer_auth

treasury_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

Current company or broker workspace

venueAccountId · string<uuid> · required

Response

200

application/json

A venue account's credit: the same figures as the Treasury credit card. Each component is an observation with its own time, or a named state (notReported, notStarted, unavailable with its code); an unread figure is never zero.

commitments · object · required

TetraFi's own open credit commitments per currency.

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

facility · object · required

The agreed credit terms: the facility that stands without a provider-reported limit.

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

observation · object · required

The provider's own credit line from the account's last recorded ledger observation: limit, used, available and overrun (max(used - limit, 0)), in its currency.

Option 1

Option 2

Option 3

Show child attributes

positions · object · required

The account's signed positions per asset from the same ledger observation.

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

readAt · string<date-time> · required

When this composition was read.

venueAccountId · string<uuid> · required