Skip to main content
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
}
'
{
  "data": {
    "withdrawalId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
  }
}

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.

​
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.

​
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.

​
assetParametersFiatTrustedDestination
WithdrawalParametersForFiatTrustedDestination · object

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

​
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.

​
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.

​
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"
}
​
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"
}
​
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

Response

Successfully initiated a withdrawal

​
data
WithdrawalDetails · object
required
Example:
{
  "withdrawalId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
}