Settlement adapter: the instructions it has not acknowledged (F-016). The adapter's principal only.

GET

/v1/settlement/instructions

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

Authorizations

bearer

Responses

200

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

application/json

Array<object>

An instruction in the outbox, as the adapter reads it (REQ-SO-5).

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

digest

required

Its identity, which the acknowledgement names: 32 bytes of hex.

string

expiry

required

The settlement-layer height after which it can no longer take effect (REQ-SL-4).

integer format: uint64

operation_reference

required

The operation reference, which the layer’s record of the movement carries.

string

reserved

required

That a reservation exists for it: always true (INV-13).

boolean

Example^generated

[
  {
    "amount": "example",
    "asset": "example",
    "destination": {
      "account": "example"
    },
    "digest": "example",
    "expiry": 1,
    "operation_reference": "example",
    "reserved": true
  }
]

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 instructions it has not acknowledged (F-016). The adapter's principal only.

Authorizations

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated