ZEzerohash
Deposits

List deposits

Changed on

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

get/deposits

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/deposits
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Query parameters

pagenumber
Example:1

Page number for pagination (starts at 1).

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

Example:USD

Filter by asset code (e.g., BTC, USD, ETH)

include_customer_deposits'true' | 'false'
Example:true

Include deposits made by customers of your platform. Defaults to true. Ignored when participant_code is provided — a participant-scoped request always excludes customer deposits.

participant_codestring
Example:ABCDEF

Filter by a specific participant code. Always 6 uppercase alphanumeric characters.

account_labelstring
Example:general

Filter by account label (e.g., general, sub_account_test). Account labels are used to categorize accounts under a participant. Each participant account_label maintains a separate balance and transaction history.

settle_timestamp[gt]string
Example:1678901234567

Filter for deposits whose settlement timestamp (Unix milliseconds) is strictly greater than the value.

settle_timestamp[gte]string
Example:1678901234567

Filter for deposits whose settlement timestamp (Unix milliseconds) is greater than or equal to the value.

settle_timestamp[lt]string
Example:1678901234567

Filter for deposits whose settlement timestamp (Unix milliseconds) is strictly less than the value.

settle_timestamp[lte]string
Example:1678901234567

Filter for deposits whose settlement timestamp (Unix milliseconds) is less than or equal to the value.

settle_timestamp[e]string
Example:1678901234567

Filter for deposits whose settlement timestamp (Unix milliseconds) equals the value exactly.

parent_link_id_sourcestring
Example:rest_api

Filter deposits by the source system that originated the parent link (e.g. rest_api, sdk).

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

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

pagenumber
page_sizenumber
total_pagesnumber
countnumber

Example response

{
  "message": [
    {
      "settle_timestamp": 1590663417000,
      "account_id": "80289ce5-072b-4739-929d-dcc5ccc542f3",
      "movement_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0",
      "participant_code": "ABCDEF",
      "account_group": "00SCXM",
      "account_label": "general",
      "asset": "BTC",
      "amount": "4.0000",
      "reference_id": "408482348dcb0e0331a9148d50f8c76db08138f63fb1586fcfc45200a91ccc5f",
      "source": "0x73dFE6E1696FB1cf4648B954aB608a593a382B8G",
      "received_address": "0xB38CeBE03b2b6705744795F36921DE27c70A7C62",
      "run_id": "12613",
      "state_reason": "required_travel_rule_info"
    }
  ],
  "page": 1,
  "page_size": 15,
  "total_pages": 1,
  "count": 1
}

Changes

  • 47cf70ae701cRevision changes
    • warning

      added the new action_required enum value to the // response property for the response status

    • warning

      added the new allowed enum value to the // response property for the response status

    • warning

      added the new blocked enum value to the // response property for the response status

    • warning

      added the new processing enum value to the // response property for the response status

    • warning

      added the new unknown enum value to the // response property for the response status

    • info

      removed the completed enum value from the // response property for the response status

    • info

      removed the not_required enum value from the // response property for the response status

    • info

      removed the pending enum value from the // response property for the response status