REST API›Link›Link Transfers

GET

List transfers

Lists transfers for an enterprise with filtering, pagination, and sorting.

Path Params

  • enterpriseId string required
    Your enterprise id.

    at least 1 characters · matches ^[0-9a-f]{32}$

Query Params

  • limit string or number required
    Maximum number of results to return per page. Defaults to 50.

    ONE OF

    string
  • offset string or number required
    Number of results to skip before returning. Defaults to 0.

    ONE OF

    string
  • accountIds array of strings
    Filter transfers to one or more accounts within the enterprise.
  • status array of string enums
    Filter by one or more transfer statuses.
    pending_policy_evaluationprocessingpending_approvalpendingcompletedfailedfailed_retriablecanceledrejected
  • genericAsset array of strings
    Filter by one or more generic asset identifiers.
  • fromType string enum
    Filter by source entity type.
    addressbitgo_walletlink_accountvenue_account
  • toType string enum
    Filter by destination entity type.
    addressbitgo_walletlink_accountvenue_account
  • type string enum
    Filter by transfer direction relative to the account. "send" returns withdrawals (negative amount), "receive" returns deposits (positive amount).
    sendreceive
  • startDate string date-time
    Return transfers created on or after this date (ISO 8601).
  • endDate string date-time
    Return transfers created on or before this date (ISO 8601).
  • orderDirection string required
    Sort direction for sortTimestamp (venue creation time, falls back to ingestion time). Defaults to desc.

    ONE OF

    string enum
  • searchLabel string
    Case-insensitive search across transfer fields: transfer ID, fromId, toId, fromName, and toName.

    at least 1 characters

  • toAddress string
    Filter to transfers whose on-chain destination address matches this value (exact match). Joins through the crypto-detail relation; transfers without a crypto detail are excluded when this filter is set.

    at least 1 characters

Header Params

  • user-id string required
    User id of the user making the request.

    at least 1 characters

Responses

200
OK

Response Body

object

Response for the list transfers endpoint
  • transfers array of objects required
    transfers object
    • id string required
    • accountId string required
    • status string enum required
      pending_policy_evaluationprocessingpending_approvalpendingcompletedfailedfailed_retriablecanceledrejected
    • amount string required

      at least 1 characters

    • genericAsset string

      at least 1 characters

    • rawAsset string required

      at least 1 characters

    • displayAsset string required

      at least 1 characters

    • rawNetwork string

      at least 1 characters

    • fromAsset string

      at least 1 characters

    • fromNetwork string

      at least 1 characters

    • fromId string

      at least 1 characters

    • fromType string enum
      addressbitgo_walletlink_accountvenue_account
    • toAsset string

      at least 1 characters

    • toNetwork string

      at least 1 characters

    • toId string

      at least 1 characters

    • toType string enum
      addressbitgo_walletlink_accountvenue_account
    • initiatedBy string

      at least 1 characters

    • fromName string

      at least 1 characters

    • toName string

      at least 1 characters

    • fromVenueId string

      at least 1 characters

    • toVenueId string

      at least 1 characters

    • accountSubType string
      Normalized sub-account-type for the transfer's owning Link account. Absent when a sub-type could not be determined. For pass-through values (no matching venue configuration), this carries the raw venue label and rawAccountSubType / accountSubTypeLabel are absent.

      at least 1 characters

    • rawAccountSubType string
      Venue-raw sub-type label, projected from venue config. Absent for pass-through values.

      at least 1 characters

    • accountSubTypeLabel string
      Human-readable sub-type display label, projected from venue config. Absent for single-sub-type venues or pass-through values.

      at least 1 characters

    • fromAccountSubType string
      Source-leg normalized sub-account-type. Only set for link_account legs that ingested with a sub-type.

      at least 1 characters

    • fromRawAccountSubType string

      at least 1 characters

    • fromAccountSubTypeLabel string

      at least 1 characters

    • toAccountSubType string
      Destination-leg normalized sub-account-type. Only set for link_account legs that ingested with a sub-type.

      at least 1 characters

    • toRawAccountSubType string

      at least 1 characters

    • toAccountSubTypeLabel string

      at least 1 characters

    • cryptoDetail object
      Crypto detail response for a transfer
      cryptoDetail object
      • confirmations number
      • createdAt string date-time required
      • feeAmount string

        at least 1 characters

      • feeAsset string

        at least 1 characters

      • feeNetwork string

        at least 1 characters

      • feeRawAsset string

        at least 1 characters

      • feeRawNetwork string

        at least 1 characters

      • fromAddress string

        at least 1 characters

      • hash string required

        at least 1 characters

      • id string required
      • linkTransferId string required
      • status string enum required
        unconfirmedconfirmedfailedcanceledunknown
      • toAddress string

        at least 1 characters

      • updatedAt string date-time required
    • bitgoDetail object
      BitGo detail response for a transfer
      bitgoDetail object
      • bitgoWalletAddress string

        at least 1 characters

      • createdAt string date-time required
      • evaluationId string

        at least 1 characters

      • id string required
      • linkTransferId string required
      • pendingApprovalId string

        at least 1 characters

      • transactionRequestId string

        at least 1 characters

      • transferId string

        at least 1 characters

      • updatedAt string date-time required
      • walletId string

        at least 1 characters

    • venueDetail object
      Venue detail response for a transfer
      venueDetail object
      • createdAt string date-time required
      • id string required
      • linkTransferId string required
      • updatedAt string date-time required
      • venueCreatedDate string date-time required
      • venueModifiedDate string date-time required
      • venueTransactionId string

        at least 1 characters

      • venueTransferId string

        at least 1 characters

    • reason object
      Normalized failure context. Set when status is failed (terminal) or failed_retriable (the venue rejected this attempt but the same transfer can be retried under the same externalId once external state changes). code is a stable string the caller can branch on; message is a human-readable description from the venue.
      reason object
      • code string required

        at least 1 characters

      • message string required

        at least 1 characters

    • notes string

      at least 1 characters

    • sortTimestamp string date-time
    • createdAt string date-time required
    • updatedAt string date-time required
  • total number required
    Total number of transfers matching the filter across all pages (same for every page). Use with limit/offset for pagination.
400
Bad Request
No response body
401
Unauthorized

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
403
Forbidden

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required