Ctrl+K

Initiate an internal transfer

post/venue-adapter-service/api/vas/v1/initiate-transfer

Initiates an internal transfer between accounts within a master/sub account structure, used by Link.

Request Body

source object required
Source endpoint: credential the funds move from, plus optional account sub-type pin
credentialExternalId string required
Min length: >= 1 characters
accountSubTypeOne of
Narrow keyof codec for the committed normalized constants. Use where a value MUST be one of the committed names (e.g. venue config's `normalized` field, where the venue mapping author commits to a known constant).
Allowed values: SPOT CROSS_MARGIN ISOLATED_MARGIN PERP_FUTURES DELIVERY_FUTURES OPTIONS FUNDING EARN UNIFIED
destination object required
Destination endpoint: credential the funds move to, plus optional account sub-type pin
credentialExternalId string required
Min length: >= 1 characters
accountSubTypeOne of
Narrow keyof codec for the committed normalized constants. Use where a value MUST be one of the committed names (e.g. venue config's `normalized` field, where the venue mapping author commits to a known constant).
Allowed values: SPOT CROSS_MARGIN ISOLATED_MARGIN PERP_FUTURES DELIVERY_FUTURES OPTIONS FUNDING EARN UNIFIED
masterCredentialExternalId string required
Master credential for the venue. For venues with a parent-tree concept this is the main-account credential; for single-credential venues with no tree (e.g., Coinbase Exchange's default profile) this equals `source.credentialExternalId`. The adapter picks which credential to sign with based on the venue's authority model.
Min length: >= 1 characters
asset string required
Asset identifier to transfer
Min length: >= 1 characters
amount string required
Amount to transfer in full units
Min length: >= 1 characters
linkTransferId string required
Transfer ID in Link, created in an initial state before calling VAS; venues that support idempotency dedupe on this value
Min length: >= 1 characters

200 Response

transfers array[object] required
credentialExternalId string required
Min length: >= 1 characters
transferId string required
Min length: >= 1 characters
type string required
Allowed values: INBOUND OUTBOUND INTERNAL_INBOUND INTERNAL_OUTBOUND
status string required
Allowed values: PENDING UNCONFIRMED CONFIRMED CANCELED FAILED
assetRaw string required
Min length: >= 1 characters
amount string required
Min length: >= 1 characters
createdAt string <date-time>required
detailsOne ofrequired
externalId string
Min length: >= 1 characters
transactionId string
Min length: >= 1 characters
network string
Min length: >= 1 characters
networkRaw string
Min length: >= 1 characters
confirmations number
asset string
Min length: >= 1 characters
feeAsset string
Min length: >= 1 characters
feeAssetRaw string
Min length: >= 1 characters
feeAmount string
Min length: >= 1 characters
accountSubTypeOne of
Narrow keyof codec for the committed normalized constants. Use where a value MUST be one of the committed names (e.g. venue config's `normalized` field, where the venue mapping author commits to a known constant).
Allowed values: SPOT CROSS_MARGIN ISOLATED_MARGIN PERP_FUTURES DELIVERY_FUTURES OPTIONS FUNDING EARN UNIFIED

400 Response

errorName string required
error string required

404 Response

errorName string required
error string required

409 Response

errorName string required
error string required

422 Response

errorName string required
error string required

500 Response

errorName string required
error string required