Skip to main content

Interfaces

CreateAccountRequest

Defined in: _vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:14

Example

Properties

idempotencyKey?
Defined in: _vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:20 An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our Idempotency docs for more information on using idempotency keys.
name?
Defined in: _vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:21

GetAccountByIdRequest

Defined in: _vendor/api/resources/accounts/client/requests/GetAccountByIdRequest.ts:13

Example

Properties

accountId
Defined in: _vendor/api/resources/accounts/client/requests/GetAccountByIdRequest.ts:15 The ID of the account to retrieve.

GetBalanceByAssetRequest

Defined in: _vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:14

Example

Properties

accountId
Defined in: _vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:16 The unique identifier of the account.
asset
Defined in: _vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:18 The symbol of the asset.

ListAccountsRequest

Defined in: _vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:13

Example

Properties

pageSize?
Defined in: _vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:15 The number of resources to return per page.
pageToken?
Defined in: _vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:17 The token for the next page of resources, if any.
type?
Defined in: _vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:19 Filter accounts by account type. When omitted, accounts of any type are returned. Combined with owner using AND.

ListAccountsResponse

Defined in: _vendor/api/resources/accounts/types/ListAccountsResponse.ts:5

Properties

accounts
Defined in: _vendor/api/resources/accounts/types/ListAccountsResponse.ts:7 The list of accounts.
nextPageToken?
Defined in: _vendor/api/resources/accounts/types/ListAccountsResponse.ts:9 The token for the next page of items, if any.

ListBalancesRequest

Defined in: _vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:14

Example

Properties

accountId
Defined in: _vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:16 The unique identifier of the account.
pageSize?
Defined in: _vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:18 The number of resources to return per page.
pageToken?
Defined in: _vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:20 The token for the next page of resources, if any.

ListBalancesResponse

Defined in: _vendor/api/resources/accounts/types/ListBalancesResponse.ts:5

Properties

balances
Defined in: _vendor/api/resources/accounts/types/ListBalancesResponse.ts:7 The list of balances.
nextPageToken?
Defined in: _vendor/api/resources/accounts/types/ListBalancesResponse.ts:9 The token for the next page of items, if any.

Interfaces

Account

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

Properties

accountId
Defined in: _vendor/api/types/Account.ts:6
createdAt
Defined in: _vendor/api/types/Account.ts:11 The timestamp when the account was created.
name?
Defined in: _vendor/api/types/Account.ts:9
owner
Defined in: _vendor/api/types/Account.ts:8
type
Defined in: _vendor/api/types/Account.ts:7
updatedAt
Defined in: _vendor/api/types/Account.ts:13 The timestamp when the account was last updated.

AmountDetail

Defined in: _vendor/api/types/AmountDetail.ts:6 Available and total amounts for a specific currency.

Properties

available
Defined in: _vendor/api/types/AmountDetail.ts:8 The amount that is currently available to be used.
total
Defined in: _vendor/api/types/AmountDetail.ts:10 The total amount, including the amount that is currently on hold.

Balance

Defined in: _vendor/api/types/Balance.ts:8 A balance of an asset.

Properties

amount
Defined in: _vendor/api/types/Balance.ts:14 Amount details denominated in different assets.
  • The keys represent the asset symbols (e.g., “btc”, “usd”), - Each value contains available and total amounts. - There will always be an entry for the asset specified in the asset field.
asset
Defined in: _vendor/api/types/Balance.ts:9

BalancesAsset

Defined in: _vendor/api/types/BalancesAsset.ts:8 An asset, e.g. fiat or crypto.

Properties

decimals
Defined in: _vendor/api/types/BalancesAsset.ts:14 The number of decimals (i.e. significant digits to the right of the decimal point) supported for the asset.
name
Defined in: _vendor/api/types/BalancesAsset.ts:12 The name of the asset.
symbol
Defined in: _vendor/api/types/BalancesAsset.ts:9
type
Defined in: _vendor/api/types/BalancesAsset.ts:10

Type Aliases

Variables