Ctrl+K

List destinations reachable from a Link-account source

get/link/api/link/v1/enterprises/{enterpriseId}/transfer-destinations

Mirrors VAS's GET /venues/{venueId}/transfer-destinations. Returns enterprise Link accounts the caller has link.account.view on that the given Link-account source can transfer to. Link calls VAS GET /venues/{venueId}/transfer-destinations and splits the result into two segments: off-chain (internalDestinations, with subtype entries) and on-chain (externalDestinations, no subtype). Same-hierarchy accounts are excluded from the external segment since they are already covered by the internal segment. The response envelope carries sourceSupportsOnChainWithdrawal from VAS so BFF can decide whether to surface BitGo-wallet / external-address destinations alongside. Excludes accounts with status != active.

Path Parameters

  • enterpriseIdstringRequired
    Your enterprise id.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • sourceLinkAccountIdstringRequired
    The Link account id of the source.
    Example: aba3a693-4f28-4523-8e53-85a3df22a608
    Min length: >= 1 characters
  • sourceAccountSubTypestringRequired
    The source's account subtype.
    Example: SPOT
    Min length: >= 1 characters
  • genericAssetstringRequired
    Network-agnostic asset family.
    Example: usdc
    Min length: >= 1 characters

200 Response

internalDestinations object required
accounts array[object] required
One top-level row in the off-chain (internal) destinations segment. Mirrors `LinkSourceRow`'s hierarchical pattern: parent accounts may carry nested `subAccounts`, while sub-accounts whose parent is invisible to the caller are promoted to top-level.
externalDestinations object required
accounts array[object] required
One top-level row in the on-chain (external) destinations segment. No subtype — the destination venue routes the deposit internally; the source cannot dictate a target subtype via on-chain transfer.
sourceSupportsOnChainWithdrawal boolean required

400 Response

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

404 Response

errorName string required
error string required

500 Response

errorName string required
error string required