Propose settling assets out of a delegation

curl --request POST \
  --url https://api.anchorage-staging.com/v2/atlas/delegations/{delegationId}/settle \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotentId": "<string>",
  "walletAmounts": [
    {
      "assetType": "BTC",
      "quantity": "10.45234733",
      "walletId": "<string>"
    }
  ],
  "clientReferenceId": "<string>"
}
'

import requests

url = "https://api.anchorage-staging.com/v2/atlas/delegations/{delegationId}/settle"

payload = {
    "idempotentId": "<string>",
    "walletAmounts": [
        {
            "assetType": "BTC",
            "quantity": "10.45234733",
            "walletId": "<string>"
        }
    ],
    "clientReferenceId": "<string>"
}
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({
    idempotentId: '<string>',
    walletAmounts: [{assetType: 'BTC', quantity: '10.45234733', walletId: '<string>'}],
    clientReferenceId: '<string>'
  })
};

fetch('https://api.anchorage-staging.com/v2/atlas/delegations/{delegationId}/settle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "settlementRequestId": "<string>"
}

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

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

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

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

Propose settling assets out of a delegation

Permissions required: Propose and Accept settlements

As either party to a delegation, propose settling delegated assets out of the delegation or into it, using wallets owned by your organization. The delegation’s settle rights can limit which party may propose.

Positive quantities indicate funds your wallets receive; negative quantities indicate funds they send. Every wallet amount must point the same way; an asset may be sent from several wallets but received into only one. Funds settled into the delegation land in the pledgor’s wallet for that asset in the delegation’s vault, and the delegation grows by them.

The settlement requires the delegator’s approval before any assets move. The request is accepted for processing and can be tracked via the returned settlementRequestId.

POST

atlas

delegations

{delegationId}

settle

Propose settling assets out of a delegation

curl --request POST \
  --url https://api.anchorage-staging.com/v2/atlas/delegations/{delegationId}/settle \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotentId": "<string>",
  "walletAmounts": [
    {
      "assetType": "BTC",
      "quantity": "10.45234733",
      "walletId": "<string>"
    }
  ],
  "clientReferenceId": "<string>"
}
'

import requests

url = "https://api.anchorage-staging.com/v2/atlas/delegations/{delegationId}/settle"

payload = {
    "idempotentId": "<string>",
    "walletAmounts": [
        {
            "assetType": "BTC",
            "quantity": "10.45234733",
            "walletId": "<string>"
        }
    ],
    "clientReferenceId": "<string>"
}
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({
    idempotentId: '<string>',
    walletAmounts: [{assetType: 'BTC', quantity: '10.45234733', walletId: '<string>'}],
    clientReferenceId: '<string>'
  })
};

fetch('https://api.anchorage-staging.com/v2/atlas/delegations/{delegationId}/settle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "settlementRequestId": "<string>"
}

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

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

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

Api-Timestamp

integer<int64>

required

Current timestamp, represented as unix epoch seconds

Path Parameters

delegationId

string

required

ID of the delegation to settle assets out of or into

Minimum string length: 1

Body

application/json

Settlement request

idempotentId

string

required

Maximum string length: 128

walletAmounts

object[]

required

The assets to settle and the wallets that receive or send them. A received asset can appear only once; a sent asset can come from several wallets, each listed once per asset.

Minimum array length: 1

Show child attributes

clientReferenceId

string

Optional reference memo recorded on the settlement and visible to both parties.

Maximum string length: 128

Response

Settlement request accepted and awaiting the delegator's approval

settlementRequestId

string

required

Identifier for tracking this settlement request.

Getting started

Anchorage custody

Move money

Atlas

Wealth Management & ETF

Trading

Named Virtual Accounts

Webhooks

Propose settling assets out of a delegation

Authorizations

Headers

Path Parameters

Body

Response