Deposit Destinations

List deposit destinations

List deposit destinations. You can optionally filter the results by type, account ID, network, cryptocurrency address, or status. Results are sorted by creation date in descending order (newest first).

get/v2/deposit-destinations

Request

  • Base URL: https://api.cdp.coinbase.com/platform
  • URL: https://api.cdp.coinbase.com/platform/v2/deposit-destinations
  • Auth: HTTP bearer

Query parameters

accountIdstring

The ID of the Account, which is a UUID prefixed by the string account_.

Example:account_af2937b0-9846-4fe7-bfe9-ccc22d935114

Filter deposit destinations by account ID.

addressstring

The cryptocurrency address to filter by. Format depends on the network (e.g., 0x-prefixed for EVM networks, base58 for Solana).

Filter deposit destinations by the cryptocurrency address.

'crypto'
OR
'fiat'

Filter deposit destinations by type.

networkstring

The blockchain network to filter by (e.g., base, ethereum). Only applies to crypto deposit destinations.

Filter deposit destinations by network.

status'active' | 'inactive' | 'pending'

The status of the deposit destination.

Example:active

Filter deposit destinations by status.

pageSizeinteger

The number of resources to return per page.

pageTokenstring

The token for the next page of resources, if any.

Response

Successfully listed deposit destinations.

nextPageTokenstring

The token for the next page of items, if any.

Example response

{
  "depositDestinations": [
    {
      "depositDestinationId": "depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "type": "crypto",
      "crypto": {
        "network": "base",
        "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      },
      "target": {
        "accountId": "account_bf3847c1-a957-5ae8-cfa0-ddd33e046225",
        "asset": "usd"
      },
      "status": "active",
      "metadata": {
        "customer_id": "123e4567-e89b-12d3-a456-426614174000",
        "reference": "order-12345"
      },
      "createdAt": "2023-10-08T14:30:00Z",
      "updatedAt": "2023-10-08T14:30:00Z"
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Changes