> ## Documentation Index
> Fetch the complete documentation index at: https://docs.riseworks.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Deposit Events

> Webhook events related to fund deposits and incoming transfers

Deposit events are triggered when funds are received in company accounts from external sources. These events provide real-time notifications about incoming transfers and their confirmation status.

## Overview

Rise supports the following deposit-related webhook events:

<CardGroup cols={1}>
  <Card title="deposit.received" icon="coins" href="#deposit-received">
    Funds deposited to company account from external sources
  </Card>
</CardGroup>

***

## deposit.received

When funds are deposited into a company account from an external source, this event is triggered. This includes deposits from exchanges, other wallets, or payment providers.

### Field reference

<ParamField path="object" type="string" required>
  The type of object this webhook represents (always "event")
</ParamField>

<ParamField path="created" type="number" required>
  The Unix timestamp when the event was created
</ParamField>

<ParamField path="event_type" type="string" required>
  The type of event that occurred
</ParamField>

<ParamField path="event_version" type="string" required>
  The version of the event schema
</ParamField>

<ParamField path="request_id" type="string">
  A unique identifier for the API request that triggered this event (optional)
</ParamField>

<ParamField path="idempotency_key" type="string" required>
  A unique key to ensure the webhook is processed only once
</ParamField>

<ParamField path="deposit" type="object" required>
  Deposit information and details
</ParamField>

<Expandable title="deposit" defaultOpen>
  <ParamField path="nanoid" type="string" required>
    Primary key of the deposit (nanoid)
  </ParamField>

  <ParamField path="entity_nanoid" type="string" required>
    Company or team nanoid that received the deposit
  </ParamField>

  <ParamField path="entity_deposit_account_id" type="number" required>
    ID of the entity deposit account used
  </ParamField>

  <ParamField path="provider_deposit_id" type="string" required>
    Unique identifier from the deposit provider
  </ParamField>

  <ParamField path="provider_entity_id" type="string">
    Provider-specific entity identifier
  </ParamField>

  <ParamField path="provider_wallet_id" type="string">
    Provider-specific wallet identifier
  </ParamField>

  <ParamField path="provider_name" type="string" required>
    Name of the deposit provider (manual, routefusion, bitcoin, rise\_pay\_handler)
  </ParamField>

  <ParamField path="source_currency" type="string" required>
    Currency code of the source amount
  </ParamField>

  <ParamField path="source_amount_cents" type="number" required>
    Source amount in cents
  </ParamField>

  <ParamField path="destination_currency" type="string" required>
    Currency code of the destination amount
  </ParamField>

  <ParamField path="destination_amount_cents" type="number" required>
    Destination amount in cents (what was actually deposited)
  </ParamField>

  <ParamField path="transaction_date" type="string" required>
    ISO-8601 timestamp of when the transaction occurred
  </ParamField>

  <ParamField path="purpose_of_payment" type="string">
    Purpose or reason for the payment
  </ParamField>

  <ParamField path="reference" type="string">
    Reference number or identifier
  </ParamField>

  <ParamField path="trace" type="string">
    Trace number for the transaction
  </ParamField>

  <ParamField path="funding_blockchain_txn" type="string">
    Blockchain transaction hash if applicable
  </ParamField>

  <ParamField path="blockchain_reference" type="string" required>
    Blockchain reference for the deposit
  </ParamField>

  <ParamField path="deposit_bank_account_seen" type="number">
    Bank account identifier seen in the deposit
  </ParamField>

  <ParamField path="status" type="string" required>
    Current status of the deposit (pending, complete, failed, rejected, reverted)
  </ParamField>

  <ParamField path="created_at" type="string" required>
    ISO-8601 timestamp when the deposit was created
  </ParamField>

  <ParamField path="updated_at" type="string" required>
    ISO-8601 timestamp when the deposit was last updated
  </ParamField>

  <ParamField path="token" type="object" required>
    Token information for this deposit
  </ParamField>

  <Expandable title="token">
    <ParamField path="address" type="string" required>
      Blockchain address of the token
    </ParamField>

    <ParamField path="name" type="string" required>
      Human-readable name of the token
    </ParamField>

    <ParamField path="symbol" type="string" required>
      Token symbol (e.g., USDC, ETH)
    </ParamField>

    <ParamField path="decimals" type="number" required>
      Number of decimal places for the token
    </ParamField>
  </Expandable>

  <ParamField path="network" type="string" required>
    Blockchain network where the deposit occurred
  </ParamField>
</Expandable>

<RequestExample>
  ```json deposit.received (v1) theme={null}
  {
    "object": "event",
    "created": 1751590453,
    "request_id": "req-1751590452487",
    "event_type": "deposit.received",
    "event_version": "1.0",
    "idempotency_key": "85420805-0b5e-4b11-b7f4-c6f05db7120b",
    "deposit": {
      "nanoid": "dp-abc123def456789",
      "entity_nanoid": "co-abc123def456789",
      "entity_deposit_account_id": 12345,
      "provider_deposit_id": "rf_deposit_abc123def456",
      "provider_entity_id": "rf_entity_xyz789",
      "provider_wallet_id": "rf_wallet_abc123",
      "provider_name": "routefusion",
      "source_currency": "USD",
      "source_amount_cents": 500000,
      "destination_currency": "USDC",
      "destination_amount_cents": 499500,
      "transaction_date": "2024-01-15T10:30:00.000Z",
      "purpose_of_payment": "Funding company operations",
      "reference": "REF123456789",
      "trace": "TR987654321",
      "funding_blockchain_txn": "0x1234567890abcdef1234567890abcdef12345678",
      "blockchain_reference": "rise_deposit_abc123def456",
      "deposit_bank_account_seen": 98765,
      "status": "complete",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:35:00.000Z",
      "token": {
        "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
        "name": "USD Coin",
        "symbol": "USDC",
        "decimals": 6
      },
      "network": "polygon"
    }
  }
  ```
</RequestExample>

***

## Implementation Notes

<Info>
  **Provider integration**: Deposits can come from multiple providers including Routefusion, manual entries, Bitcoin network, or Rise Pay Handler. Check the `provider_name` field to handle provider-specific logic.
</Info>

<Warning>
  **Status handling**: Always check the `status` field before processing deposits. Only `complete` deposits should be considered final and processed.
</Warning>

<Tip>
  **Currency conversion**: The deposit includes both source and destination amounts in cents. Use `source_amount_cents` for the original amount and `destination_amount_cents` for what was actually deposited after fees/conversion.
</Tip>

### Status Values

<AccordionGroup>
  <Accordion title="pending" icon="clock">
    Deposit has been initiated but not yet processed or confirmed
  </Accordion>

  <Accordion title="complete" icon="circle-check">
    Deposit has been successfully processed and funds are available
  </Accordion>

  <Accordion title="failed" icon="triangle-exclamation">
    Deposit processing failed due to technical or validation errors
  </Accordion>

  <Accordion title="rejected" icon="circle-xmark">
    Deposit was rejected due to compliance or business rule violations
  </Accordion>

  <Accordion title="reverted" icon="rotate-left">
    Deposit was processed but later reversed or cancelled
  </Accordion>
</AccordionGroup>

### Provider Types

Rise supports deposits from the following providers:

* **manual** - Manually entered deposits for tracking purposes
* **routefusion** - Bank wire transfers and ACH deposits via Routefusion
* **bitcoin** - Bitcoin network deposits
* **rise\_pay\_handler** - Internal Rise payment processing system

### Network Support

Rise supports deposits on the following blockchain networks:

* **ethereum** - Ethereum mainnet
* **arbitrum** - Arbitrum Layer 2 network
* **base** - Base Layer 2 network
* **polygon** - Polygon (Matic) network
* **avalanche** - Avalanche C-Chain
* **optimism** - Optimism Layer 2 network