Deposit Events

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:

deposit.received

Funds deposited to company account from external sources

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

string

required

The type of object this webhook represents (always “event”)

number

required

The Unix timestamp when the event was created

string

required

The type of event that occurred

string

required

The version of the event schema

string

A unique identifier for the API request that triggered this event (optional)

string

required

A unique key to ensure the webhook is processed only once

object

required

Deposit information and details

Hide deposit

string

required

Primary key of the deposit (nanoid)

string

required

Company or team nanoid that received the deposit

number

required

ID of the entity deposit account used

string

required

Unique identifier from the deposit provider

string

Provider-specific entity identifier

string

Provider-specific wallet identifier

string

required

Name of the deposit provider (manual, routefusion, bitcoin, rise_pay_handler)

string

required

Currency code of the source amount

number

required

Source amount in cents

string

required

Currency code of the destination amount

number

required

Destination amount in cents (what was actually deposited)

string

required

ISO-8601 timestamp of when the transaction occurred

string

Purpose or reason for the payment

string

Reference number or identifier

string

Trace number for the transaction

string

Blockchain transaction hash if applicable

string

required

Blockchain reference for the deposit

number

Bank account identifier seen in the deposit

string

required

Current status of the deposit (pending, complete, failed, rejected, reverted)

string

required

ISO-8601 timestamp when the deposit was created

string

required

ISO-8601 timestamp when the deposit was last updated

object

required

Token information for this deposit

Show token

string

required

Blockchain address of the token

string

required

Human-readable name of the token

string

required

Token symbol (e.g., USDC, ETH)

number

required

Number of decimal places for the token

string

required

Blockchain network where the deposit occurred

{
  "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"
  }
}

Implementation Notes

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.

Status handling: Always check the status field before processing deposits. Only complete deposits should be considered final and processed.

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.

Status Values

pending

Deposit has been initiated but not yet processed or confirmed

complete

Deposit has been successfully processed and funds are available

failed

Deposit processing failed due to technical or validation errors

rejected

Deposit was rejected due to compliance or business rule violations

reverted

Deposit was processed but later reversed or cancelled

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

Getting Started

Implementation

Operations

Reference

Webhook Payloads

Overview

deposit.received

deposit.received

Field reference

Implementation Notes

Status Values

Provider Types

Network Support

​Overview

deposit.received

​deposit.received

​Field reference

​Implementation Notes

​Status Values

​Provider Types

​Network Support

Overview

deposit.received

Field reference

Implementation Notes

Status Values

Provider Types

Network Support