Create a withdrawal request

curl --request POST \
  --url https://api.anchorage-staging.com/v2/transactions/withdrawal \
  --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",
  "description": "Internal ID: #12838927347",
  "idempotentId": "12838927347",
  "useGasStation": true
}
'

import requests

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

payload = {
    "amount": "1000.00000000",
    "assetType": "BTC",
    "description": "Internal ID: #12838927347",
    "idempotentId": "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',
    description: 'Internal ID: #12838927347',
    idempotentId: '12838927347',
    useGasStation: true
  })
};

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

{
  "data": {
    "withdrawalId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
  }
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

Create a withdrawal request

Permissions required: Initiate withdrawals

Identify the sending asset

To initiate a withdrawal from a wallet to an external destination, you must identify which asset you’d like to withdraw funds from. Provide a source (with id and type).

Identify the receiving resource

Choose a resource to receive the funds as the destination. This resource may belong to your organization (wallet) or another organization (address, standing instruction).

Permissions

The provided API key must be associated with a permission group that has Initiate withdrawals permission for the sending vault.

Additional Metadata

You may provide a description with each withdrawal, that will be visible within your organization in the Anchorage Digital iOS Application.

Successful Withdrawals

If the withdrawal request is valid, the request will initiate a withdrawal transaction from the sending wallet. This is a common withdrawal that, unlike Transfers, will still require a quorum of approvals on the Anchorage Digital iOS app and will undergo manual Anchorage Digital Risk Review. Like other transactions, these withdrawals will be visible on the Anchorage Digital iOS Application, the Web Dashboard, and in the list transactions API endpoint.

Unsuccessful Withdrawals

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

An ongoing withdrawal already exists (unlike transfers, withdrawal requests are not queued)
The specified asset does not exist
The specified amount exceeds the available funds for this asset (insufficient funds)
The destination address is invalid
The provided API key does not have permissions to initiate withdrawals from this wallet

If the initiated withdrawal is approved by the quorum, the 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
There is a failure on the blockchain

POST

transactions

withdrawal

Create a withdrawal request

curl --request POST \
  --url https://api.anchorage-staging.com/v2/transactions/withdrawal \
  --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",
  "description": "Internal ID: #12838927347",
  "idempotentId": "12838927347",
  "useGasStation": true
}
'

import requests

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

payload = {
    "amount": "1000.00000000",
    "assetType": "BTC",
    "description": "Internal ID: #12838927347",
    "idempotentId": "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',
    description: 'Internal ID: #12838927347',
    idempotentId: '12838927347',
    useGasStation: true
  })
};

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

{
  "data": {
    "withdrawalId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
  }
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "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.

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

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

description

string | null

An optional string providing more context to this transaction. It will be visible on the Anchorage Digital iOS app and will not be published to the blockchain.

Example:

"Internal ID: #12838927347"

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 | null

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

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

useGasStation

boolean | null

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

withdrawalAmlQuestionnaire

AMLQuestionnaire · object

Anti-money laundering questionnaire submission

Show child attributes

Response

Successfully initiated a withdrawal

data

WithdrawalDetails · object

required

Show child attributes

Example:

{
  "withdrawalId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
}

Cancel a transfer request List transactions

⌘I