Ctrl+K

Get transfer destinations for a venue account source

get/venue-adapter-service/api/vas/v1/venues/{venueId}/transfer-destinations

Returns off-chain internal destinations, on-chain external destinations, and a supportsOnChainWithdrawal flag combining adapter and AMS data.

Path Parameters

  • venueIdstring or stringRequired
    Venue identifier for the exchange to query transfer destinations on

Query Parameters

  • sourceAccountTypestringRequired
    Account type of the source account: 'main' for primary accounts, 'sub' for sub-accounts
    Enum: main sub
  • sourceAccountSubTypestring or stringRequired
    Sub-type of the source account (e.g. SPOT, CROSS_MARGIN)
  • sourceCredentialExternalIdstringRequired
    CMS credential external ID identifying the source account
    Min length: >= 1 characters
  • genericAssetstringRequired
    BitGo generic asset identifier to filter eligible transfer destinations
    Min length: >= 1 characters

200 Response

supportsOnChainWithdrawal boolean required
eligibleInternalDestinations array[object] required
accountType string required
Allowed values: main sub
accountSubType string required
Min length: >= 1 characters
eligibleExternalDestinations array[object] required
venueIdOne ofrequired
Flexible venue identifier for API spec codecs. Accepts known VenueIdentifier values AND any NonEmptyString, so consumers (e.g. Link) don't break when VAS adds a new venue before the types package is updated.
Allowed values: BITGET BITGET_PROD COINBASE_EXCHANGE COINBASE_EXCHANGE_PROD CRYPTOCOM CRYPTOCOM_PROD DERIBIT DERIBIT_PROD GATE GATE_PROD HTX HTX_PROD KRAKEN_SPOT KRAKEN_SPOT_PROD KUCOIN KUCOIN_PROD OKX OKX_PROD
accountType string required
Allowed values: main sub

400 Response

errorName string required
error string required

404 Response

errorName string required
error string required

500 Response

errorName string required
error string required