Settlement executor: the call outbox, every external movement and anchor as an envelope — reference, target, call, expiry — not yet taken over (F-027). The adapter's principal only.

GET

/v1/settlement/calls

const url = 'https://example.com/v1/settlement/calls';
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/calls \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

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

application/json

Array<object>

One call of the call outbox, as the executor reads it (F-027 T-027-01, DEC-18): the envelope — reference, target, call, expiry — and whether the executor holds it.

object

acknowledged

required

Whether the executor has acknowledged it.

boolean

call

required

One of:

Pay out a reservation.

object

withdraw

required

object

amount

required

The exact amount: minor units, as a decimal-integer string.

string

asset

required

The asset.

string

destination

required

One of:

object
object

A plain account on the settlement layer: 32 bytes of hex.

object

account

required

string

Another deployment on the same settlement layer (REQ-SL-6).

object

instance

required

object

account_ref

required

The opaque account reference it resolves: 32 bytes of hex.

string

instance

required

Its instance.

integer format: uint32

Bind a book-only asset (amendment 0011, REQ-AS-8): the layer records its holding of the asset at location as the deployment’s position only if it equals amount exactly.

object

bind

required

object

amount

required

The book’s outstanding balance: minor units, as a decimal-integer string. May be zero.

string

asset

required

The book’s asset.

string

location

required

Its location on the layer, in the layer’s textual form (Here(100)).

string

expiry

The settlement-layer height after which it can no longer take effect; absent for an anchor.

integer | null format: uint64

instruction

For a withdrawal: the instruction’s identity, which the acknowledgement names, 32 bytes of hex. The executor recomputes it from the envelope and refuses a call where they differ.

string | null

reference

required

What the layer records the call’s outcome under: 32 bytes of hex.

string

reserved

For a withdrawal: that a reservation exists for it, always true (INV-13).

boolean | null

target

required

The deployment’s instance the call acts for.

integer format: uint32

Example^generated

[
  {
    "acknowledged": true,
    "call": {
      "withdraw": {
        "amount": "example",
        "asset": "example",
        "destination": {
          "account": "example"
        }
      }
    },
    "expiry": 1,
    "instruction": "example",
    "reference": "example",
    "reserved": true,
    "target": 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 executor: the call outbox, every external movement and anchor as an envelope — reference, target, call, expiry — not yet taken over (F-027). The adapter's principal only.

Authorizations

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated