Create a transfer request

curl --request POST \
  --url https://api.anchorage-staging.com/v2/transfers \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1000.00000000",
  "assetType": "BTC",
  "deductFeeFromAmountIfSameType": false,
  "idempotentId": "12838927347",
  "transferAmlQuestionnaire": {
    "originatorType": "MY_CLIENT",
    "originatorName": "Satoshi Nakamoto",
    "originatorCountry": "US",
    "originatorStreetAddress": "1234 NW Bobcat Lane, St. Robert, MO",
    "originatorPostalCode": "65584-5678",
    "originatorCity": "San Francisco",
    "originatorStateProvince": "Wyoming",
    "purpose": "TRADING_SETTLEMENT"
  },
  "transferMemo": "Internal ID: #12838927347",
  "useGasStation": true
}
'

import requests

url = "https://api.anchorage-staging.com/v2/transfers"

payload = {
    "amount": "1000.00000000",
    "assetType": "BTC",
    "deductFeeFromAmountIfSameType": False,
    "idempotentId": "12838927347",
    "transferAmlQuestionnaire": {
        "originatorType": "MY_CLIENT",
        "originatorName": "Satoshi Nakamoto",
        "originatorCountry": "US",
        "originatorStreetAddress": "1234 NW Bobcat Lane, St. Robert, MO",
        "originatorPostalCode": "65584-5678",
        "originatorCity": "San Francisco",
        "originatorStateProvince": "Wyoming",
        "purpose": "TRADING_SETTLEMENT"
    },
    "transferMemo": "Internal ID: #12838927347",
    "useGasStation": True
}
headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '1000.00000000',
    assetType: 'BTC',
    deductFeeFromAmountIfSameType: false,
    idempotentId: '12838927347',
    transferAmlQuestionnaire: {
      originatorType: 'MY_CLIENT',
      originatorName: 'Satoshi Nakamoto',
      originatorCountry: 'US',
      originatorStreetAddress: '1234 NW Bobcat Lane, St. Robert, MO',
      originatorPostalCode: '65584-5678',
      originatorCity: 'San Francisco',
      originatorStateProvince: 'Wyoming',
      purpose: 'TRADING_SETTLEMENT'
    },
    transferMemo: 'Internal ID: #12838927347',
    useGasStation: true
  })
};

fetch('https://api.anchorage-staging.com/v2/transfers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "status": "IN_PROGRESS",
    "transferId": "008d3ec72558ce907571886df63ef51594b5bd8cf106a0b7fa8f12a30dfc867f"
  }
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

Create a transfer request

Permissions required: Transfer funds

Identify the sending resource and asset

To initiate a transfer between resources, you must identify which resource you’d like to transfer funds from and the asset type to transfer. Provide a source and assetType.

Identify the receiving resource

Choose a resource to receive the funds as the destination. This resource may belong to your organization or another organization that also custodies with Anchorage Digital, or it may also be an approved blockchain address not custodied by Anchorage Digital (see Permission Groups for more details). Please note: If you would like to use the Anchorage Digital API to transfer to approved blockchain addresses, please contact api@anchorage.com.

Permissions

The provided API key must be associated with a permission group that has Transfer permissions for the vault from which the assets are being sent. The receiving resource does not need Transfer permissions to receive a transfer of funds.

Additional Metadata

You may provide a transfer memo with each transfer. If the transfer API request is successful, a transfer transaction will be created that will include this transfer memo in the description. The resulting deposit will also include this memo.

Successful Transfers

If the transfer request is valid, the request will initiate a transfer transaction from the source. This is a special withdrawal that will not require a quorum of approvals and will undergo automated Anchorage Digital Risk Review. When the transaction is broadcasted and confirmed on the blockchain, a subsequent deposit will be detected for the destination. All of these transactions will be visible on the Anchorage Digital iOS Application, the Web Dashboard, and in the list transactions API endpoint.

Unsuccessful Transfers

A transfer request may fail for any of the following reasons:

The specified sending resource does not exist or does not support the specified asset type
The specified amount exceeds the available funds for this asset (insufficient funds)
The destination does not exist or does not support the specified asset type
The provided API key does not have permissions to initiate transfers from this wallet

If the transfer request is successful, the actual transfer transaction may fail for any of the following reasons:

There are insufficient funds to pay the blockchain network fee at the time of this transaction
The transfer was successfully queued but there were insufficient funds by the time it was processed
There is a failure on the blockchain

Idempotent Requests

This endpoint supports idempotent requests so that a transfer does not occur twice if an API call was interrupted and must be retried. To send an idempotent request, include the idempotentId field in the body of the POST request.

Queueing

Transfer requests are queued and processed in the order they were received. When transferring between wallets, multiple transfer requests may be queued for the same asset in a given wallet, but only one will be processed at a time. The other requests will remain in the QUEUED state until the prior transfer is completed or fails.

Transferring Full Balance

For assets with network fees paid in a separate asset type, transferring the full balance of an asset is no different than transferring any other amount for that asset.

For assets with network fees paid in the same asset type, transferring the full balance is not possible without specifying to the server that the fee should be deducted from the transfer amount. See the deductFeeFromAmountIfSameType flag of the TransfersRequest model for more detail.

POST

transfers

Create a transfer request

curl --request POST \
  --url https://api.anchorage-staging.com/v2/transfers \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1000.00000000",
  "assetType": "BTC",
  "deductFeeFromAmountIfSameType": false,
  "idempotentId": "12838927347",
  "transferAmlQuestionnaire": {
    "originatorType": "MY_CLIENT",
    "originatorName": "Satoshi Nakamoto",
    "originatorCountry": "US",
    "originatorStreetAddress": "1234 NW Bobcat Lane, St. Robert, MO",
    "originatorPostalCode": "65584-5678",
    "originatorCity": "San Francisco",
    "originatorStateProvince": "Wyoming",
    "purpose": "TRADING_SETTLEMENT"
  },
  "transferMemo": "Internal ID: #12838927347",
  "useGasStation": true
}
'

import requests

url = "https://api.anchorage-staging.com/v2/transfers"

payload = {
    "amount": "1000.00000000",
    "assetType": "BTC",
    "deductFeeFromAmountIfSameType": False,
    "idempotentId": "12838927347",
    "transferAmlQuestionnaire": {
        "originatorType": "MY_CLIENT",
        "originatorName": "Satoshi Nakamoto",
        "originatorCountry": "US",
        "originatorStreetAddress": "1234 NW Bobcat Lane, St. Robert, MO",
        "originatorPostalCode": "65584-5678",
        "originatorCity": "San Francisco",
        "originatorStateProvince": "Wyoming",
        "purpose": "TRADING_SETTLEMENT"
    },
    "transferMemo": "Internal ID: #12838927347",
    "useGasStation": True
}
headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '1000.00000000',
    assetType: 'BTC',
    deductFeeFromAmountIfSameType: false,
    idempotentId: '12838927347',
    transferAmlQuestionnaire: {
      originatorType: 'MY_CLIENT',
      originatorName: 'Satoshi Nakamoto',
      originatorCountry: 'US',
      originatorStreetAddress: '1234 NW Bobcat Lane, St. Robert, MO',
      originatorPostalCode: '65584-5678',
      originatorCity: 'San Francisco',
      originatorStateProvince: 'Wyoming',
      purpose: 'TRADING_SETTLEMENT'
    },
    transferMemo: 'Internal ID: #12838927347',
    useGasStation: true
  })
};

fetch('https://api.anchorage-staging.com/v2/transfers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "status": "IN_PROGRESS",
    "transferId": "008d3ec72558ce907571886df63ef51594b5bd8cf106a0b7fa8f12a30dfc867f"
  }
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

Authorizations

Api-Access-Key

string

header

required

An API key associated with a security role

Headers

Api-Signature

string

required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body. The Api-Child-Control-Key header is NOT part of the signed payload: it carries key material used only to sign the transaction, not an authorization parameter, so it is excluded from the signature and never persisted with the operation.

Construction example:

toHex(
  ed25519Sign(
    signing_key,
    '{}{}{}{}'.format(timestamp_epoch_seconds, toUpper(httpMethod), httpRequestPath, httpBody)
  )
)

Pattern: ^[0-9A-Fa-f]{128,160}$

Api-Timestamp

integer<int64>

required

Current timestamp, represented as unix epoch seconds

Api-Child-Control-Key

string

The hex-encoded child control key of the source wallet, derived client-side from the organization's Master Control Key.

Required when the source wallet's private keys are control-key-encrypted (self-custody organizations). For other wallets a supplied value is not used to sign anything, but a malformed value is still rejected with InvalidControlKeyFormat regardless of wallet type. It is passed as a header, is NOT part of the signed request payload, is used only to sign the transaction, and is never persisted with the operation.

Body

application/json

amount

string

required

An amount of a crypto-asset to transfer, without units. The unit is derived from the asset type.

Example:

"1000.00000000"

assetType

string

required

A string representing a type of crypto-asset, which usually corresponds to the crypto asset's ticker symbol.

Use /asset-types to list all of the supported asset types for your organization.

Example:

"BTC"

assetParametersATOM

WithdrawalParametersForATOM · object

Additional parameters to be provided exclusively when assetType is "ATOM". This field is deprecated, please migrate to using assetParametersCosmos instead. When using a Trusted Destination, these parameters must not be provided — the memo is inherited from the trusted destination. Set destination.type to TRUSTED_DESTINATION and destination.id to the trusted destination ID instead.

Show child attributes

assetParametersCosmos

WithdrawalParametersForCosmos · object

Additional parameters to be provided exclusively when assetType is for a Cosmos blockchain. When using a Trusted Destination, these parameters must not be provided — the memo is inherited from the trusted destination. Set destination.type to TRUSTED_DESTINATION and destination.id to the trusted destination ID instead.

Show child attributes

assetParametersExtra

WithdrawalParametersExtra · object

Extra parameters, to be provided for assets. When using a Trusted Destination, these parameters must not be provided — the memo is inherited from the trusted destination. Set destination.type to TRUSTED_DESTINATION and destination.id to the trusted destination ID instead.

Show child attributes

assetParametersFiatTrustedDestination

WithdrawalParametersForFiatTrustedDestination · object

Additional parameters to be provided exclusively when the destination is a Trusted Destination and assetType is fiat.

Show child attributes

assetParametersXLM

WithdrawalParametersForXLM · object

Additional parameters to be provided exclusively when assetType is "XLM". When using a Trusted Destination, these parameters must not be provided — the memo is inherited from the trusted destination. Set destination.type to TRUSTED_DESTINATION and destination.id to the trusted destination ID instead.

Show child attributes

assetParametersXRP

WithdrawalParametersForXRP · object

Additional parameters to be provided exclusively when assetType is "XRP". When using a Trusted Destination, these parameters must not be provided — the destination tag is inherited from the trusted destination. Set destination.type to TRUSTED_DESTINATION and destination.id to the trusted destination ID instead.

Show child attributes

deductFeeFromAmountIfSameType

boolean

default:false

If false, any network fees will always be added to amount requested. For example, a request to transfer 5 BTC with deductFeeFromAmountIfSameType=false would result in 5 exactly BTC received to the destination wallet and just over 5 BTC spent by the source wallet.

If true and the amount transferred is the same asset type as the network fee for the transfer, the network fee is deducted from the amount instead. For example, a request to transfer 5 BTC with deductFeeFromAmountIfSameType=true would result in just under 5 BTC received to the destination wallet.

For assets where the exact fee taken by the network is not known until the transaction is mined, it is likely that the amount spent will fall just short of the amount requested. For example, a request to transfer 5 ETH with deductFeeFromAmountIfSameType=true may result in the sending wallet spending 4.97 ETH and the recipient receiving 4.9 ETH. In this example, Anchorage Digital specifies to the network a maximum allowable fee of 0.1 ETH, but the network takes only 0.07 ETH

For UTXO-based assets, if deductFeeFromAmountIfSameType=true and the amount requested for transfer is just short of the total balance of the asset, the network will refuse to accept this transaction because the remainder would be unspendable. This is an unlikely edge case. See "Bitcoin Dust" for more context.

This flag is ignored for transfers where the amount and the fee asset types are separate.

destination

Resource · object

An object representing a resource capable of receiving, or holding funds.

Construction example:

{
  "id":"1c920f4241b78a1d483a29f3c24b6c4c",
  "type":"WALLET"
}

Show child attributes

idempotentId

string

A client-provided unique ID for idempotent requests (mandatory)

Maximum string length: 128

Example:

"12838927347"

source

SourceResource · object

An object representing a resource capable of sending funds.

Construction example:

{
  "id":"1c920f4241b78a1d483a29f3c24b6c4c",
  "type":"WALLET"
}

Show child attributes

transferAmlQuestionnaire

AMLQuestionnaire · object

Anti-money laundering questionnaire submission

Show child attributes

Example:

{
  "originatorType": "MY_CLIENT",
  "originatorName": "Satoshi Nakamoto",
  "originatorCountry": "US",
  "originatorStreetAddress": "1234 NW Bobcat Lane, St. Robert, MO",
  "originatorPostalCode": "65584-5678",
  "originatorCity": "San Francisco",
  "originatorStateProvince": "Wyoming",
  "purpose": "TRADING_SETTLEMENT"
}

transferMemo

string | null

A user-supplied description that will become the description of the subsequent transfer transaction (optional)

Example:

"Internal ID: #12838927347"

useGasStation

boolean | null

If true, the Anchorage Digital gas station will pay gas fees, for supported asset types and organizations.

Response

Successfully initiate a transfer

data

Data3 · object

required

Show child attributes

Getting started

Anchorage custody

Move money

Atlas

Wealth Management & ETF

Trading

Webhooks

Create a transfer request

Identify the sending resource and asset

Identify the receiving resource

Permissions

Additional Metadata

Successful Transfers

Unsuccessful Transfers

Idempotent Requests

Queueing

Transferring Full Balance

Authorizations

Headers

Body

Response