Skip to main content
GET
Get deposit destination

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.

Path Parameters

depositDestinationId
string
required

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

Pattern: ^depositDestination_[a-f0-9\-]{36}$
Example:

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

Response

Successfully retrieved deposit destination.

A deposit destination for receiving funds to an account.

depositDestinationId
string
required

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

Pattern: ^depositDestination_[a-f0-9\-]{36}$
Example:

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

accountId
string
required

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

Pattern: ^account_[a-f0-9\-]{36}$
Example:

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

type
enum<string>
required

The type of deposit destination.

Available options:
crypto
Example:

"crypto"

crypto
object
required

Crypto-specific details for this deposit destination. Always populated in responses. Contains the network and address.

Example:
status
enum<string>
required

The status of the deposit destination.

Available options:
active,
inactive,
pending
Example:

"active"

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"

target
Target Account · object

The intended target for deposited funds.

Example:
metadata
object

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

Example: