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

# Deposit

[Stablecoin Account API Publisher Disclaimer](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)

**Event metadata**

* **name**: `DEPOSIT`
* **types**:
  * `ramp.deposit.pending` – deposit pending confirmation
  * `ramp.deposit.success` – deposit successful
  * `ramp.deposit.failed` – deposit failed

**Request body**

| Field       | Type   | Description            |
| ----------- | ------ | ---------------------- |
| event\_id   | string | Unique event ID        |
| event\_name | string | Event name             |
| event\_type | string | Event type             |
| source\_id  | string | Order ID               |
| version     | string | API version            |
| data        | object | Deposit details object |

The `data` object may additionally include `need_travel_rule`:

| Field              | Type    | Description                                                                                                                                                                                                                                                                                                                                                |
| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| need\_travel\_rule | boolean | Present and `true` only when this deposit needs originator Travel Rule data before it can proceed. When you receive `true`, submit the sender's Travel Rule via [Submit Deposit Sender Travel Rule](/stablecoin-account/v1.6/api-reference/create-deposit-sender) using this deposit's `from_address` as `source_address`. Otherwise the field is omitted. |

**Notification example**

```json theme={null}
{
  "version": "V1.6.0",
  "event_name": "DEPOSIT",
  "event_type": "ramp.deposit.pending",
  "event_id": "38614827-7666-4c0c-abae-cc3abef24903",
  "source_id": "eda7be90-8fbc-444c-b747-542faf5d3e10",
  "data": {
    "amount": "10",
    "complete_time": "0001-01-01 00:00:00 +0000 UTC",
    "create_time": "2026-02-27 10:19:19 +0800 CST",
    "currency": "USDC",
    "fee": "0",
    "from_address": "0x303039d7632c7341c681e889ea0073c3af1a2f6a",
    "network": "ETH",
    "order_id": "eda7be90-8fbc-444c-b747-542faf5d3e10",
    "order_status": "Pending",
    "reason": "test-remark",
    "short_order_id": "DP260227-QZOXQND1",
    "transaction_type": "Deposit",
    "txid": "0x65590ef2a2ef1902f3644da38b19eaf4b953831c0deaac73cadce02ee356d5d1",
    "need_travel_rule": true
  }
}
```
