Class VirtualAccountAdminQueryService

Index

Constructors

constructor

Methods

get isProductActive search

Constructors

constructor

new VirtualAccountAdminQueryService(
    args: {
        customerService: CustomerService;
        db: B2bDatabase;
        productQuoteService: ProductQuoteService;
        solanaAccountBalanceQueryService: SolanaAccountBalanceQueryService;
        victorAccountQueryService: VictorAccountQueryService;
    },
): VirtualAccountAdminQueryService
Parameters
- args: {
      customerService: CustomerService;
      db: B2bDatabase;
      productQuoteService: ProductQuoteService;
      solanaAccountBalanceQueryService: SolanaAccountBalanceQueryService;
      victorAccountQueryService: VictorAccountQueryService;
  }
Returns VirtualAccountAdminQueryService
- Defined in virtual-account-services/src/VirtualAccountAdminService.ts:54

Methods

get

get(
    args: { id: string },
): Promise<
    {
        ok: true;
        value: | {
            accountNumber: string;
            achDepositInstructions: AchDepositInstructions
            | null;
            createdAt: Date;
            data:
                | {
                    provider: "VICTOR";
                    victorId: string;
                    victorLedgerProgramId: string;
                }
                | null;
            deletedAt: Date
            | null;
            id: string;
            name: string | null;
            providerId: string;
            providerName: string;
            providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL";
            referenceId: string | null;
            routingNumber: string;
            rtpDepositInstructions: RtpDepositInstructions | null;
            status: "PENDING" | "ACTIVE";
            type: "US_DEPOSIT" | "US_DDA";
            updatedAt: Date;
            walletAddress: Address;
            wireDepositInstructions: UsWireDepositInstructions | null;
        } & {
            balance: BigNumber;
            customerId: string;
            customerName: string;
            entityId: string;
            entityName: string;
            ledgerAccountId: string;
            ledgerAccountName: string;
        }
        | null;
    },
>
Parameters
- args: { id: string }
Returns Promise<
    {
        ok: true;
        value: | {
            accountNumber: string;
            achDepositInstructions: AchDepositInstructions
            | null;
            createdAt: Date;
            data:
                | {
                    provider: "VICTOR";
                    victorId: string;
                    victorLedgerProgramId: string;
                }
                | null;
            deletedAt: Date
            | null;
            id: string;
            name: string | null;
            providerId: string;
            providerName: string;
            providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL";
            referenceId: string | null;
            routingNumber: string;
            rtpDepositInstructions: RtpDepositInstructions | null;
            status: "PENDING" | "ACTIVE";
            type: "US_DEPOSIT" | "US_DDA";
            updatedAt: Date;
            walletAddress: Address;
            wireDepositInstructions: UsWireDepositInstructions | null;
        } & {
            balance: BigNumber;
            customerId: string;
            customerName: string;
            entityId: string;
            entityName: string;
            ledgerAccountId: string;
            ledgerAccountName: string;
        }
        | null;
    },
>
- Defined in virtual-account-services/src/VirtualAccountAdminService.ts:132

isProductActive

isProductActive(
    args: {
        customerId: string;
        entityId: string;
        ledgerAccountId: string;
        providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL";
    },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Resolves account.virtual-account.v1 activation for a specific entity (the ledger account's owning identity or organization), loading every Victor precondition the matcher inspects (customer-level Victor enrollment, ledger-account presence) so callers don't have to gather them one-by-one before every mutative call.

Pass providerType to signal creation/mutation intent — the matcher only enforces Dart-parity preconditions when virtualAccountProvider === "VICTOR" (see migration 20260418004128_virtual_account_victor_preconditions).
Parameters
- args: {
      customerId: string;
      entityId: string;
      ledgerAccountId: string;
      providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL";
  }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in virtual-account-services/src/VirtualAccountAdminService.ts:80

search

search(
    args: {
        accountNumbers?: string[];
        blockTime?: Date;
        ids?: string[];
        includeDeleted?: boolean;
        ledgerAccountAddresses?: Address[];
        ledgerAccountIds?: string[];
        page?: number;
        pageSize?: number;
        providerTypes?: ("VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL")[];
        statuses?: ("PENDING" | "ACTIVE")[];
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: VirtualAccountAdminSearchItem[];
            total: number;
        };
    },
>
Parameters
- args: {
      accountNumbers?: string[];
      blockTime?: Date;
      ids?: string[];
      includeDeleted?: boolean;
      ledgerAccountAddresses?: Address[];
      ledgerAccountIds?: string[];
      page?: number;
      pageSize?: number;
      providerTypes?: ("VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL")[];
      statuses?: ("PENDING" | "ACTIVE")[];
  }
  - OptionalaccountNumbers?: string[]
  - OptionalblockTime?: Date
    Snapshot point for the balance lookup. Defaults to the latest known balance.
  - Optionalids?: string[]
  - OptionalincludeDeleted?: boolean
    Defaults to false — deleted rows are hidden unless explicitly included.
  - OptionalledgerAccountAddresses?: Address[]
  - OptionalledgerAccountIds?: string[]
  - Optionalpage?: number
    Defaults to 1.
  - OptionalpageSize?: number
    Rows per page, default 50 (clamped to 200). Results are always paginated. total is the full match count regardless of pageSize, so pageSize: 1 counts matches cheaply without materializing every row.
  - OptionalproviderTypes?: ("VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL")[]
  - Optionalstatuses?: ("PENDING" | "ACTIVE")[]
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: VirtualAccountAdminSearchItem[];
            total: number;
        };
    },
>
- Defined in virtual-account-services/src/VirtualAccountAdminService.ts:241

Class VirtualAccountAdminQueryService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns VirtualAccountAdminQueryService

Methods

get

Parameters

isProductActive

Parameters

Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>

search

Parameters

`Optional`accountNumbers?: string[]

`Optional`blockTime?: Date

`Optional`ids?: string[]

`Optional`includeDeleted?: boolean

`Optional`ledgerAccountAddresses?: Address[]

`Optional`ledgerAccountIds?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`providerTypes?: ("VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL")[]

`Optional`statuses?: ("PENDING" | "ACTIVE")[]

Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: VirtualAccountAdminSearchItem[];
            total: number;
        };
    },
>

Settings

On This Page

Class VirtualAccountAdminQueryService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns VirtualAccountAdminQueryService

Methods

get

Parameters

isProductActive

Parameters

Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>

search

Parameters

OptionalaccountNumbers?: string[]

OptionalblockTime?: Date

Optionalids?: string[]

OptionalincludeDeleted?: boolean

OptionalledgerAccountAddresses?: Address[]

OptionalledgerAccountIds?: string[]

Optionalpage?: number

OptionalpageSize?: number

OptionalproviderTypes?: ("VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL")[]

Optionalstatuses?: ("PENDING" | "ACTIVE")[]

Returns Promise< { ok: true; value: { hasNext: boolean; items: VirtualAccountAdminSearchItem[]; total: number; }; },>

Settings

On This Page

`Optional`accountNumbers?: string[]

`Optional`blockTime?: Date

`Optional`ids?: string[]

`Optional`includeDeleted?: boolean

`Optional`ledgerAccountAddresses?: Address[]

`Optional`ledgerAccountIds?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`providerTypes?: ("VICTOR" | "BIVO" | "ROUTE_FUSION" | "MANUAL")[]

`Optional`statuses?: ("PENDING" | "ACTIVE")[]

Returns Promise<
{
ok: true;
value: {
hasNext: boolean;
items: VirtualAccountAdminSearchItem[];
total: number;
};
},
>