Skip to main content

Interfaces

GetDepositDestinationByIdRequest

Defined in: _vendor/api/resources/depositDestinations/client/requests/GetDepositDestinationByIdRequest.ts:13

Example

{
    depositDestinationId: "depositDestination_af2937b0-9846-4fe7-bfe9-ccc22d935114"
}

Properties

depositDestinationId
depositDestinationId: string;
Defined in: _vendor/api/resources/depositDestinations/client/requests/GetDepositDestinationByIdRequest.ts:15 The ID of the deposit address to retrieve.

ListDepositDestinationsRequest

Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:17

Example

{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    address: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    type: "crypto",
    network: "base",
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Properties

accountId?
optional accountId: string;
Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:19 Filter deposit destinations by account ID.
address?
optional address: string;
Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:21 Filter deposit destinations by the cryptocurrency address.
network?
optional network: string;
Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:25 Filter deposit destinations by network.
pageSize?
optional pageSize: number;
Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:27 The number of resources to return per page.
pageToken?
optional pageToken: string;
Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:29 The token for the next page of resources, if any.
type?
optional type: string;
Defined in: _vendor/api/resources/depositDestinations/client/requests/ListDepositDestinationsRequest.ts:23 Filter deposit destinations by type.

ListDepositDestinationsResponse

Defined in: _vendor/api/resources/depositDestinations/types/ListDepositDestinationsResponse.ts:5

Properties

depositDestinations
depositDestinations: Crypto[];
Defined in: _vendor/api/resources/depositDestinations/types/ListDepositDestinationsResponse.ts:7 The list of deposit destinations.
nextPageToken?
optional nextPageToken: string;
Defined in: _vendor/api/resources/depositDestinations/types/ListDepositDestinationsResponse.ts:9 The token for the next page of items, if any.

Type Aliases

Namespaces

Interfaces

CreateCryptoDepositDestinationRequest

Defined in: _vendor/api/types/CreateCryptoDepositDestinationRequest.ts:5

Extended by

Properties

accountId
accountId: string;
Defined in: _vendor/api/types/CreateCryptoDepositDestinationRequest.ts:7 The ID of the Account, which is a UUID prefixed by the string account_, that owns the deposit destination.
crypto
crypto: CreateDepositDestinationCrypto;
Defined in: _vendor/api/types/CreateCryptoDepositDestinationRequest.ts:11 Crypto-specific details. Required when type is crypto.
metadata?
optional metadata: Metadata;
Defined in: _vendor/api/types/CreateCryptoDepositDestinationRequest.ts:9
target?
optional target: DepositDestinationTargetAccount;
Defined in: _vendor/api/types/CreateCryptoDepositDestinationRequest.ts:8

CreateDepositDestinationCrypto

Defined in: _vendor/api/types/CreateDepositDestinationCrypto.ts:8 Crypto-specific details for creating a deposit destination.

Properties

network
network: Network;
Defined in: _vendor/api/types/CreateDepositDestinationCrypto.ts:9

CryptoDepositDestination

Defined in: _vendor/api/types/CryptoDepositDestination.ts:8 A cryptocurrency deposit destination.

Extended by

Properties

accountId
accountId: string;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:10
createdAt
createdAt: string;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:17 The timestamp when the deposit destination was created.
crypto
crypto: DepositDestinationCrypto;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:12 Crypto-specific details for this deposit destination. Always populated in responses. Contains the network and address.
depositDestinationId
depositDestinationId: string;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:9
metadata?
optional metadata: Metadata;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:15
status
status: DepositDestinationStatus;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:14
target?
optional target: DepositDestinationTargetAccount;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:13
updatedAt
updatedAt: string;
Defined in: _vendor/api/types/CryptoDepositDestination.ts:19 The timestamp when the deposit destination was last updated.

DepositDestinationCrypto

Defined in: _vendor/api/types/DepositDestinationCrypto.ts:8 Crypto-specific deposit destination details. In responses, this object is always present. Contains the network and address for the deposit destination.

Properties

address
address: string;
Defined in: _vendor/api/types/DepositDestinationCrypto.ts:10
network
network: Network;
Defined in: _vendor/api/types/DepositDestinationCrypto.ts:9

DepositDestinationReference

Defined in: _vendor/api/types/DepositDestinationReference.ts:8 A reference to the deposit destination associated with the transfer.

Properties

id
id: string;
Defined in: _vendor/api/types/DepositDestinationReference.ts:9

DepositDestinationTargetAccount

Defined in: _vendor/api/types/DepositDestinationTargetAccount.ts:8 The account and asset where incoming deposits should be credited.

Properties

accountId?
optional accountId: string;
Defined in: _vendor/api/types/DepositDestinationTargetAccount.ts:10 The ID of the CDP Account to which deposited funds should be transferred.
asset
asset: string;
Defined in: _vendor/api/types/DepositDestinationTargetAccount.ts:12 The symbol of the asset that should land in the target account.

DepositTravelRuleBeneficiary

Defined in: _vendor/api/types/DepositTravelRuleBeneficiary.ts:6 Beneficiary information for a deposit travel rule submission.

Properties

name?
optional name: string;
Defined in: _vendor/api/types/DepositTravelRuleBeneficiary.ts:8 Full name of the beneficiary.

DepositTravelRuleOriginator

Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:8 Originator information for a deposit travel rule submission.

Properties

address?
optional address: PhysicalAddress;
Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:11
dateOfBirth?
optional dateOfBirth: DateOfBirth;
Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:18 Date of birth of the originator.
name?
optional name: string;
Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:10 Full name of the originator.
personalId?
optional personalId: string;
Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:16 Personal identifier for travel rule compliance. For individuals: passport number, national ID, or driver’s license. For institutions: LEI (Legal Entity Identifier).
virtualAssetServiceProvider?
optional virtualAssetServiceProvider: DepositTravelRuleVasp;
Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:14
walletType?
optional walletType: WalletType;
Defined in: _vendor/api/types/DepositTravelRuleOriginator.ts:13 The type of the originator’s wallet.

DepositTravelRuleResponse

Defined in: _vendor/api/types/DepositTravelRuleResponse.ts:8 Response from submitting travel rule information for a deposit transfer.

Properties

missingFields?
optional missingFields: string[];
Defined in: _vendor/api/types/DepositTravelRuleResponse.ts:11 List of field paths that are still required to complete travel rule compliance. Each entry is a dot-separated path (e.g., “originator.name”, “originator.address.countryCode”). Empty when status is “completed”.
reason?
optional reason: string;
Defined in: _vendor/api/types/DepositTravelRuleResponse.ts:13 Additional context about the current status. Present when status is incomplete to explain what needs to be fixed before the transfer can proceed.
status
status: TravelRuleStatus;
Defined in: _vendor/api/types/DepositTravelRuleResponse.ts:9

DepositTravelRuleVasp

Defined in: _vendor/api/types/DepositTravelRuleVasp.ts:6 Information about the Virtual Asset Service Provider (VASP) for a deposit travel rule submission.

Properties

identifier?
optional identifier: string;
Defined in: _vendor/api/types/DepositTravelRuleVasp.ts:8 The Legal Entity Identifier (LEI) of the Virtual Asset Service Provider (VASP).
name?
optional name: string;
Defined in: _vendor/api/types/DepositTravelRuleVasp.ts:10 The name of the Virtual Asset Service Provider (VASP).

Type Aliases

Variables