Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Link Transfers

Update a transfer

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

patch/api/link/v1/enterprises/{enterpriseId}/transfers/{transferId}

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Your enterprise id.

transferIdstring required
Example:aba3a693-4f28-4523-8e53-85a3df22a608

The transfer ID to update.

Headers

user-idstring required

User id of the user making the request.

Request body

notesstring required

Free-form client notes to associate with the transfer. Required today — this is the only updatable field on this route. When omitted in the future alongside other fields, notes are left unchanged.

Response

OK

idstring required
accountIdstring required
status'pending_policy_evaluation' | 'processing' | 'pending_approval' | 'pending' | 'completed' | 'failed' | 'failed_retriable' | 'canceled' | 'rejected' required
amountstring required
genericAssetstring
rawAssetstring required
displayAssetstring required
rawNetworkstring
fromAssetstring
fromNetworkstring
fromIdstring
fromType'address' | 'bitgo_wallet' | 'link_account' | 'venue_account'
toAssetstring
toNetworkstring
toIdstring
toType'address' | 'bitgo_wallet' | 'link_account' | 'venue_account'
initiatedBystring
fromNamestring
toNamestring
fromVenueIdstring
toVenueIdstring
accountSubTypestring

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.

rawAccountSubTypestring

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

accountSubTypeLabelstring

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

fromAccountSubTypestring

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

fromRawAccountSubTypestring
fromAccountSubTypeLabelstring
toAccountSubTypestring

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

toRawAccountSubTypestring
toAccountSubTypeLabelstring
notesstring
sortTimestampstring date-time
createdAtstring date-time required
updatedAtstring date-time required