Settlement adapter: the checkpoint in flight and whether a comparison is due (F-017). The adapter's principal only.

GET

/v1/settlement/anchor

const url = 'https://example.com/v1/settlement/anchor';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/settlement/anchor \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

The adapter’s read of anchoring (F-017): the checkpoint in flight, and whether a settlement comparison is due.

object

comparison_due

required

Whether a final checkpoint has no settlement comparison yet (AC-J3.1).

boolean

instruction

Any of:

object
null

The checkpoint in flight, as the adapter reads it (F-017): a number and a commitment, nothing else (REQ-PR-2).

object

acknowledged

required

Whether the adapter has acknowledged it.

boolean

commitment

required

The commitment, 32 bytes of hex.

string

number

required

The anchor number.

integer format: uint64

Example^generated

{
  "comparison_due": true,
  "instruction": {
    "acknowledged": true,
    "commitment": "example",
    "number": 1
  }
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).

Settlement adapter: the checkpoint in flight and whether a comparison is due (F-017). The adapter's principal only.

Authorizations

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated