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

    Class VirtualAccountAdminService

    Admin-only mutations on virtual accounts. Operates across all customers and takes no customerId.

    Index
    constructor
    create delete

    • Admin-creates an ACTIVE virtual account on an existing ledger account for a MANUAL-type provider — a bank we hold an out-of-band deposit account at but have no onboarding integration for. Unlike the Victor flow there's no partner API to call and nothing to poll: the row lands ACTIVE in one transaction, stamped with an audit product_quote.

      The provider must resolve to a MANUAL-type virtual_account_provider row (integrated victor/bivo/route_fusion providers are rejected — those mint through their own dispatcher). The bank supplies the customer-facing deposit instructions via the linked bank row.

      Parameters

      • args: {
            accountNumber: string;
            bankId: string;
            customerId: string;
            ledgerAccountId: string;
            name?: string;
            providerId: string;
            referenceId?: string | null;
            type: "US_DDA" | "US_DEPOSIT";
        }
        • accountNumber: string
        • bankId: string
        • customerId: string
        • ledgerAccountId: string
        • Optionalname?: string
        • providerId: string

          A virtual_account_provider externalId; must resolve to type MANUAL.

        • OptionalreferenceId?: string | null
        • type: "US_DDA" | "US_DEPOSIT"

      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;
              } & { customerId: string; entityId: string; ledgerAccountId: string };
          }
          | { error: ServiceError; ok: false },
      >

    • Toggle whether a virtual account is soft-deleted (hidden from customer-facing reads). When deleted is true the consumer VirtualAccountService read paths filter the row out entirely.

      Parameters

      • args: { deleted: boolean; id: string }

      Returns Promise<
          { ok: true; value: { id: string } }
          | { error: ServiceError; ok: false },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods