Skip to main content

Interfaces

CreateAccountRequest

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

Example

{
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    name: "My Business Account"
}

Properties

idempotencyKey?
optional idempotencyKey: string;
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?
optional name: string;
Defined in: _vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:21

GetAccountByIdRequest

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

Example

{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114"
}

Properties

accountId
accountId: string;
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

{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    asset: "usd"
}

Properties

accountId
accountId: string;
Defined in: _vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:16 The unique identifier of the account.
asset
asset: string;
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

{
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Properties

pageSize?
optional pageSize: number;
Defined in: _vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:15 The number of resources to return per page.
pageToken?
optional pageToken: string;
Defined in: _vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:17 The token for the next page of resources, if any.
type?
optional type: AccountType;
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
accounts: Account[];
Defined in: _vendor/api/resources/accounts/types/ListAccountsResponse.ts:7 The list of accounts.
nextPageToken?
optional nextPageToken: string;
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

{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Properties

accountId
accountId: string;
Defined in: _vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:16 The unique identifier of the account.
pageSize?
optional pageSize: number;
Defined in: _vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:18 The number of resources to return per page.
pageToken?
optional pageToken: string;
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
balances: Balance[];
Defined in: _vendor/api/resources/accounts/types/ListBalancesResponse.ts:7 The list of balances.
nextPageToken?
optional nextPageToken: string;
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
accountId: string;
Defined in: _vendor/api/types/Account.ts:6
createdAt
createdAt: string;
Defined in: _vendor/api/types/Account.ts:11 The timestamp when the account was created.
name?
optional name: string;
Defined in: _vendor/api/types/Account.ts:9
owner
owner: string;
Defined in: _vendor/api/types/Account.ts:8
type
type: AccountType;
Defined in: _vendor/api/types/Account.ts:7
updatedAt
updatedAt: string;
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
available: string;
Defined in: _vendor/api/types/AmountDetail.ts:8 The amount that is currently available to be used.
total
total: string;
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
amount: Record<string, AmountDetail>;
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
asset: BalancesAsset;
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
decimals: number;
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
name: string;
Defined in: _vendor/api/types/BalancesAsset.ts:12 The name of the asset.
symbol
symbol: string;
Defined in: _vendor/api/types/BalancesAsset.ts:9
type
type: AssetType;
Defined in: _vendor/api/types/BalancesAsset.ts:10

Type Aliases

Variables