Create a deposit account

A crypto deposit account gives a wallet persistent deposit addresses.

When receiving deposits on the same chain type as the wallet, the deposit address is the wallet itself. When receiving deposits on a different chain type as the wallet, the deposit address is a newly provisioned wallet assigned to the same owner.

The request body is a flat object discriminated by type:

type · 'inline_route' | 'deposit_config' · required

Which create payload to send. inline_route takes source and destination. deposit_config reuses an existing deposit configuration via deposit_config_id.

source · object

Required when type is inline_route. Assets the deposit address accepts. Chains must be EVM or Solana.

Hide properties

source.mode · 'all' | 'include' | 'exclude' · required

include accepts only the listed assets. exclude accepts all except the listed assets. all accepts every supported source.

source.values · object[]

Asset specs for include and exclude. Omit when mode is all.

Hide properties

source.values.asset · string

source.values.chain · string

Omit to match every supported chain for that asset.

destination · object

Required when type is inline_route. Asset delivered to the destination wallet. Identifies exactly one asset on exactly one chain.

Hide properties

destination.asset · string · required

destination.chain · string · required

Must match the destination wallet’s chain_type.

deposit_config_id · string

Required when type is deposit_config. ID of an existing deposit configuration to attach.

import {PrivyClient} from '@privy-io/node';

const userJwt = 'insert-user-jwt';
const walletId = 'insert-wallet-id';

const privy = new PrivyClient({
  appId: 'insert-your-app-id',
  appSecret: 'insert-your-app-secret'
});

const {deposit_accounts} = await privy.wallets().depositAccounts.crypto.create(walletId, {
  type: 'inline_route',
  source: {
    mode: 'include',
    values: [{asset: 'usdc', chain: 'base'}]
  },
  destination: {asset: 'pathusd', chain: 'tempo'},
  authorization_context: {user_jwts: [userJwt]}
});

Response

A successful response includes the following fields:

deposit_accounts · object[]

One entry per source route created for the destination wallet.

Hide properties

deposit_address · string

Address to sends funds to. If the source assets are on the same chain type as the wallet, this should be same as the wallet address.

wallet_id · string

ID of the source wallet behind this deposit address.

source · object

Assets this address accepts, using aliases when known.

Hide properties

source.mode · 'all' | 'include' | 'exclude'

Filter applied to this deposit address.

source.values · object[]

Accepted assets.

Hide properties

source.values.asset · string

source.values.chain · string

destination · object

Asset and chain delivered to the destination wallet, using aliases when known.

Hide properties

destination.asset · string

destination.chain · string

{
  "deposit_accounts": [
    {
      "wallet_id": "insert-source-wallet-id",
      "deposit_address": "0x1234...abcd",
      "source": {
        "mode": "include",
        "values": [{"asset": "usdc", "chain": "base"}]
      },
      "destination": {"asset": "pathusd", "chain": "tempo"}
    }
  ]
}

Next steps

Deposits overview

All available methods for funding wallets.

Fiat deposits

Dedicated bank accounts that convert incoming fiat to crypto.