Whether a spend would pass the checks before the kernel, or why not.

GET

/v1/accounts/{account}/can-spend

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

Says whether a spend of amount minor units of asset from the account would pass the checks before the kernel, and names the reason if it would not. Both parameters are required: a missing one is refused as ERR-QueryUnbounded. Any other parameter, an asset that is not a valid symbol and an amount that is not a count of minor units are refused as ERR-MalformedCommand.

Authorizations

bearer

Parameters

Path Parameters

account

required

string

A did:aledgent identifier.

Query Parameters

amount

For can_spend: the amount, in minor units.

string | null

asset

The asset.

string | null

Responses

200

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

application/json

can_spend (SPEC §8.2): yes, or a refusal naming why not.

object

required

Always true: a “no” is a refusal with its reason.

boolean

Example^generated

{
  "ok": 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)).

Whether a spend would pass the checks before the kernel, or why not.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated