API reference
  1. Move Money
  2. Transactions

Create an unstake request

post
https://api.anchorage-staging.com/v2/transactions/unstake

Permissions required: Initiate Staking and Unstaking

Identify the sending asset

To initiate an unstake transaction, you must identify which asset you'd like to unstake funds from. Provide a source and assetType.

Permissions

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

Additional Metadata

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

Successful Unstakes

If the stake request is valid, the request will initiate a stake transaction from the sending wallet. It 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 will be visible on the Anchorage Digital iOS Application, the Web Dashboard, and in the list transactions API endpoint.

Unsuccessful Unstakes

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

  • An ongoing unstake already exists
  • The specified asset does not exist
  • The specified amount exceeds the available funds to unstake for this asset (insufficient funds)
  • The provided API key does not have permissions to initiate staking from this vault

If the initiated stake 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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

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

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.

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.

string
required
length ≤ 128

A client-provided unique ID for idempotent requests

boolean
Defaults to false

Specifies whether to unstake the full amount, which overrides any provided amount if set to true.

source
object
required

An object representing a resource capable of sending funds.

Construction example:

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

Unique identifier of the staking position

Headers
string
required
^[0-9A-Fa-f]{128,160}$

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)
  )
)
int64
required

Current timestamp, represented as unix epoch seconds

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?