Quickstart

Buy units of a money-market fund with a tokenized deposit on your NodeAsset deployment. It takes three calls from you and two acts by the other parties, and one transaction settles both registries. The steps carry the Tx numbers of Subscriptions.

Before you start

A NodeAsset deployment on DevNet, TestNet or MainNet, with its engine’s URL and a bearer from your identity provider for a user with the operator role. To set one up, see Install.
An asset paid on the ledger, with its standing consent live (Set up an asset). Here it is a fund paid in a tokenized deposit; a stablecoin works the same way.
An investor admitted to the asset and holding the payment asset (Onboard investors).

The examples use the fund FUND, its tokenized deposit TD and the investor inv-001.Check the bearer:

curl

export ENGINE="https://engine.example"   # your engine, without /v1
export TOKEN="<an operator's bearer>"
curl -s "$ENGINE/v1/whoami" -H "Authorization: Bearer $TOKEN"
# {"offset":0,"now":"…","value":{"sub":"ops-1","roles":["operator"],…}}

Tx 1 · Record the order

The order is a subscription: here, 30 units of FUND for inv-001. The answer is the operation the write became.

curl

curl -sX POST "$ENGINE/v1/subscriptions" -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -H "Idempotency-Key: lot-001" \
  -d '{"instrumentId":"FUND","holderId":"inv-001","apId":"ap-1","units":"30.0","subscriptionId":"lot-001"}'
# {"state":"queued","operationId":"op-…","kind":"subscription.claim",…}

Tx 2 · The price source prices the subscription

From its own node, the price source signs the subscription’s price by accepting its proposal at a NAV of 1.003333 (LotProposal_Accept). The subscription then reads priced, with its appliedNav.

Tx 3 · Ask for the payment

The first settle call sends the investor the payment request: 30 × 1.003333, rounded up to the deposit’s cent.

curl

curl -sX POST "$ENGINE/v1/subscriptions/lot-001:settle" -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: lot-001-ask"
# the operation's result: {"state":"priced","orderState":"awaiting-payment","amount":30.10,…}

Tx 4 to 6 · The investor pays

In its wallet, the investor’s custodian makes a CIP-112 allocation of the deposit on the bank’s registry and another for the receipt of the units on the fund’s registry, then accepts the request (AllocationRequest_Accept).

Tx 7 · Settle

The same call again, under a new key, settles both registries in one transaction: it mints the units and pays the deposit.

curl

curl -sX POST "$ENGINE/v1/subscriptions/lot-001:settle" -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: lot-001-settle"
curl -s "$ENGINE/v1/subscriptions/lot-001" -H "Authorization: Bearer $TOKEN"
# {"offset":…,"now":"…Z","value":{"subscriptionId":"lot-001","state":"delivered","orderState":"minted",
#  "units":30.0000000000,"appliedNav":1.0033330000,…}}

Before the investor has answered, this call settles nothing and names the allocations it awaits (awaiting).

How the API works

Sign-in, errors, retries, pages, decimals and four eyes.

Subscribe and redeem

Both directions, paid on the ledger or off it.

Get started

Guides

Connect your systems

Events

Tools

How the API works

Subscribe and redeem