Atlas Settlement Network

Authorize a settlement

Permissions required: Authorize Settlements

After your participant has proposed a settlement or accepted a settlement proposal, the details of the settlement must be authorized.

To authorize via API, the API key must have a special permission. Otherwise, authorization takes place in the app according to organization policy.

post/atlas/settlements/{settlementId}/authorize

Request

Base URL
https://api.anchorage-staging.com/v2
Auth
API key in header Api-Access-Key
TypeScript
https://skmtc.dev/anchorage/apis/anchorage-digital-api-reference/docs/atlas/settlements/:settlementId/authorize/post.ts
A function with typed inputs. Its response is checked against the schema.

settlementIdstring required

ID of settlement to authorize

participantIdstring required

ID of participant authorizing the settlement

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

acceptorIdstring required

proposerIdstring required

{
  "walletAmounts": [
    {
      "assetType": "BTC",
      "quantity": "10.45234733"
    }
  ]
}

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