REST API›Link›Link Transfers

PATCH

Update a transfer

Partially updates an existing transfer. Currently supports updating notes only; no other transfer fields can be modified through this endpoint yet.

Path Params

  • enterpriseId string required
    Your enterprise id.

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

  • transferId string required
    The transfer ID to update.

Header Params

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

    at least 1 characters

Body Params

object

Partial transfer update body. Currently accepts free-form client notes. Additional updatable properties may be added to this body over time.
  • notes string required
    Free-form client notes to associate with the transfer. Required today — this is the only updatable field on this route. An empty string clears previously set notes. When omitted in the future alongside other fields, notes are left unchanged.

Responses

200
OK

Response Body

object

Single transfer response 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
400
Bad Request
No response body
401
Unauthorized

Response Body

object

  • errorName string required
  • error string required
403
Forbidden

Response Body

object

  • errorName string required
  • error string required
404
Not Found

Response Body

object

  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

  • errorName string required
  • error string required