RHrhinestonewtf
Utilities

List deposits

Changed on

Returns deposits for the authenticated project, newest first. Filters narrow the list on the server before pagination: different parameters combine with AND, values within one parameter with OR, and an exclusion (excludeStatus, excludeChain, excludeAsset, excludeSender) wins over a matching inclusion.

get/deposits

Request

Query parameters

accountstring

EVM address (0x...) or Solana base58 public key

Example:0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91
recipientstring

Filter by the account's recipient address. Aggregates deposits across every smart account that resolves to the same recipient (typically the integrator's user wallet).

Example:0x2ca6f15be9580c4f332656bedc11c35bf820d08d
addressstring

Filter by the source-chain deposit address or target-chain recipient.

Example:0x2ca6f15be9580c4f332656bedc11c35bf820d08d
statusstring[]

Include only deposits in these statuses. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "failed",
  "rejected"
]
excludeStatusstring[]

Exclude deposits in these statuses. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "failed",
  "rejected"
]
chainstring[]

Include only deposits from these source chains. Canonical CAIP-2 source chain ids (e.g. "eip155:8453"). The two HyperCore origin spellings (hypercore:mainnet, hypercore:spot) match as one chain. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "eip155:8453",
  "eip155:9745"
]
excludeChainstring[]

Exclude deposits from these source chains. Canonical CAIP-2 source chain ids (e.g. "eip155:8453"). The two HyperCore origin spellings (hypercore:mainnet, hypercore:spot) match as one chain. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "eip155:8453",
  "eip155:9745"
]
assetstring[]

Include only deposits of these source assets. Source assets as <CAIP-2 chain>:<token>, using the chain and token a list row reports (the token address, or the chain's native-asset identifier: the zero address on EVM and for TRX, 11111111111111111111111111111111 on Solana). Symbols are never matched. Hex tokens (EVM, HyperCore, the TRX sentinel) match case-insensitively; base58 tokens (Solana, Tron) match exactly. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "eip155:8453:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
]
excludeAssetstring[]

Exclude deposits of these source assets. Source assets as <CAIP-2 chain>:<token>, using the chain and token a list row reports (the token address, or the chain's native-asset identifier: the zero address on EVM and for TRX, 11111111111111111111111111111111 on Solana). Symbols are never matched. Hex tokens (EVM, HyperCore, the TRX sentinel) match case-insensitively; base58 tokens (Solana, Tron) match exactly. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "eip155:8453:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
]
senderstring[]

Include only deposits from these senders. Recorded transfer senders, matched on any chain. Never the deposit address, account or recipient. EVM addresses match case-insensitively; base58 addresses match exactly. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "0x742d35cc6634c0532925a3b844bc9e7595f5be91"
]
excludeSenderstring[]

Exclude deposits from these senders. Recorded transfer senders, matched on any chain. Never the deposit address, account or recipient. EVM addresses match case-insensitively; base58 addresses match exactly. A deposit with an unknown or different sender stays visible. Repeat the parameter or comma-separate values, at most 20. Values within one parameter combine with OR, parameters combine with AND, and an exclusion wins over a matching inclusion. Applied before pagination; spam visibility is still governed by includeSpam.

[
  "0x742d35cc6634c0532925a3b844bc9e7595f5be91"
]
txHashstring

Filter by source transaction hash (EVM 0x... or Solana base58 signature)

Example:0xabc123...
limitinteger

Maximum number of deposits to return

Example:20
cursorstring

Pagination cursor. Use the nextCursor returned by the previous page.

Example:123
includeSpamboolean

When true, include spam-flagged deposits (tokens with no known price). Defaults to false.

Headers

x-api-keystring

API key for authentication

Example:your-api-key

Response

Client deposits

nextCursorstring nullable required

Example response

{
  "deposits": [
    {
      "id": "12345",
      "tokenSymbol": "USDC",
      "tokenDecimals": 6,
      "targetTokenSymbol": "USDC",
      "targetTokenDecimals": 6,
      "amount": "1000000000000000000",
      "sourceAmount": "1000000000000000000",
      "destinationAmount": "1000000000000000000",
      "sponsoredGasUsd": "0.42",
      "sponsoredBridgeFeeUsd": "0.13",
      "timing": {
        "expectedSeconds": 42,
        "softDelaySeconds": 90,
        "escalatedDelaySeconds": 300
      }
    }
  ]
}

Changes

  • aa1767d704faRevision changes
    • breaking

      removed the enum value completed from the query request parameter status

    • breaking

      removed the enum value delayed from the query request parameter status

    • breaking

      removed the enum value expecting_refund from the query request parameter status

    • breaking

      removed the enum value failed from the query request parameter status

    • breaking

      removed the enum value ignored from the query request parameter status

    • breaking

      removed the enum value pending from the query request parameter status

    • breaking

      removed the enum value processing from the query request parameter status

    • breaking

      removed the enum value reconciliation_required from the query request parameter status

    • breaking

      removed the enum value refunded from the query request parameter status

    • breaking

      removed the enum value rejected from the query request parameter status

    • breaking

      for the query request parameter chain, the minItems was increased from 0 to 1

    • breaking

      for the query request parameter status, the minItems was increased from 0 to 1

    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      added the new optional query request parameter asset

    • info

      added the new optional query request parameter excludeAsset

    • info

      added the new optional query request parameter excludeChain

    • info

      added the new optional query request parameter excludeSender

    • info

      added the new optional query request parameter excludeStatus

    • info

      added the new optional query request parameter sender

    • info

      the header request parameter x-api-key became optional

    • info

      removed the pattern ^[a-z0-9]+:[a-zA-Z0-9]+$ from the query request parameter chain

    • info

      for the query request parameter chain, the type was generalized from string to array

    • info

      for the query request parameter status, the type was generalized from string to array

    • info

      added the non-success 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 required property // to the response with the status

  • 676300ac19ffRevision changes
    • 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