Deposit started

Fired when a fiat deposit into a deposit account begins processing. The crypto has not yet been delivered.

postWebhookwallet.deposit_account.deposit_started

Payload

type'wallet.deposit_account.deposit_started' required

The type of webhook event.

provider_deposit_idstring required

The deposit's ID in the provider's system (e.g. Bridge), not a Privy ID.

deposit_account_idstring required
wallet_idstring required
deposit_type'fiat' required
provider'bridge' required

Supported fiat orchestration providers.

environment'sandbox' | 'production' required

The Privy API environment.

Example payload

{
  "environment": "sandbox"
}

Response

Return a 200 status to indicate that the webhook was received successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.