Sign in

v46

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-211591,0051.4 MB
Wallet Actions

Earn withdraw

Withdraw assets from an ERC-4626 vault.

post/v1/wallets/{wallet_id}/earn/ethereum/withdraw

Path parameters

wallet_idstring required

ID of the wallet.

Headers

privy-app-idstring required

ID of your Privy app.

privy-authorization-signaturestring

Request authorization signature. If multiple signatures are required, they should be comma separated.

privy-request-expirystring

Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed.

privy-idempotency-keystring

Idempotency keys ensure API requests are executed only once within a 24-hour window.

Request body

amountstring

Human-readable decimal amount to withdraw (e.g. "1.5" for 1.5 USDC). Exactly one of amount or raw_amount must be provided.

raw_amountstring

Amount in smallest unit to withdraw (e.g. "1500000" for 1.5 USDC with 6 decimals). Exactly one of amount or raw_amount must be provided.

vault_idstring required

The ID of the vault to withdraw from.

Example request

{
  "amount": "1.5",
  "vault_id": "cm7oxq1el000e11o8iwp7d0d0"
}

Response

Earn withdraw initiated successfully.

amountstring

Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when the token is known in the asset registry.

assetstring

Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in the asset registry.

asset_addressstring required

Underlying asset token address.

caip2string required

CAIP-2 chain identifier.

created_atstring date-time required

ISO 8601 timestamp of when the wallet action was created.

decimalsinteger

Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only present when the token is known in the asset registry.

idstring required

The ID of the wallet action.

raw_amountstring required

Base-unit amount of asset withdrawn (e.g. "1500000").

share_amountstring nullable required

Vault shares burned in base units. Populated after on-chain confirmation.

status'pending' | 'succeeded' | 'rejected' | 'failed' required

The current status of the wallet action.

type'earn_withdraw' required
vault_addressstring required

ERC-4626 vault contract address.

vault_idstring required

The vault ID.

wallet_idstring required

The ID of the wallet involved in the action.