Get deposit instructions

The caller must be allowed to view wallets in a company or broker workspace (or be an admitted LP taker). API keys additionally require treasury_read; this read never authorizes a payment. Read through the configured connection holding the account’s balance credential. Select currency for bank instructions: bankDeposit states available, referenceOnly, notOffered or unread, with a reason and reasonCode. Available receiving coordinates or a reference-only result are in bankInstructions. notOffered comes only from the venue’s declared bank offering; failed source reads are unread, never notOffered. The answer is Cache-Control no-store and every receiving-account or full-reference disclosure is audited. The connection read’s selection and fee rules apply. Select payInLegId (a summary pay-in window’s legId) for one open pay-in leg’s payment details: the read uses that leg’s currency and, for a dedicated fiat venue, the paying bank its deposit declaration recorded when that bank is linked at the venue; send it alone (400 PAY_IN_LEG_SELECTION_EXCLUSIVE). 404 PAY_IN_LEG_NOT_FOUND for a leg that is not this account’s pay-in, 409 PAY_IN_LEG_NOT_OPEN once it is no longer waiting for funds, 409 PAY_IN_LEG_NOT_BANK_CURRENCY for a leg paid in a digital asset (no bank payment details; read the deposit address with asset and chainRef). VENUE_ACCOUNT_FUNDING_VENUE_DISABLED is answered before any payInLegId is read. The account balance read’s 409 refusals also apply, plus VENUE_ACCOUNT_FUNDING_VENUE_DISABLED when only a disabled venue holds the balance key. 403 VENUE_READ_AUTHORITY_REFUSED whenever the caller’s read authority has ended, whether the check before the read or a recheck during it sees it (reason authority_ended: the credential is revoked or expired, or no longer carries treasury_read; reason permission_withdrawn: its owner lost permission to view wallets, its membership or taker admission); a session that has itself ended answers 401.

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

Read how to deposit into the venue account

cURL

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

200

{
  "bankDeposit": {
    "currency": "ZAR",
    "reason": "The deposit reference was read from the bound venue account. The venue does not publish its receiving bank details over its API: its own app shows them next to this reference. No deposit has been confirmed.",
    "reasonCode": "BANK_RECEIVING_DETAILS_NOT_EXPOSED",
    "state": "referenceOnly"
  },
  "bankInstructions": {
    "currency": "ZAR",
    "depositFee": {
      "amount": "0",
      "charging": "unverified",
      "currency": "ZAR",
      "source": "VALR S5 support.valr.com/hc/en-us/articles/360015777451: EFT deposits free (research/08 §5)",
      "status": "declared"
    },
    "depositReference": "VR••••87",
    "expectedArrival": {
      "basis": "default",
      "expectedArrivalAt": "2026-11-02T21:59:59Z",
      "manualReviewAt": "2026-11-06T21:59:59Z",
      "overdueAt": "2026-11-03T09:59:59Z",
      "publicHolidaysApplied": true,
      "source": "VALR S20 https://support.valr.com/hc/en-us/articles/360028737292 \"How long does it take for my Rand (ZAR) deposit to reflect in my VALR account?\" (updated 2026-10-12T13:34:54Z, retrieved 2026-10-15)",
      "status": "expected"
    },
    "observedAt": "2026-10-29T07:59:16.425271Z",
    "ownNameRequired": true,
    "rails": [
      "eft"
    ],
    "receivingDetails": {
      "reason": "venueApiDoesNotExpose",
      "status": "unavailable"
    },
    "testAccount": false
  },
  "connection": {
    "accountBindingStatus": "unverified",
    "accountId": "fb181171-3a8d-48ed-b2a6-240989108c3f",
    "capabilities": [
      {
        "capability": "account_identity",
        "controlRevision": 3,
        "credentialRevision": 1,
        "expiresAt": "2026-10-28T12:14:12.452753Z",
        "freshness": "expired",
        "observedAt": "2026-10-28T12:09:12.452753Z",
        "reason": "Independent account evidence is not implemented for this provider.",
        "reasonCode": "INDEPENDENT_OBSERVATIONS_UNSUPPORTED",
        "source": "provider_api",
        "state": "unsupported"
      }
    ],
    "connectionId": "381d08ba-aef7-4c69-9542-4617d700f621",
    "controlRevision": 3,
    "createdAt": "2026-10-21T11:36:33.609968Z",
    "credentialRevision": 1,
    "executionOffering": "basic",
    "executionTypeId": "valr-rfq",
    "keyFingerprint": "64bb…e1c4",
    "label": "VALR account",
    "lifecycle": "configured",
    "providerSite": "global",
    "tradePaused": false,
    "updatedAt": "2026-10-28T19:37:49.206816Z",
    "venueEnablementId": "54f228e9-254d-44b3-8f39-0d0aa0463ffc",
    "withdrawalPaused": false,
    "workspaceId": "5f56c3dd-cc2d-4ea0-8772-fa254a012e91"
  },
  "instructions": null,
  "options": [
    {
      "asset": "USDC",
      "chainRef": "eip155:8453",
      "networkCode": "Base"
    }
  ],
  "reason": "The deposit reference was read from the bound venue account. The venue does not publish its receiving bank details over its API: its own app shows them next to this reference. No deposit has been confirmed.",
  "reasonCode": "BANK_RECEIVING_DETAILS_NOT_EXPOSED",
  "state": "supported",
  "unconfirmedNetworkAssets": [
    "USDT"
  ]
}

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 · required

Query Parameters

asset · string

chainRef · string

currency · string

ISO fiat currency for the bank-deposit read; never with asset or chainRef.

providerBankId · string

The dedicated fiat venue's linked bank id for the sending bank. Required with currency for a dedicated fiat venue and refused for other venues.

payInLegId · string<uuid>

One of the venue account's open pay-in legs (a summary pay-in window's legId): the read selects that leg's currency and, for a dedicated fiat venue, the paying bank its deposit declaration recorded. Only on the venue-account read, and never with asset, chainRef, currency or providerBankId.

Response

200

application/json

Bank-rail instructions for ZAR on a VALR venue account; account capabilities trimmed to one entry and the deposit reference masked here (the API returns it in full to the member) (captured live, rfq be48e0453; vocabulary aligned with the current contract)

connection · object · required

Show child attributes

options · object[] · required

Show child attributes

reason · string · required

reasonCode · string · required

state · enum<string> · required

New values may be added; treat unknown values as other.

Available options: supported, unsupported, unverified, stale, unavailable

unconfirmedNetworkAssets · string[] · required

Catalogue assets for which the venue declares no network mapping. Any registry chainRef may be requested; its network is never confirmed.

bankDeposit · null | object

Present when a bank currency is selected: receiving account available, reference only, not offered by the venue, or unread with its reason.

Show child attributes

bankInstructions · null | object

The venue's bank deposit instructions for one fiat currency, read live from the bound account. Absent when the read failed: no reference is ever guessed.

Show child attributes

instructions · null | object

Show child attributes