Skip to main content
POST
/
atlas
/
settlements
Propose a settlement
curl --request POST \
  --url https://api.anchorage-staging.com/v2/atlas/settlements \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acceptorId": "<string>",
  "idempotentId": "<string>",
  "proposerId": "<string>",
  "vaultId": "<string>",
  "walletAmounts": [
    {
      "assetType": "BTC",
      "quantity": "10.45234733",
      "walletId": "<string>"
    }
  ],
  "applyPostLock": true,
  "clientReferenceId": "<string>",
  "useGasStation": true
}
'
{
  "settlementId": "<string>"
}
Signed and idempotent. The signer injects idempotentId into the body before computing the signature.

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

Settlement proposal

​
acceptorId
string
required
​
idempotentId
string
required
Maximum string length: 128
​
proposerId
string
required
​
vaultId
string
required

The vault ID of the proposer. It needs to match the vault that the wallets are in.

​
walletAmounts
object[]
required

In a proposal, each asset type can appear only once in the wallet amount list.

​
applyPostLock
boolean

Conditional. This parameter is only applicable for clients utilizing Atlas settlements integrated with "Anchorage Vesting". When set to true, it enables the automatic creation of post-settlement vesting schedules. Note: Enabling this will place indefinite holds on the acceptor's destination wallets immediately following a successful settlement

​
clientReferenceId
string

An ID, set by the proposer, visible to both sides, to uniquely identify the purpose of the settlement so that both sides can account for it correctly.

​
useGasStation
boolean

Option to request to use Gas Station to cover fees for proposer.

Response

settlementId

​
settlementId
string
required