Skip to main content
Defined in: _vendor/api/resources/depositDestinations/client/Client.ts:16 Deposit Destinations allow you to manage where funds can be deposited into your accounts.

​
Crypto Deposit Destinations

Crypto deposit destinations are cryptocurrency addresses that you can generate and fetch via the API. Once created, these addresses can receive cryptocurrency payments on their specified network and will settle in your account balance. Metadata: You can attach metadata to any deposit destination you create to track the purpose or source of deposits. Example: 
{
  "depositDestinationId": "depositDestination_123",
  "accountId": "account_456",
  "type": "crypto",
  "crypto": {
    "network": "base",
    "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
  },
  "target": {
    "accountId": "account_789",
    "asset": "usd"
  },
  "status": "active",
  "metadata": {
    "customer_id": "cust_789",
    "reference": "order-12345"
  }
}
Use the list endpoint to retrieve all deposit destinations.

​
Methods

​
createDepositDestination()

createDepositDestination(request: CreateDepositDestinationBody, requestOptions?: RequestOptions): HttpResponsePromise<Crypto>;
Defined in: _vendor/api/resources/depositDestinations/client/Client.ts:212 Create a new deposit destination for an account. A deposit destination is a cryptocurrency address that can be used to receive funds. The address will be generated for the specified network.

​
Parameters

request
CreateDepositDestinationBody
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<Crypto>

​
Example

await client.depositDestinations.createDepositDestination({
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    type: "crypto",
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    target: {
        accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
        asset: "usd"
    },
    metadata: {
        "customer_id": "123e4567-e89b-12d3-a456-426614174000",
        "reference": "order-12345"
    },
    crypto: {
        network: "base"
    }
})

​
getDepositDestinationById()

getDepositDestinationById(request: GetDepositDestinationByIdRequest, requestOptions?: RequestOptions): HttpResponsePromise<Crypto>;
Defined in: _vendor/api/resources/depositDestinations/client/Client.ts:331 Get a specific deposit destination by its ID.

​
Parameters

request
GetDepositDestinationByIdRequest
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<Crypto>

​
Example

await client.depositDestinations.getDepositDestinationById({
    depositDestinationId: "depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114"
})

​
listDepositDestinations()

listDepositDestinations(request?: ListDepositDestinationsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ListDepositDestinationsResponse>;
Defined in: _vendor/api/resources/depositDestinations/client/Client.ts:84 List deposit destinations. You can optionally filter the results by type, account ID, network, or cryptocurrency address. Results are sorted by creation date in descending order (newest first).

​
Parameters

request?
ListDepositDestinationsRequest = {}
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<ListDepositDestinationsResponse>

​
Example

await client.depositDestinations.listDepositDestinations({
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    address: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    type: "crypto",
    network: "base",
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
})