v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-013469188.5 KB
Utilities

List deposits for the authenticated client

Returns the authenticated client's deposits, newest first. Supports filtering by account, recipient, address, status, source chain, and transaction hash. The account filter accepts an EVM address or a Solana public key (deposit address or swig address); address matches the source-chain deposit address or target-chain recipient.

get/deposits

Query parameters

accountstring

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

Example:0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91

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

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

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).

addressstring

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

Example:0x2ca6f15be9580c4f332656bedc11c35bf820d08d

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

status'pending' | 'processing' | 'completed' | 'failed' | 'rejected' | 'ignored' | 'expecting_refund' | 'refunded' | 'delayed' | 'awaiting_sweep' | 'reconciliation_required'

Filter by deposit status

Example:failed

Filter by deposit status

chainstring

CAIP-2 chain identifier (e.g. "eip155:8453")

Example:eip155:8453

CAIP-2 chain identifier (e.g. "eip155:8453")

txHashstring

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

Example:0xabc123...

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

limitinteger

Maximum number of deposits to return

Example:20

Maximum number of deposits to return

cursorstring

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

Example:123

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

includeSpamboolean

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

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

Headers

x-api-keystring

API key for authentication (omit when sending Authorization)

Example:your-api-key

API key for authentication (omit when sending Authorization)

authorizationstring

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

Example:Bearer eyJhbGciOi...

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

Response

Client deposits

nextCursorstring nullable required

Example response

{
  "deposits": [
    {
      "id": "12345",
      "amount": "1000000000000000000",
      "sourceAmount": "1000000000000000000",
      "destinationAmount": "1000000000000000000"
    }
  ]
}