Skip to main content
The VirtualClient provides methods to manage virtual accounts.

create()

Create a new virtual account.
await bloque.accounts.virtual.create(
  params: CreateVirtualAccountParams,
  options?: CreateAccountOptions
): Promise<VirtualAccount>

Parameters

params
CreateVirtualAccountParams
Virtual account creation parameters
options
CreateAccountOptions
Creation options

Returns

VirtualAccount
object

Example

// Create without waiting
const account = await bloque.accounts.virtual.create({
  firstName: 'John',
  lastName: 'Doe'
});

// Create and wait for active status
const account = await bloque.accounts.virtual.create({
  firstName: 'John',
  lastName: 'Doe'
}, { waitLedger: true });

list()

List virtual accounts.
await bloque.accounts.virtual.list(
  params?: ListVirtualAccountsParams
): Promise<ListVirtualAccountsResult>

Parameters

params
ListVirtualAccountsParams
List parameters

Returns

ListVirtualAccountsResult
object

Example

// List all virtual accounts
const result = await bloque.accounts.virtual.list();

// Get a specific virtual account
const result = await bloque.accounts.virtual.list({
  urn: 'did:bloque:account:virtual:275d10a2-0854-4081-9d61-ea506e917335'
});

updateMetadata()

Update virtual account metadata.
await bloque.accounts.virtual.updateMetadata(
  params: UpdateVirtualMetadataParams
): Promise<VirtualAccount>

Parameters

params
UpdateVirtualMetadataParams
Metadata update parameters

Returns

VirtualAccount
object
Updated virtual account

Example

const account = await bloque.accounts.virtual.updateMetadata({
  urn: 'did:bloque:mediums:virtual:account:123',
  metadata: {
    updated_by: 'admin',
    update_reason: 'testing_update'
  }
});

activate()

Activate a virtual account.
await bloque.accounts.virtual.activate(
  urn: string
): Promise<VirtualAccount>

Parameters

urn
string
required
Virtual account URN

Returns

VirtualAccount
object
Updated virtual account

Example

const account = await bloque.accounts.virtual.activate(
  'did:bloque:mediums:virtual:account:123'
);

freeze()

Freeze a virtual account.
await bloque.accounts.virtual.freeze(
  urn: string
): Promise<VirtualAccount>

Parameters

urn
string
required
Virtual account URN

Returns

VirtualAccount
object
Updated virtual account

Example

const account = await bloque.accounts.virtual.freeze(
  'did:bloque:mediums:virtual:account:123'
);

disable()

Disable a virtual account.
await bloque.accounts.virtual.disable(
  urn: string
): Promise<VirtualAccount>

Parameters

urn
string
required
Virtual account URN

Returns

VirtualAccount
object
Updated virtual account

Example

const account = await bloque.accounts.virtual.disable(
  'did:bloque:mediums:virtual:account:123'
);

Build docs developers (and LLMs) love