---
title: "List deposits"
method: GET
path: "/deposits"
tags: ["Deposits"]
---

# List deposits

`GET /deposits`

Retrieves a paginated list of deposits made by you and your customers. Results are limited to the last 2 months.

## Query parameters

- `page` number
- `asset` 'AAVE.ETH' | 'ADA' | 'ALGO' | 'AVAX' | 'BAT.ETH' | 'BCH' | 'BTC' | 'BUSD.ETH' | 'COMP.ETH' | 'DAI.ETH' | 'DOGE' | 'DOT' | 'EGLD' | 'EOS' | 'ETC' | 'ETH' | 'ETH.ARBITRUM' | 'GRT.ETH' | 'GYEN.ETH' | 'HBAR' | 'LINK.ETH' | 'LTC' | 'LUNA' | 'MATIC.ETH' | 'MATIC.POLYGON' | 'MKR.ETH' | 'MOB' | 'SAND.ETH' | 'SOL' | 'UNI.ETH' | 'USDC.ETH' | 'USDC.ALGO' | 'USDC.POLYGON' | 'USDC.SOL' | 'USDC.HBAR' | 'USDC.XLM' | 'USDC.AVAX' | 'USDT.ETH' | 'UST' | 'WBTC.ETH' | 'XEM' | 'XLM' | 'XRP' | 'XTZ' | 'ZUSD.ETH' — The list of assets available in the certification environment
- `include_customer_deposits` 'true' | 'false'
- `participant_code` string
- `account_label` string
- `settle_timestamp[gt]` string
- `settle_timestamp[gte]` string
- `settle_timestamp[lt]` string
- `settle_timestamp[lte]` string
- `settle_timestamp[e]` string
- `parent_link_id_source` string

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Response `200`

Paginated list of deposits, optionally filtered by `asset`, `participant_code`, `account_label`, `settle_timestamp`, or `parent_link_id_source`.

- GetDepositsResponse
  - `message` DepositResponseEntity[]
    - `settle_timestamp` number — Unix timestamp in milliseconds indicating when the deposit was credited to the participant. This also matches the `movement_timestamp` on the corresponding movement.
    - `account_id` string, uuid — Unique identifier (UUID v4) for the account the deposit was credited to.
    - `movement_id` string, uuid — Unique identifier (UUID v4) for the movement created by this deposit.
    - `participant_code` string — The participant that was credited with the deposit.
    - `account_group` string — The account group associated with the account that received the deposit (e.g. `00SCXM` for the zerohash house account group).
    - `account_label` string — The account label under the participant that received the deposit.
    - `asset` string — The asset code of the deposit (e.g. `BTC`, `USD`).
    - `amount` string — The amount that was deposited into the account.
    - `reference_id` string — An external identifier associated with the deposit. Context-specific depending on the asset and source — for fiat this is typically the wire/ACH reference, for crypto it is the on-chain transaction ID.
    - `source` string, nullable — The bank from which the fiat deposit was made or the blockchain address from which the crypto deposit came. Returns `null` when the upstream service does not report a source (e.g. some fiat deposits).
    - `received_address` string, nullable — The deposit address that received the funds. Returns `null` for fiat deposits and for crypto deposits where no receive address is recorded.
    - `run_id` string — Identifier for the settlement run that booked the deposit.
    - `state_reason` string, nullable — Machine-readable reason the deposit is in its current state (BG-4554). Populated for blockchain deposits held for Travel Rule verification: `required_travel_rule_info` — awaiting TR resolution; `travel_rule_info_received` — resolved successfully; `travel_rule_info_timeout` — 48h timer expired. Absent for fiat deposits and blockchain deposits not subject to Travel Rule.
    - `travel_rule_status` 'pending' | 'completed' | 'not_required' — Human-readable Travel Rule status (BG-4558). Always present for blockchain deposits. `pending` — deposit is held awaiting TR verification; `completed` — TR resolved (info received or 48h timer elapsed); `not_required` — deposit never entered a TR-hold state. Absent for fiat deposits.
  - `page` number
  - `page_size` number
  - `total_pages` number
  - `count` number

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/versions/8b647d934363/schema)