Withdraw a holding to an arbitrary party
Sends `amount` of `symbol` to `receiver` (a FULL party id — the one documented exception to the hints convention, since the destination is not necessarily a known desk party) via the instrument's token-standard transfer factory. `symbol` is a catalog symbol (any case). Works on every real network; the local sandbox answers 501. Blocked while a trade of this party is settling in the same instrument (its allocations may need the same holdings).
Sends amount of symbol to receiver (a FULL party id — the one
documented exception to the hints convention, since the destination is
not necessarily a known desk party) via the instrument's token-standard
transfer factory. symbol is a catalog symbol (any case). Works on
every real network; the local sandbox answers 501. Blocked while a
trade of this party is settling in the same instrument (its
allocations may need the same holdings).
Authorization
ApiKeyAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/wallet/withdraw" \ -H "Content-Type: application/json" \ -d '{ "symbol": "cbtc", "amount": "0.5", "receiver": "string" }'{ "actions": [ { "id": "string", "kind": "hash", "purpose": "allocate", "description": "Sign your quote 97300 (2/2: USDCx allocation)", "hash": "string", "tradeId": "string", "createdAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z" } ]}{ "actions": [ { "id": "string", "kind": "hash", "purpose": "allocate", "description": "Sign your quote 97300 (2/2: USDCx allocation)", "hash": "string", "tradeId": "string", "createdAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z" } ]}{ "error": "string", "code": "INSUFFICIENT_FUNDS"}{ "error": "string", "code": "INSUFFICIENT_FUNDS"}{ "error": "string", "code": "INSUFFICIENT_FUNDS"}{ "error": "string", "code": "INSUFFICIENT_FUNDS"}{ "error": "string", "code": "INSUFFICIENT_FUNDS"}Accept one pending incoming transfer POST
For a node-hosted bot maker (external signing) this enqueues a sign action instead of settling immediately (202) — sign its `hash` and `POST /tx/execute`; the holding lands under the party once that runs.
Support
Where to write, what to include, and where the source and announcements live