Skip to main content
Defined in: _vendor/api/resources/accounts/client/Client.ts:16 The Accounts APIs enable developers to create and manage accounts for their Entity. An Account is a container that holds assets and can be used for transacting. Accounts can be of different types including entity accounts, prime accounts, and business accounts. Support for Customer-owned accounts is in development.

​
Methods

​
createAccount()

createAccount(request?: CreateAccountRequest, requestOptions?: RequestOptions): HttpResponsePromise<Account>;
Defined in: _vendor/api/resources/accounts/client/Client.ts:144 Create an account for your Entity. Support for creating Customer-owned accounts is in development.

​
Parameters

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

​
Returns

HttpResponsePromise<Account>

​
Example

await client.accounts.createAccount({
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    name: "My Business Account"
})

​
getAccountById()

getAccountById(request: GetAccountByIdRequest, requestOptions?: RequestOptions): HttpResponsePromise<Account>;
Defined in: _vendor/api/resources/accounts/client/Client.ts:246 Get an account by its ID.

​
Parameters

request
GetAccountByIdRequest
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<Account>

​
Example

await client.accounts.getAccountById({
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114"
})

​
getBalanceByAsset()

getBalanceByAsset(request: GetBalanceByAssetRequest, requestOptions?: RequestOptions): HttpResponsePromise<Balance>;
Defined in: _vendor/api/resources/accounts/client/Client.ts:464 Get the balance for an account by asset.

​
Parameters

request
GetBalanceByAssetRequest
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<Balance>

​
Example

await client.accounts.getBalanceByAsset({
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    asset: "usd"
})

​
listAccounts()

listAccounts(request?: ListAccountsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ListAccountsResponse>;
Defined in: _vendor/api/resources/accounts/client/Client.ts:47 List all accounts. The API will return all accounts that the API Key has Permissions to access. You can filter the results by using query parameters, which will be treated as a single conjunction (i.e. AND). Results are sorted by creation date in descending order (newest first).

​
Parameters

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

​
Returns

HttpResponsePromise<ListAccountsResponse>

​
Example

await client.accounts.listAccounts({
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
})

​
listBalances()

listBalances(request: ListBalancesRequest, requestOptions?: RequestOptions): HttpResponsePromise<ListBalancesResponse>;
Defined in: _vendor/api/resources/accounts/client/Client.ts:341 List the balances for an account. Results are sorted by native-fiat equivalent balance in descending order.

​
Parameters

request
ListBalancesRequest
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<ListBalancesResponse>

​
Example

await client.accounts.listBalances({
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
})