Skip to main content
POST

Deposit address strategy

'dedicated' | 'prefer_destination' | 'require_destination'
Optional top-level field for both inline_route and deposit_config requests. Defaults to dedicated, including when a route already exists.
  • dedicated: Reuse or create eligible dedicated source wallets, never the destination wallet.
  • prefer_destination: Use the eligible destination for its matching source chain family; use dedicated wallets otherwise.
  • require_destination: Require the destination to serve its own chain family when that family is requested, and fail without fallback if it cannot. Other requested families still use dedicated source wallets.
For example, attach an existing deposit configuration while preferring the destination address:
Sign the request body as sent, including deposit_address_strategy when provided. Do not add a default value after signing. For source eligibility, conflicting automations, repeated calls, and address changes, see Deposit address behavior.

Authorizations

Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id
string
required

ID of your Privy app.

privy-authorization-signature
string

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

privy-request-expiry
string

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

privy-idempotency-key
string

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

Path Parameters

wallet_id
string
required

ID of the wallet.

Body

application/json

Creates a crypto deposit account from an existing deposit configuration.

type
enum<string>
required
Available options:
deposit_config
deposit_config_id
string
required
Minimum string length: 1
deposit_address_strategy
enum<string>

How deposit source wallets are chosen. Omission uses dedicated. Destination reuse applies only to the destination's own chain type.

Available options:
dedicated,
prefer_destination,
require_destination
Example:

"dedicated"

Response

200 - application/json

The created crypto deposit account.

Response returned after creating a crypto deposit account.

deposit_accounts
CryptoDepositAddressRoute · object[]
required