@cfxlabsinc/b2b-services
    Preparing search index...

    Class VirtualAccountAdminQueryService

    Index

    Constructors

    constructor

    Methods

    get isProductActive search

    Constructors

    Methods

    • Parameters

      • args: { id: string }

      Returns Promise<
          {
              ok: true;
              value: | {
                  accountNumber: string;
                  achDepositInstructions: AchDepositInstructions;
                  createdAt: Date;
                  data: | { ledgerProgramId: string; provider: "VICTOR"; victorId: string }
                  | null;
                  deletedAt: Date | null;
                  id: string;
                  name: string | null;
                  provider: "VICTOR" | "BIVO" | "ROUTE_FUSION";
                  referenceId: string | null;
                  routingNumber: string;
                  rtpDepositInstructions: RtpDepositInstructions;
                  status: "PENDING" | "ACTIVE";
                  type: "US_DEPOSIT" | "US_DDA";
                  updatedAt: Date;
                  walletAddress: Address;
                  wireDepositInstructions: UsWireDepositInstructions;
              } & {
                  balance: BigNumber;
                  customerId: string;
                  customerName: string;
                  entityId: string;
                  entityName: string;
                  ledgerAccountId: string;
                  ledgerAccountName: string;
              }
              | null;
          },
      >

    • 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 provider 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;
            provider: "VICTOR" | "BIVO" | "ROUTE_FUSION";
        }

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

    • Parameters

      • args: {
            accountNumbers?: string[];
            blockTime?: Date;
            excludeDeleted?: boolean;
            ids?: string[];
            ledgerAccountAddresses?: Address[];
            ledgerAccountIds?: string[];
            providers?: ("VICTOR" | "BIVO" | "ROUTE_FUSION")[];
            statuses?: ("PENDING" | "ACTIVE")[];
        }
        • OptionalaccountNumbers?: string[]
        • OptionalblockTime?: Date

          Snapshot point for the balance lookup. Defaults to the latest known balance.

        • OptionalexcludeDeleted?: boolean

          Defaults to false — preserves the historical behaviour of returning every row regardless of deletion.

        • Optionalids?: string[]
        • OptionalledgerAccountAddresses?: Address[]
        • OptionalledgerAccountIds?: string[]
        • Optionalproviders?: ("VICTOR" | "BIVO" | "ROUTE_FUSION")[]
        • Optionalstatuses?: ("PENDING" | "ACTIVE")[]

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: (
                      {
                          accountNumber: string;
                          achDepositInstructions: AchDepositInstructions;
                          createdAt: Date;
                          data: | {
                              ledgerProgramId: string;
                              provider: "VICTOR";
                              victorId: string;
                          }
                          | null;
                          deletedAt: Date
                          | null;
                          id: string;
                          name: string | null;
                          provider: "VICTOR" | "BIVO" | "ROUTE_FUSION";
                          referenceId: string | null;
                          routingNumber: string;
                          rtpDepositInstructions: RtpDepositInstructions;
                          status: "PENDING" | "ACTIVE";
                          type: "US_DEPOSIT" | "US_DDA";
                          updatedAt: Date;
                          walletAddress: Address;
                          wireDepositInstructions: UsWireDepositInstructions;
                      } & {
                          balance: BigNumber;
                          customerId: string;
                          customerName: string;
                          entityId: string;
                          entityName: string;
                          ledgerAccountId: string;
                          ledgerAccountName: string;
                      }
                  )[];
              };
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods