Create a collect request

Permissions required: Initiate Staking and Unstaking

In staking, the "collect" operation is the action of claiming inactive unstaked amount back to the available balance by moving them from the staking protocol or pool into a personal wallet. Once collected, these amounts are fully under wallet's owner control.

NOTE: This endpoint is under development.

post/transactions/collect

Headers

Api-Signaturestring 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) ) )

Api-Timestampinteger required

Current timestamp, represented as unix epoch seconds

Request body

amountstring

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

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

descriptionstring nullable

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.

idempotentIdstring

A client-provided unique ID for idempotent requests

isFullAmountboolean

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

stakingPositionIdstring required

Unique identifier of the staking position

Example request

{
  "amount": "32",
  "assetType": "ETH",
  "description": "Internal ID: #12838927347",
  "idempotentId": "12838927347",
  "source": {
    "id": "1c920f4241b78a1d483a29f3c24b6c4c"
  },
  "stakingPositionId": "9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a"
}

Response

Successfully initiated a collect transaction

Example response

{
  "data": {
    "transactionId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.