---
title: "Request vault deposit"
method: POST
path: "/v1/tools/betteroff_request_vault_deposit"
tags: ["tools"]
---

# Request vault deposit

`POST /v1/tools/betteroff_request_vault_deposit`

## Request

- Base URL: `https://api.betteroff.finance`
- URL: `https://api.betteroff.finance/v1/tools/betteroff_request_vault_deposit`
- Auth: one of:
  - OpenID Connect (`https://app.betteroff.finance/api/auth/.well-known/openid-configuration`, scopes: `investments:read`, `transfers:vault`)
  - HTTP bearer

Use this when the user asks to deposit USDC or USDT from one of their own wallets into a vault they chose from Investing. Request a dollar-stablecoin deposit from one of the household's tracked EVM wallets into an Upshift or Morpho vault listed by betteroff_get_vault_yields. Saves a request for the user to review; never approves, signs, or deposits. Only prepare a deposit the user asked for, into a vault the user named; never pick a vault for them. Return the review link and say it awaits the user's approval and wallet signature.

## Request body

- object
  - `vault` string, required: Vault address from betteroff_get_vault_yields.
  - `chainId` integer: The vault's chainId from betteroff_get_vault_yields; needed when an address is listed on two chains.
  - `fromWallet` string, required: Household wallet that holds the vault's deposit asset.
  - `amountUsd` string, required: Dollar amount as a decimal string, at most 6 decimals.
  - `idempotencyKey` string: Required for outside agents. Reuse the same key when retrying the same request; use a new key for a new one.

## Response `200`

Tool result

- union
  - object
    - `ok` false, required
    - `requestId` string
    - `error` string, required
    - `code` string, required
    - `retryable` boolean, required
    - `nextStep` string, required
    - `field` string
    - `missingInputs` object[]
      - `id` string, required
      - `name` string, required
      - `balanceMissing` boolean, required
      - `interestRateMissing` boolean, required
      - `minimumPaymentMissing` boolean, required
  - object
    - `ok` true, required
    - `requestId` string
    - `schemaVersion` '4', required
    - `data` object, required
      - `id` string, uuid, required
      - `kind` 'transfer' | 'bank_transfer' | 'vault_deposit', required
      - `surface` 'app' | 'mcp' | 'imessage', required
      - `terms` object, required
      - `termsDigest` string, required
      - `status` string, required
      - `createdAt` string, date-time, required
      - `expiresAt` string, date-time, required
      - `reviewUrl` string, uri, required
      - `note` string, required
    - `currency` string, nullable, required
    - `timezone` string, required
    - `asOf` string, nullable, required
    - `revision` integer, required
    - `householdRevision` integer, required
    - `quality` object, required
      - `state` 'complete' | 'partial' | 'unavailable', required
      - `reasons` string[], required
    - `evidence` object[], required
      - `source` string, required
      - `id` string
      - `observedAt` string, nullable, required
    - `page` object, required
      - `returnedCount` integer, required
      - `totalCount` integer, nullable, required
      - `truncated` boolean, required
      - `nextCursor` Schema1, required (unresolved $ref)
    - `warnings` string[], required
    - `notes` string

## Other responses

- `400`: INVALID_INPUT (a missing, unknown, or invalid argument, named in `fields`), TOOL_CALL_REJECTED, or a body that is not JSON.
- `401`: AGENT_TOKEN_INVALID: the token is missing, expired, or revoked.
- `402`: AGENT_SUBSCRIPTION_INACTIVE or FEATURE_NOT_INCLUDED: needs BetterOff Core.
- `403`: INSUFFICIENT_SCOPE, ACCESS_DENIED, or AGENT_GRANT_REVOKED.
- `404`: TOOL_NOT_FOUND, or NOT_FOUND for a record the org does not have.
- `409`: CONFLICT: the record's state rules this call out. Read it again.
- `422`: INCOMPLETE_DATA or RESULT_TOO_LARGE. Narrow the request; don't retry as is.
- `429`: RATE_LIMITED. Retry after Retry-After seconds.
- `503`: DATA_UNAVAILABLE, DEPENDENCY_UNAVAILABLE (including the 25-second tool deadline), or AGENT_AUTHZ_UNAVAILABLE. Retryable.
- `default`: Problem details

---

[API](https://skmtc.dev/betteroff/apis/betteroff-api.md) · [All operations](https://skmtc.dev/betteroff/apis/betteroff-api/llms.txt) · [OpenAPI document](https://skmtc.dev/betteroff/apis/betteroff-api/revisions/bc858c8d428d?raw)