Class VirtualAccountAdminQueryService

Index

Constructors

constructor

Methods

get isProductActive search

Constructors

constructor

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

Methods

get

get(
    args: { id: string },
): Promise<
    {
        ok: true;
        value: | {
            accountNumber: string;
            achDepositInstructions: AchDepositInstructions
            | null;
            createdAt: Date;
            data:
                | {
                    provider: "VICTOR";
                    victorId: string;
                    victorLedgerProgramId: string;
                }
                | {
                    entityId: string;
                    entityInput?: {
                        businessAddress1: string;
                        businessAddress2?: string;
                        businessCity: string;
                        businessCountry: string;
                        businessName: string;
                        businessPostalCode: string;
                        businessStateProvinceRegion?: string;
                        businessType?: | "b_corporation"
                        | "c_corporation"
                        | "close_corporation"
                        | "cooperative"
                        | "general_partnership"
                        | "limited_liability_company"
                        | "limited_partnership"
                        | "nonprofit_corporation"
                        | "s_corporation"
                        | "sole_proprietorship"
                        | "non_us";
                        contactFirstName: string;
                        contactLastName: string;
                        email: string;
                        incorporationDate?: string;
                        phone?: string;
                        phoneCountry?: string;
                        taxNumber?: string;
                        websiteUrl?: string;
                    };
                    fundingInstructions: | {
                        accountHolderAddress1?: string
                        | null;
                        accountHolderAddress2?: string | null;
                        accountHolderCity?: string | null;
                        accountHolderCountry?: string | null;
                        accountHolderName: string | null;
                        accountHolderPostalCode?: string | null;
                        accountHolderStateProvinceRegion?: string | null;
                        accountNumber: string | null;
                        bankAddress1?: string | null;
                        bankAddress2?: string | null;
                        bankCity?: string | null;
                        bankCountry: string | null;
                        bankName: string | null;
                        bankPostalCode?: string | null;
                        bankStateProvinceRegion?: string | null;
                        currency: string | null;
                        message?: string | null;
                        qr?: { base64Image: ...; expirationDate: ...; qrDecoded: ... } | null;
                        reference: string | null;
                        routingCode: string | null;
                        routingCodeAlternate?: string | null;
                        swiftBic: string | null;
                        taxNumber?: string | null;
                        type: string | null;
                    }
                    | null;
                    programId: string;
                    provider: "ROUTE_FUSION";
                    walletId: string;
                }
                | null;
            deletedAt: Date
            | null;
            id: string;
            name: string | null;
            providerDepositInstructions: ProviderDepositInstructions | null;
            providerId: string;
            providerName: string;
            providerType: "ROUTE_FUSION" | "VICTOR" | "BIVO" | "MANUAL";
            referenceId: string | null;
            routingNumber: string;
            rtpDepositInstructions: RtpDepositInstructions | null;
            status: "ACTIVE" | "FAILED" | "PENDING" | "INACTIVE";
            swiftDepositInstructions:
                | (
                    | Omit<UsdSwiftWireInstructionData, "swiftField70Prefix"> & {
                        receivingEntityName: string;
                        swiftField70: SwiftField70Prefix;
                    }
                    | Omit<ForeignSwiftWireInstructionData, "swiftField70Prefix"> & {
                        receivingEntityName: string;
                        swiftField70: SwiftField70Prefix;
                    }
                )[]
                | null;
            type: "US_DDA"
            | "US_DEPOSIT";
            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;
                }
                | {
                    entityId: string;
                    entityInput?: {
                        businessAddress1: string;
                        businessAddress2?: string;
                        businessCity: string;
                        businessCountry: string;
                        businessName: string;
                        businessPostalCode: string;
                        businessStateProvinceRegion?: string;
                        businessType?: | "b_corporation"
                        | "c_corporation"
                        | "close_corporation"
                        | "cooperative"
                        | "general_partnership"
                        | "limited_liability_company"
                        | "limited_partnership"
                        | "nonprofit_corporation"
                        | "s_corporation"
                        | "sole_proprietorship"
                        | "non_us";
                        contactFirstName: string;
                        contactLastName: string;
                        email: string;
                        incorporationDate?: string;
                        phone?: string;
                        phoneCountry?: string;
                        taxNumber?: string;
                        websiteUrl?: string;
                    };
                    fundingInstructions: | {
                        accountHolderAddress1?: string
                        | null;
                        accountHolderAddress2?: string | null;
                        accountHolderCity?: string | null;
                        accountHolderCountry?: string | null;
                        accountHolderName: string | null;
                        accountHolderPostalCode?: string | null;
                        accountHolderStateProvinceRegion?: string | null;
                        accountNumber: string | null;
                        bankAddress1?: string | null;
                        bankAddress2?: string | null;
                        bankCity?: string | null;
                        bankCountry: string | null;
                        bankName: string | null;
                        bankPostalCode?: string | null;
                        bankStateProvinceRegion?: string | null;
                        currency: string | null;
                        message?: string | null;
                        qr?: { base64Image: ...; expirationDate: ...; qrDecoded: ... } | null;
                        reference: string | null;
                        routingCode: string | null;
                        routingCodeAlternate?: string | null;
                        swiftBic: string | null;
                        taxNumber?: string | null;
                        type: string | null;
                    }
                    | null;
                    programId: string;
                    provider: "ROUTE_FUSION";
                    walletId: string;
                }
                | null;
            deletedAt: Date
            | null;
            id: string;
            name: string | null;
            providerDepositInstructions: ProviderDepositInstructions | null;
            providerId: string;
            providerName: string;
            providerType: "ROUTE_FUSION" | "VICTOR" | "BIVO" | "MANUAL";
            referenceId: string | null;
            routingNumber: string;
            rtpDepositInstructions: RtpDepositInstructions | null;
            status: "ACTIVE" | "FAILED" | "PENDING" | "INACTIVE";
            swiftDepositInstructions:
                | (
                    | Omit<UsdSwiftWireInstructionData, "swiftField70Prefix"> & {
                        receivingEntityName: string;
                        swiftField70: SwiftField70Prefix;
                    }
                    | Omit<ForeignSwiftWireInstructionData, "swiftField70Prefix"> & {
                        receivingEntityName: string;
                        swiftField70: SwiftField70Prefix;
                    }
                )[]
                | null;
            type: "US_DDA"
            | "US_DEPOSIT";
            updatedAt: Date;
            walletAddress: Address;
            wireDepositInstructions: UsWireDepositInstructions | null;
        } & {
            balance: BigNumber;
            customerId: string;
            customerName: string;
            entityId: string;
            entityName: string;
            ledgerAccountId: string;
            ledgerAccountName: string;
        }
        | null;
    },
