Skip to main content
Deposit assets from a wallet into a vault using the deposit endpoint. Privy handles the ERC-20 approval and deposit in a single call. The wallet depositing funds and the admin wallet will receive shares corresponding to the fee share split.
View the full API reference for the deposit endpoint.
If your app has gas sponsorship configured, usage of the /earn/ethereum/deposit endpoint will be gas-sponsored by default. There is no need to specify additional parameters for sponsorship.

Deposit flow

  1. Privy approves the vault to spend the specified amount of the wallet’s ERC-20 tokens.
  2. The vault converts the deposited assets into vault shares at the current share price.
  3. Shares are split between the depositing wallet and your app’s admin wallet based on the fee percentage configured during setup.
  4. The deposit is created as a wallet action with status pending. Privy prepares, signs, and broadcasts the transaction asynchronously. The status moves to succeeded once confirmed onchain.
The share_amount in the response is null while the action is pending. Once the action succeeds, it reflects the number of shares minted to the depositing wallet. To see the admin wallet’s fee shares, query the admin wallet’s position.
The wallet must hold enough of the deposit token to cover the full amount. If the balance is insufficient, the deposit fails. Your app should check the wallet’s token balance before initiating a deposit.

Usage

Use the deposit method from useEarn to deposit assets from a user’s embedded wallet.
useEarn is supported starting in @privy-io/react-auth@3.51.4.
The deposit method rejects its Promise if signing or request submission fails. If signing takes longer than the request expiry window, it throws a PrivyClientError with code embedded_wallet_request_expired. Prompt the user to retry; the expired request is not submitted.
Poll the status with get wallet action, or listen for the wallet_action.earn_deposit.succeeded webhook to know when Privy confirms the deposit onchain.

Parameters

In React and React Native, deposit(walletId, params) accepts the embedded wallet’s ID, not its blockchain address, and an object with the fields below. Privy routes the request to the vault’s configured EVM chain; no chain parameter is needed. The hook signs the request with the user’s signer. Never include app secrets or authorization private keys in client-side code. The same fields apply to the REST request body:
string
required
The unique identifier for the vault. Copy this from vault setup.
string
Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 OUSD). Exactly one of amount or raw_amount must be provided.
string
Amount to deposit in the token’s smallest unit (e.g. "1500000" for 1.5 OUSD on Tempo with 6 decimals). Exactly one of amount or raw_amount must be provided.

Returns

The SDK methods return a Promise for an EarnDepositActionResponse with status: 'pending', not onchain confirmation. In React and React Native, use action.id with getAction from useWalletActions to track completion.
string
The wallet action ID. Use this to poll status with get wallet action.
string
The ID of the wallet that deposited funds.
'earn_deposit'
The action type. Always "earn_deposit" for this endpoint.
'pending' | 'succeeded' | 'rejected' | 'failed'
The current status of the deposit action.
string
CAIP-2 chain identifier for the deposit (e.g. "eip155:4217" for Tempo).
string
The ID of the vault receiving the deposit.
string
The ERC-4626 vault contract address.
string
The address of the underlying asset token.
string
Amount deposited in the token’s smallest unit.
string | undefined
Human-readable decimal amount (e.g. "1.5"). Only present when the token is known in the asset registry.
string | undefined
Asset identifier (e.g. "ousd"). Only present when the token is known in the asset registry.
number | undefined
Number of decimals for the underlying asset. Only present when the token is known in the asset registry.
string | null
Vault shares received in base units. null until the action succeeds.
string
ISO 8601 timestamp of when the action was created.
array | undefined
The execution steps. Only returned if ?include=steps is provided on a GET request.
A rejected status means the action failed before any transaction was signed or broadcast — for example, due to insufficient balance or a policy violation. Your app can safely retry the request. A failed status means a transaction was broadcast but reverted onchain. Inspect the action’s steps for details.

Next steps

Withdraw assets

Withdraw deposited assets with accrued yield.

Automate deposits

Deposit a wallet’s balance into a vault when matching funds arrive.