Use To use the destination wallet’s own address as the deposit address, set To reuse an existing deposit configuration, pass its ID:ParametersReturns
createCryptoDepositAccount from the useHeadlessCryptoDeposit hook. The hook signs the request with the authenticated user’s signer.depositAddressStrategy:createCryptoDepositAccount accepts an object with the following fields:inline_route defines the route in the request with source and destination. deposit_config
reuses an existing deposit configuration with depositConfigId.Required when
type is inline_route. Assets the deposit addresses accept. Chains must be EVM or
Solana.Required when
type is inline_route. The one asset, on one chain, delivered to the destination
wallet.Where deposit addresses live. Defaults to
dedicated, which always uses separate source wallets.
See where deposit addresses
live.createCryptoDepositAccount returns a Promise for an object with a deposit_accounts array. See response.Complete exampleResponse
Every SDK returns the API response unchanged, with snake_case fields:deposit_address to users as the place to send the listed assets.
Deposit address behavior
Destination requirements. The destination must be a Privy wallet owned by a single user, with no authorization keys or nested key quorums. When a client SDK creates the account, the authenticated user must be that owner. Source wallet reuse. Repeated calls for the same route reuse the same source wallet while it remains eligible. A source wallet stays eligible while it serves only this route and has not been exported. Otherwise, Privy creates a new source wallet. Exported wallets. An exported wallet cannot be a source wallet. Exporting a source wallet for asset recovery stops conversions to it. An exported destination wallet can still receive converted funds from separate source wallets. Destination reuse. Withprefer_destination or require_destination, Privy uses the destination wallet’s address as the deposit address. Creating a deposit account for a different route updates that address to use the new route and detaches the previous route. Repeating the same route keeps it active. The default dedicated strategy uses separate source wallets, so dedicated accounts with the same destination can coexist.
Error handling
Create rejects on invalid configuration or failed requests. Common error cases include:- App-pays gas sponsorship is not enabled on a requested source chain. See setup.
- The route is unsupported, or the destination chain is not in the destination wallet’s chain family.
- The destination wallet is not owned by a single user, or the request is not authorized by that user.
require_destinationis set and the destination wallet was exported.- The signed request expires before Privy receives it.
401. Create the deposit account from a server with NodeJS or the REST API instead.
Your app should wrap calls in try/catch and show clear UI feedback.
Next steps
Quote a route
Preview the delivered amount before a deposit
Track orders
Optionally check conversion status after a deposit
Consumer onramp modal
Show a prebuilt deposit UI in React or React Native
Set up crypto deposits
Enable app-pays gas sponsorship on source chains