>
- Defined in packages/virtual-account-services/src/VirtualAccountAdminService.ts:154

isProductActive

isProductActive(
    args: {
        customerId: string;
        entityId: string;
        ledgerAccountId: string;
        providerType: "ROUTE_FUSION" | "VICTOR" | "BIVO" | "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: "ROUTE_FUSION" | "VICTOR" | "BIVO" | "MANUAL";
  }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in packages/virtual-account-services/src/VirtualAccountAdminService.ts:94

search

search(
    args: {
        accountNumbers?: string[];
        bankIds?: string[];
        blockTime?: Date;
        createdAt?: DbTimestampCriteria;
        customerIds?: string[];
        entityIds?: string[];
        ids?: string[];
        includeDeleted?: boolean;
        ledgerAccountAddresses?: Address[];
        ledgerAccountIds?: string[];
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            accountNumber: PgBuildColumn<
                                "virtual_account",
                                SetNotNull<PgTextBuilder<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            bankId: PgBuildColumn<
                                "virtual_account",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            createdAt: PgBuildColumn<
                                "virtual_account",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "virtual_account",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            data: PgBuildColumn<
                                "virtual_account",
                                Set$Type<PgJsonbBuilder, (...) | (...)>,
                                {
                                    data: (...) | (...);
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            deletedAt: PgBuildColumn<
                                "virtual_account",
                                PgTimestampBuilder,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "virtual_account",
                                SetHasRuntimeDefault<SetNotNull<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            id: PgBuildColumn<
                                "virtual_account",
                                HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            identityId: PgBuildColumn<
                                "virtual_account",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            ledgerAccountId: PgBuildColumn<
                                "virtual_account",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            name: PgBuildColumn<
                                "virtual_account",
                                PgTextBuilder<[(...), ...(...)[]]>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            organizationId: PgBuildColumn<
                                "virtual_account",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            productQuoteId: PgBuildColumn<
                                "virtual_account",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            providerId: PgBuildColumn<
                                "virtual_account",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            referenceId: PgBuildColumn<
                                "virtual_account",
                                PgTextBuilder<[(...), ...(...)[]]>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "virtual_account";
                                },
                            >;
                            routingNumber: PgBuildColumn<
                                "virtual_account",
                                SetNotNull<PgTextBuilder<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            status: PgBuildColumn<
                                "virtual_account",
                                Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                                {
                                    data: (...) | (...) | (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            type: PgBuildColumn<
                                "virtual_account",
                                Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                {
                                    data: (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "virtual_account",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "virtual_account";
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "virtual_account";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        providerTypes?: ("ROUTE_FUSION" | "VICTOR" | "BIVO" | "MANUAL")[];
        q?: string;
        routeFusionEntityIds?: string[];
        routeFusionProgramIds?: string[];
        routeFusionWalletIds?: string[];
        statuses?: ("ACTIVE" | "FAILED" | "PENDING" | "INACTIVE")[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: VirtualAccountAdminSearchItem[];
            total: number;
        };
    },
>
Parameters
- args: {
      accountNumbers?: string[];
      bankIds?: string[];
      blockTime?: Date;
      createdAt?: DbTimestampCriteria;
      customerIds?: string[];
      entityIds?: string[];
      ids?: string[];
      includeDeleted?: boolean;
      ledgerAccountAddresses?: Address[];
      ledgerAccountIds?: string[];
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          accountNumber: PgBuildColumn<
                              "virtual_account",
                              SetNotNull<PgTextBuilder<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          bankId: PgBuildColumn<
                              "virtual_account",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          createdAt: PgBuildColumn<
                              "virtual_account",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "virtual_account",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          data: PgBuildColumn<
                              "virtual_account",
                              Set$Type<PgJsonbBuilder, (...) | (...)>,
                              {
                                  data: (...) | (...);
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          deletedAt: PgBuildColumn<
                              "virtual_account",
                              PgTimestampBuilder,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "virtual_account",
                              SetHasRuntimeDefault<SetNotNull<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          id: PgBuildColumn<
                              "virtual_account",
                              HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          identityId: PgBuildColumn<
                              "virtual_account",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          ledgerAccountId: PgBuildColumn<
                              "virtual_account",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          name: PgBuildColumn<
                              "virtual_account",
                              PgTextBuilder<[(...), ...(...)[]]>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          organizationId: PgBuildColumn<
                              "virtual_account",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          productQuoteId: PgBuildColumn<
                              "virtual_account",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          providerId: PgBuildColumn<
                              "virtual_account",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          referenceId: PgBuildColumn<
                              "virtual_account",
                              PgTextBuilder<[(...), ...(...)[]]>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "virtual_account";
                              },
                          >;
                          routingNumber: PgBuildColumn<
                              "virtual_account",
                              SetNotNull<PgTextBuilder<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          status: PgBuildColumn<
                              "virtual_account",
                              Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                              {
                                  data: (...) | (...) | (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          type: PgBuildColumn<
                              "virtual_account",
                              Set$Type<SetNotNull<(...)>, (...) | (...)>,
                              {
                                  data: (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "virtual_account",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "virtual_account";
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "virtual_account";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      providerTypes?: ("ROUTE_FUSION" | "VICTOR" | "BIVO" | "MANUAL")[];
      q?: string;
      routeFusionEntityIds?: string[];
      routeFusionProgramIds?: string[];
      routeFusionWalletIds?: string[];
      statuses?: ("ACTIVE" | "FAILED" | "PENDING" | "INACTIVE")[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalaccountNumbers?: string[]
  - OptionalbankIds?: string[]
    
    Filter by the linked bank's externalId.
  - OptionalblockTime?: Date
    
    Snapshot point for the balance lookup. Defaults to the latest known balance.
  - OptionalcreatedAt?: DbTimestampCriteria
  - OptionalcustomerIds?: string[]
    
    Filter by the owning customer's externalId.
  - OptionalentityIds?: string[]
    
    Filter by the owning entity (identity or organization) externalId.
  - Optionalids?: string[]
  - OptionalincludeDeleted?: boolean
    
    Defaults to false — deleted rows are hidden unless explicitly included.
  - OptionalledgerAccountAddresses?: Address[]
  - OptionalledgerAccountIds?: string[]
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        accountNumber: PgBuildColumn<
                            "virtual_account",
                            SetNotNull<PgTextBuilder<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        bankId: PgBuildColumn<
                            "virtual_account",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        createdAt: PgBuildColumn<
                            "virtual_account",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        customerId: PgBuildColumn<
                            "virtual_account",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        data: PgBuildColumn<
                            "virtual_account",
                            Set$Type<PgJsonbBuilder, (...) | (...)>,
                            {
                                data: (...) | (...);
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        deletedAt: PgBuildColumn<
                            "virtual_account",
                            PgTimestampBuilder,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        externalId: PgBuildColumn<
                            "virtual_account",
                            SetHasRuntimeDefault<SetNotNull<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        id: PgBuildColumn<
                            "virtual_account",
                            HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        identityId: PgBuildColumn<
                            "virtual_account",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        ledgerAccountId: PgBuildColumn<
                            "virtual_account",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        name: PgBuildColumn<
                            "virtual_account",
                            PgTextBuilder<[(...), ...(...)[]]>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        organizationId: PgBuildColumn<
                            "virtual_account",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        productQuoteId: PgBuildColumn<
                            "virtual_account",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        providerId: PgBuildColumn<
                            "virtual_account",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        referenceId: PgBuildColumn<
                            "virtual_account",
                            PgTextBuilder<[(...), ...(...)[]]>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "virtual_account";
                            },
                        >;
                        routingNumber: PgBuildColumn<
                            "virtual_account",
                            SetNotNull<PgTextBuilder<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        status: PgBuildColumn<
                            "virtual_account",
                            Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                            {
                                data: (...) | (...) | (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        type: PgBuildColumn<
                            "virtual_account",
                            Set$Type<SetNotNull<(...)>, (...) | (...)>,
                            {
                                data: (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                        updatedAt: PgBuildColumn<
                            "virtual_account",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "virtual_account";
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "virtual_account";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
    
    Defaults to createdAt DESC when omitted.
  - 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?: ("ROUTE_FUSION" | "VICTOR" | "BIVO" | "MANUAL")[]
  - Optionalq?: string
    
    Case-insensitive substring match on account name or account number. Whitespace-only values are a no-op.
  - OptionalrouteFusionEntityIds?: string[]
    
    Matches the RouteFusion entity id stored on data->>'entityId'.
  - OptionalrouteFusionProgramIds?: string[]
    
    Matches the RouteFusion program id stored on data->>'programId'. NOT index-backed — this seq-scans virtual_account.
  - OptionalrouteFusionWalletIds?: string[]
    
    Matches the RouteFusion wallet id stored on data->>'walletId'. Served by the partial index idx_virtual_account_rf_wallet ((data->>'walletId') WHERE data->>'provider' = 'ROUTE_FUSION').
  - Optionalstatuses?: ("ACTIVE" | "FAILED" | "PENDING" | "INACTIVE")[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: VirtualAccountAdminSearchItem[];
            total: number;
        };
    },
>
- Defined in packages/virtual-account-services/src/VirtualAccountAdminService.ts:180

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`bankIds?: string[]

`Optional`blockTime?: Date

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerIds?: string[]

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`includeDeleted?: boolean

`Optional`ledgerAccountAddresses?: Address[]

`Optional`ledgerAccountIds?: string[]

`Optional`page?: number

`Optional`pageSize?: number

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

`Optional`q?: string

`Optional`routeFusionEntityIds?: string[]

`Optional`routeFusionProgramIds?: string[]

`Optional`routeFusionWalletIds?: string[]

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

`Optional`updatedAt?: DbTimestampCriteria

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[]

OptionalbankIds?: string[]

OptionalblockTime?: Date

OptionalcreatedAt?: DbTimestampCriteria

OptionalcustomerIds?: string[]

OptionalentityIds?: string[]

Optionalids?: string[]

OptionalincludeDeleted?: boolean

OptionalledgerAccountAddresses?: Address[]

OptionalledgerAccountIds?: string[]

Optionalpage?: number

OptionalpageSize?: number

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

Optionalq?: string

OptionalrouteFusionEntityIds?: string[]

OptionalrouteFusionProgramIds?: string[]

OptionalrouteFusionWalletIds?: string[]

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

OptionalupdatedAt?: DbTimestampCriteria

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

Settings

On This Page

`Optional`accountNumbers?: string[]

`Optional`bankIds?: string[]

`Optional`blockTime?: Date

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerIds?: string[]

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`includeDeleted?: boolean

`Optional`ledgerAccountAddresses?: Address[]

`Optional`ledgerAccountIds?: string[]

`Optional`page?: number

`Optional`pageSize?: number

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

`Optional`q?: string

`Optional`routeFusionEntityIds?: string[]

`Optional`routeFusionProgramIds?: string[]

`Optional`routeFusionWalletIds?: string[]

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

`Optional`updatedAt?: DbTimestampCriteria

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