Pilot environment: testnet, simulated yield, mocked fiat rails — read the disclosure
API referenceChangelog
Vault withdrawals

List your vault withdrawals

Your vault withdrawals, newest first, each with its status on the one savings status vocabulary (QUEUED, PROCESSING, CREDIT_PENDING, COMPLETED, FAILED, REFUNDED, CANCELLED). Filter by status. Fetch one in full with GET /withdrawals/{id}.

GET
/api/partner/v1/withdrawals

Your vault withdrawals, newest first, each with its status on the one savings status vocabulary (QUEUED, PROCESSING, CREDIT_PENDING, COMPLETED, FAILED, REFUNDED, CANCELLED). Filter by status. Fetch one in full with GET /withdrawals/{id}.

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

The nextCursor from the previous page. Omit it for the first page. Treat it as opaque.

limit?integer

Rows per page, 1-100. Defaults to 25.

Rangevalue <= 100
Default25
status?string

Only withdrawals in this status.

Value in

  • "QUEUED"
  • "PROCESSING"
  • "CREDIT_PENDING"
  • "COMPLETED"
  • "FAILED"
  • "REFUNDED"
  • "CANCELLED"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/partner/v1/withdrawals"
{  "data": {    "items": [      {        "createdAt": "2026-10-06T10:02:05.000Z",        "creditedAmount": "249.99",        "currency": "USD",        "estimatedAvailableAt": "2026-10-06T10:02:13.000Z",        "requestedAmount": "250",        "settledAt": "2026-10-06T10:02:13.000Z",        "shares": "249.380000000000000000000000",        "status": "COMPLETED",        "subAccountId": "5d3b8e10-2f47-4c9a-b6e8-0a71d4c2f395",        "withdrawalId": "7a1d0c55-91e2-4f36-8b0a-2e64c9d8f173"      }    ]  },  "success": true,  "timestamp": "2026-09-02T10:15:30.000Z"}

Fetch one deposit by id GET

The deposit in its CURRENT state, whatever that is — including a terminal failure, reported here as the object rather than as an error. This is the fetch half of the thin webhook payloads (a *.settled / *.failed event carries only a resource pointer) and the poll surface the money errors point at.

Withdraw fiat from a curated vault POST

Redeems vault shares held in your vault sub-account back to fiat. The amount is asset-denominated — ask for a sum of fiat, exactly as on a deposit. 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. Settlement rounds DOWN to the currency precision the banking leg accepts: the response reports settledAmount and precisionResidue separately, and the residue stays in your vault sub-account wallet — it is not a fee. Every response carries the pilot disclosure: the environment is a testnet and the yield is simulated, not earned.