List deposit destinations

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/deposit-destinations \
  --header 'Authorization: Bearer <token>'

{
  "depositDestinations": [
    {
      "depositDestinationId": "depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "type": "crypto",
      "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "network": "base",
      "metadata": {
        "customer_id": "123e4567-e89b-12d3-a456-426614174000",
        "reference": "order-12345"
      },
      "createdAt": "2023-10-08T14:30:00Z",
      "updatedAt": "2023-10-08T14:30:00Z"
    },
    {
      "depositDestinationId": "depositDestination_bf3847c1-a957-5ge8-cfg0-ddd33e046225",
      "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "type": "crypto",
      "address": "0x8c3b2b6c5f4e3d7a9b8c6e5f2a1d9c8b7a6e5f4d",
      "network": "ethereum",
      "metadata": {
        "customer_id": "456e7890-f12c-34e5-b678-901234567890",
        "purpose": "salary-payment"
      },
      "createdAt": "2023-10-08T15:00:00Z",
      "updatedAt": "2023-10-08T15:00:00Z"
    }
  ]
}

GET

deposit-destinations

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/deposit-destinations \
  --header 'Authorization: Bearer <token>'

{
  "depositDestinations": [
    {
      "depositDestinationId": "depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "type": "crypto",
      "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "network": "base",
      "metadata": {
        "customer_id": "123e4567-e89b-12d3-a456-426614174000",
        "reference": "order-12345"
      },
      "createdAt": "2023-10-08T14:30:00Z",
      "updatedAt": "2023-10-08T14:30:00Z"
    },
    {
      "depositDestinationId": "depositDestination_bf3847c1-a957-5ge8-cfg0-ddd33e046225",
      "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "type": "crypto",
      "address": "0x8c3b2b6c5f4e3d7a9b8c6e5f2a1d9c8b7a6e5f4d",
      "network": "ethereum",
      "metadata": {
        "customer_id": "456e7890-f12c-34e5-b678-901234567890",
        "purpose": "salary-payment"
      },
      "createdAt": "2023-10-08T15:00:00Z",
      "updatedAt": "2023-10-08T15:00:00Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

accountId

string

Filter deposit destinations by account ID.

Example:

"account_af2937b0-9846-4fe7-bfe9-ccc22d935114"

address

string

Filter deposit destinations by the cryptocurrency address.

type

enum<string>

Filter deposit destinations by type.

Available options:

crypto

Example:

"crypto"

network

string

Filter deposit destinations by network.

pageSize

integer

default:20

The number of resources to return per page.

pageToken

string

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

Response

Successfully listed deposit destinations.

depositDestinations

object[]

required

The list of deposit destinations.

A deposit destination for receiving funds to an account. Can be either a cryptocurrency address or fiat bank account instructions.

Show child attributes

depositDestinationId

string

required

The ID of the Deposit Destination, which is a UUID prefixed by the string depositDestination_.

Example:

"depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114"

accountId

string

required

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

Example:

"account_af2937b0-9846-4fe7-bfe9-ccc22d935114"

type

enum<string>

required

The type of deposit destination.

Available options:

crypto

Example:

"crypto"

address

string

required

The cryptocurrency address where funds can be deposited. Format depends on the network (e.g., 0x-prefixed for EVM networks, base58 for Solana).

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

network

enum<string>

required

The blockchain network for the payment. All networks support USDC and USDT.

Available options:

base,

ethereum,

solana,

aptos,

arbitrum,

avacchain,

optimism,

polygon,

sui

Example:

"base"

createdAt

string<date-time>

required

The timestamp when the deposit destination was created.

Example:

"2023-10-08T14:30:00Z"

updatedAt

string<date-time>

required

The timestamp when the deposit destination was last updated.

Example:

"2023-10-08T14:30:00Z"

metadata

object

Optional metadata associated with the deposit destination as key-value pairs. This can be used to store additional information like customer IDs, reference numbers, etc.

Show child attributes

metadata.{key}

string

Example:

{
  "customerRef": "123e4567-e89b-12d3-a456-426614174000"
}

Example:

{
  "depositDestinationId": "depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114",
  "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
  "type": "crypto",
  "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "network": "base",
  "metadata": {
    "customerRef": "123e4567-e89b-12d3-a456-426614174000"
  },
  "createdAt": "2023-10-08T14:30:00Z",
  "updatedAt": "2023-10-08T14:30:00Z"
}

nextPageToken

string

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

Example:

"eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="

Get deposit destination

Create crypto deposit destination

⌘I

CDP PAYMENTS API

REST API

List deposit destinations

Authorizations

Query Parameters

Response