Treasury

GET/api/v1/treasury/{domain}/analytics/flows

Analytics_flows

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

currency_id*string

Currency to report on

window_seconds?integer

Window in seconds to aggregate over (e.g. 604800 for 7d)

Formatint64

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/analytics/flows?currency_id=string"

{  "currency_id": "string",  "faucets": [    {      "tag": "string",      "total": 0    }  ],  "net_flow": 0,  "sinks": [    {      "tag": "string",      "total": 0    }  ],  "window_seconds": 0}

GET/api/v1/treasury/{domain}/analytics/supply

Analytics_supply

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

currency_id*string

Currency to report on

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/analytics/supply?currency_id=string"

{  "burned": 0,  "circulating": 0,  "minted": 0,  "currency_id": "string"}

GET/api/v1/treasury/{domain}/analytics/top-holders

Analytics_top_holders

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

currency_id*string

Currency to rank holders for

limit?integer

Maximum number of holders to return

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/analytics/top-holders?currency_id=string"

{  "concentration": 0.1,  "currency_id": "string",  "holders": [    {      "balance": 0,      "principal": {        "id": "string",        "kind": "auth_user"      },      "rank": 0,      "wallet_id": "string"    }  ]}

GET/api/v1/treasury/{domain}/currencies

List_currencies

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/currencies"

{  "currencies": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "decimal_places": 0,      "domain": "string",      "id": "string",      "name": "string",      "overdraft_policy": {        "limit": 0,        "mode": "DENY"      },      "supply_controls": {        "faucets_require_tag": true,        "max_supply": 0      },      "symbol": "string"    }  ]}

POST/api/v1/treasury/{domain}/currencies

Create_currency

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Define a new currency in a domain.

decimal_places*integer

Number of decimal places used for display (amounts are always integers)

Formatint32

Range0 <= value

id*string

Currency identifier (developer-defined, e.g. "cur_gold")

name*string

Human-readable currency name

overdraft_policy?null|

supply_controls?null|

symbol*string

Display symbol

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/currencies" \  -H "Content-Type: application/json" \  -d '{    "decimal_places": 0,    "id": "string",    "name": "string",    "symbol": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "decimal_places": 0,  "domain": "string",  "id": "string",  "name": "string",  "overdraft_policy": {    "limit": 0,    "mode": "DENY"  },  "supply_controls": {    "faucets_require_tag": true,    "max_supply": 0  },  "symbol": "string"}

POST/api/v1/treasury/{domain}/holds

Place_hold

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Place a hold against a wallet's available balance.

amount*integer

Positive amount to reserve

Formatint64

expires_in_seconds?|

Optional time-to-live in seconds after which the hold auto-releases

Formatint64

idempotency_key?|

Optional idempotency key; retries with the same key replay the stored hold

reference?null|

wallet_id*string

Wallet to reserve funds from

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/holds" \  -H "Content-Type: application/json" \  -d '{    "amount": 0,    "wallet_id": "string"  }'

{  "amount": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "reference": null,  "status": "ACTIVE",  "wallet_id": "string"}

POST/api/v1/treasury/{domain}/holds/{hold_id}/capture

Capture_hold

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

hold_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Capture an active hold, optionally for less than the held amount.

amount?|

Amount to capture; defaults to the full hold amount when omitted

Formatint64

idempotency_key?|

Optional idempotency key; retries with the same key replay the stored hold

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/holds/string/capture" \  -H "Content-Type: application/json" \  -d '{}'

{  "amount": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "reference": null,  "status": "ACTIVE",  "wallet_id": "string"}

POST/api/v1/treasury/{domain}/holds/{hold_id}/release

Release_hold

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

hold_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Release an active hold, freeing the reserved funds.

idempotency_key?|

Optional idempotency key; retries with the same key replay the stored hold

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/holds/string/release" \  -H "Content-Type: application/json" \  -d '{}'

{  "amount": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "reference": null,  "status": "ACTIVE",  "wallet_id": "string"}

POST/api/v1/treasury/{domain}/settle

Settle

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Atomically capture a set of holds and apply extra balanced legs as one transfer.

extra_legs?array<>

Extra legs applied in the same atomic transfer (must balance per currency)

hold_ids*array<string>

Active holds to capture for their full reserved amount

idempotency_key*string

Mandatory idempotency key; retries with the same key are deduplicated

reference?null|

tags?array<string>

Free-form tags; required when a faucet/sink leg is present

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/settle" \  -H "Content-Type: application/json" \  -d '{    "hold_ids": [      "string"    ],    "idempotency_key": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "id": "string",  "idempotency_key": "string",  "legs": [    {      "amount": 0,      "direction": "DEBIT",      "wallet_id": "string"    }  ],  "reference": null,  "status": "COMMITTED",  "tags": [    "string"  ],  "captured_holds": [    "string"  ],  "idempotent_replay": true}

POST/api/v1/treasury/{domain}/transfers

Create_transfer

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Submit a multi-leg transfer.

idempotency_key*string

Mandatory idempotency key; retries with the same key are deduplicated

legs*array<>

The legs that must balance per currency (faucet/sink legs excepted)

reference?null|

tags?array<string>

Free-form tags; required when a faucet/sink leg is present

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/transfers" \  -H "Content-Type: application/json" \  -d '{    "idempotency_key": "string",    "legs": [      {        "amount": 0,        "direction": "DEBIT",        "wallet_id": "string"      }    ]  }'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "id": "string",  "idempotency_key": "string",  "legs": [    {      "amount": 0,      "direction": "DEBIT",      "wallet_id": "string"    }  ],  "reference": null,  "status": "COMMITTED",  "tags": [    "string"  ],  "idempotent_replay": true}

GET/api/v1/treasury/{domain}/wallets

List_wallets

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

principal?string

Principal selector in the form kind:id (e.g. auth_user:usr_01J9ABCD)

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/wallets"

{  "count": 0,  "wallets": [    {      "available": 0,      "balance": 0,      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "currency_id": "string",      "domain": "string",      "frozen": true,      "held": 0,      "id": "string",      "kind": "STANDARD",      "principal": {        "id": "string",        "kind": "auth_user"      },      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

POST/api/v1/treasury/{domain}/wallets

Create_wallet

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a wallet for a principal in a currency.

currency_id*string

Currency this wallet holds

kind?null|

principal*

Owning principal (kind + id)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/treasury/string/wallets" \  -H "Content-Type: application/json" \  -d '{    "currency_id": "string",    "principal": {      "id": "string",      "kind": "auth_user"    }  }'

{  "available": 0,  "balance": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "currency_id": "string",  "domain": "string",  "frozen": true,  "held": 0,  "id": "string",  "kind": "STANDARD",  "principal": {    "id": "string",    "kind": "auth_user"  },  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/treasury/{domain}/wallets/{wallet_id}

Get_wallet

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

wallet_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/wallets/string"

{  "available": 0,  "balance": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "currency_id": "string",  "domain": "string",  "frozen": true,  "held": 0,  "id": "string",  "kind": "STANDARD",  "principal": {    "id": "string",    "kind": "auth_user"  },  "updated_at": "2019-08-24T14:15:22Z"}

PATCH/api/v1/treasury/{domain}/wallets/{wallet_id}/freeze

Freeze_wallet

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

wallet_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Freeze or unfreeze a wallet (admin only).

frozen*boolean

Whether the wallet should be frozen

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/treasury/string/wallets/string/freeze" \  -H "Content-Type: application/json" \  -d '{    "frozen": true  }'

{  "available": 0,  "balance": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "currency_id": "string",  "domain": "string",  "frozen": true,  "held": 0,  "id": "string",  "kind": "STANDARD",  "principal": {    "id": "string",    "kind": "auth_user"  },  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/treasury/{domain}/wallets/{wallet_id}/history

Wallet_history

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

wallet_id*string

Query Parameters

limit?integer

Maximum number of entries to return

Formatint64

Range0 <= value

cursor?string

Opaque cursor (stream id) to page from

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/treasury/string/wallets/string/history"

{  "entries": [    {      "amount": 0,      "balance_after": 0,      "created_at": "2019-08-24T14:15:22Z",      "direction": "DEBIT",      "entry_id": "string",      "reference": null,      "tags": [        "string"      ],      "transfer_id": "string",      "wallet_id": "string"    }  ],  "next_cursor": "string",  "wallet_id": "string"}

Treasury

200application/json

403

404

200application/json

403

404

200application/json

403

404

200application/json

201application/json

400

403

409

200application/json

201application/json

403

404

409

200application/json

403

404

409

200application/json

403

404

409

200application/json

201application/json

400

403

404

409

201application/json

400

403

404

409

200application/json

400

403

201application/json

400

403

404

200application/json

403

404

200application/json

403

404

200application/json

403

404

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`