Vault subscriptions
List your vault subscriptions
Newest first. Filter by status.
Newest first. Filter by status.
Authorization
bearer AuthorizationBearer <token>
In: header
Query Parameters
cursor?string
The nextCursor from the previous page. Opaque.
limit?integer
Range
value <= 100Default
25status?string
Value in
- "PENDING"
- "EXECUTING_ONCHAIN"
- "QUEUED"
- "SETTLED"
- "CANCELLED"
- "FAILED"
- "FAILED_PENDING_COMPENSATION"
- "COMPENSATED"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/partner/v1/share-subscriptions"{ "data": { "items": [ { "amount": "1000", "createdAt": "2026-09-02T10:15:30.000Z", "currency": "USD", "custody": { "mode": "TCB_SUBACCOUNT", "walletAddress": "0x3B9aC4f27D18E056b1C4a9F30d2E85c7A6b1F094" }, "disclosure": { "items": [ "ENVIRONMENT_IS_TESTNET: The environment is a testnet (Arbitrum Sepolia). No mainnet deployment exists.", "YIELD_IS_SIMULATED: The vault rate is set administratively and the interest it produces is minted as fresh underlying, not earned. It does not represent a return generated by deployed capital.", "FIAT_RAILS_ARE_MOCKED: No real fiat movement occurs. Balances are ledger entries against a sandbox provider.", "CONVERSION_RATES_ARE_MARKET_QUOTED_OR_REFUSED: A conversion is priced only by an external venue that quotes independently of TCB. When no such venue can price the pair, the conversion is refused rather than priced from an internal table. Read rate.pricingModel on every conversion: MARKET is a venue quote; any other value is not a market rate and must not be presented as one.", "CONTRACTS_ARE_UNAUDITED: No audit has been performed. Mainnet is gated on a two-firm audit that has not been commissioned.", "CUSTODY_IS_TCB_SUBACCOUNT: Everything held for the client — its vault shares, and the tcbUSD it holds between the steps of the tokenised deposit chain — is held in TCB custody, in the one TCB wallet assigned to the client. The client holds no keys and moves those tokens only through this API; each sub-account's shares and tcbUSD are book entries against what that wallet holds.", "INTEGRATION_AGREEMENT_ONLY: Fees as published on the rate card; no yield share, no return commitment." ], "summary": "This is a pilot integration on a testnet. Nothing in this system earns anything: the yield is simulated and the fiat rails are mocked.", "version": "2026-10-27" }, "fiatAccountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "id": "7c1e5a90-2b4d-4f86-9e13-5a0d7b2c4e68", "idempotencyKey": "acme-step-2026-10-12-0001", "onchain": { "txHash": "0x4a1f9c07d3b28e615a0c47f8d29b3e6c15087af2d94b6c308e17b5d02fa4c396" }, "queue": { "claimableAt": "2026-09-02T10:15:30.000Z", "fills": [ { "bookedAt": "2026-09-02T10:15:30.000Z", "tokens": "400", "txHash": "0x8c41…" } ], "onchainRequestId": "42", "sharesEscrowed": "398.120000000000000000000000" }, "replayed": false, "settledAt": "2026-09-02T10:15:30.000Z", "shares": { "moved": "987.654321000000000000000000" }, "status": "SETTLED", "subAccountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "token": { "address": "0x5c9E0a7d4F3b21C68e0A9b7D1f2E34c5A6b7C8d9", "chain": "ARBITRUM", "symbol": "tcbUSD" }, "tokens": { "moved": "1000" }, "type": "TOKEN_MINT", "vault": { "address": "0x7a2fD3c8e91B4A5d06E7c1F2b38A9d4C5e6f0B12", "chain": "ARBITRUM" } } ] }, "success": true, "timestamp": "2026-09-02T10:15:30.000Z"}Fetch one tcbUSD mint GET
The mint in its current state, failures included.
Put tcbUSD into the vault POST
Moves tcbUSD booked to the sub-account into the currency's vault and books the shares it receives to the same sub-account. Authorised against that sub-account's available tcbUSD only. An idempotency key is MANDATORY: send it as the Idempotency-Key header or as the idempotencyKey body field. Replaying a key returns the original result without re-executing; reusing one with different parameters is rejected with IDEMPOTENCY_KEY_REUSED.