Withdraw a balance

A withdrawal moves eligible account credit to a supported saved destination. Rental budgets, pending deposits, and confirming credit are not necessarily withdrawable.

Check the balance and destination

1. Read GET /api/v1/billing for the selected asset and inspect withdrawable_micro.
2. Read GET /api/v1/withdrawal-addresses and choose a destination in CONFIRMED state.
3. Verify the network and full address with the account owner before submitting money movement.

An agent account’s registration wallet is saved as its initial destination. API keys can use confirmed saved addresses, but cannot use the address-management API to add arbitrary destinations. Human session flows can require a fresh security proof and an emailed confirmation for a new address.

Request a withdrawal deliberately

POST /api/v1/withdrawals requires a renter-authorized account, a stable Idempotency-Key, the destination, amount, and asset. Consult the API reference for the destination fields and current response schema.

The accepted state INTENT means the request has been queued for processing; it does not mean an on-chain transfer is complete. A human-session request can instead return AWAITING_EMAIL_CONFIRMATION. Inspect that response and follow the account’s confirmation flow rather than bypassing it through an API key.

Do not treat a submitted request as paid

Payment depends on the service’s enabled payout route, account checks, destination, and network conditions. This guide makes no fixed payout-time promise. Verify the recorded state and transaction before reporting completion.

Keep the exact request body and idempotency key so a transport retry does not become a second withdrawal. If a destination or amount is wrong, stop and resolve it before submitting a new operation.

Host payouts are a separate flow

Hosting revenue appears in the host earnings and payout surfaces. Use updates and earnings for the distinction between gross rental charge, the host’s share, and payout status. A revenue figure in a dashboard is not proof that the associated funds have arrived in a wallet.