ZEzerohash
Deposits

List crypto deposits

Changed on

Retrieves a paginated list of blockchain deposits. Filter by deposit IDs, account IDs, transaction hashes, assets, states, and timestamps.

get/deposits/crypto

Request

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

Query parameters

string
OR
string[]

Filter by one or more deposit IDs

string
OR
string[]

Filter by one or more account IDs

string
OR
string[]

Filter by one or more transaction hashes

string
OR
string[]

Filter by one or more receiving blockchain addresses. Matches exactly, with no case or checksum normalization.

string
OR
string[]

Filter by one or more asset codes (e.g. BTC, ETH)

string
OR
string[]

Filter by one or more deposit states

string
OR
string[]

Filter by one or more state reasons (e.g. required_travel_rule_info). Use with states=PENDING_COMPLIANCE_REVIEW to list deposits held for Travel Rule review.

travel_rule_status'pending'

Convenience filter for Travel Rule status. pending returns all deposits currently held awaiting Travel Rule verification (equivalent to states=PENDING_COMPLIANCE_REVIEW&state_reasons=required_travel_rule_info).

from_timestampstring

Filter deposits from this timestamp (inclusive)

to_timestampstring

Filter deposits up to this timestamp (inclusive)

limitstring

Maximum number of results to return (1-999)

cursorstring

Pagination cursor for the next page of results

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

Successful response

Example response

{
  "message": [
    {
      "depositId": "dep_abc123",
      "accountId": "80289ce5-072b-4739-929d-dcc5ccc542f3",
      "participantCode": "ABC123",
      "transactionHash": "0x408482348dcb0e0331a9148d50f8c76db08138f63fb1586fcfc45200a91ccc5f",
      "asset": "BTC",
      "amount": "1.5",
      "sourceAddress": "0x73dFE6E1696FB1cf4648B954aB608a593a382B8G",
      "receivedAddress": "0xB38CeBE03b2b6705744795F36921DE27c70A7C62",
      "state": "confirmed",
      "timestamp": "2024-01-01T00:00:00Z",
      "stateReason": "required_travel_rule_info",
      "travelRuleCollectionDeadline": "2026-06-11T09:26:42Z",
      "notional": {
        "value": "46000.00",
        "rate": "92000.00",
        "quotedAsset": "EUR"
      },
      "history": [
        {
          "fromState": "pending_settlement",
          "toState": "confirmed",
          "timestamp": "2024-01-01T00:00:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 50,
    "nextCursor": "base64cursor..."
  }
}

Changes

  • 47cf70ae701cRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter received_addresses

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status