Class VictorVirtualAccountService

constructor

• new VictorVirtualAccountService(
      args: {
          db: B2bDatabase;
          entityService: EntityService;
          eventPublisher: CustomerEventPublisher;
          ledgerAccountQueryService: LedgerAccountQueryService;
          paymentInstrumentVendorBackfillStarter: PaymentInstrumentVendorBackfillStarter;
          victorAccountClient: VictorAccountClient;
          virtualAccountQueryService: VirtualAccountQueryService;
      },
  ): VictorVirtualAccountService

  Parameters

  • args: {
        db: B2bDatabase;
        entityService: EntityService;
        eventPublisher: CustomerEventPublisher;
        ledgerAccountQueryService: LedgerAccountQueryService;
        paymentInstrumentVendorBackfillStarter: PaymentInstrumentVendorBackfillStarter;
        victorAccountClient: VictorAccountClient;
        virtualAccountQueryService: VirtualAccountQueryService;
    }

  Returns VictorVirtualAccountService

Staticinstance

create

• create(
      args: {
          customerId: string;
          ledgerAccountId: string;
          name?: string;
          referenceId?: string | null;
      },
  ): 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;
                  }
                  | { accountId?: string; masterAccountId: string; provider: "ZENUS" }
                  | null;
              deletedAt: Date | null;
              id: string;
              name: string | null;
              providerId: string;
              providerName: string;
              providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "ZENUS" | "MANUAL";
              providerTypeDescription: string;
              referenceId: string | null;
              routingNumber: string;
              rtpDepositInstructions: RtpDepositInstructions | null;
              status: "PENDING" | "ACTIVE" | "FAILED" | "INACTIVE";
              statusDescription: string;
              swiftDepositInstructions:
                  | (
                      | Omit<UsdSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                      | Omit<ForeignSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                  )[]
                  | null;
              type: "US_DEPOSIT"
              | "US_DDA";
              typeDescription: string;
              updatedAt: Date;
              walletAddress: Address;
              wireDepositInstructions: UsWireDepositInstructions | null;
          } & { customerId: string; entityId: string; ledgerAccountId: string };
      }
      | { error: ServiceError; ok: false },
  >

  Mints under the FBO and program the resolved placement route names.

  Parameters

  • args: {
        customerId: string;
        ledgerAccountId: string;
        name?: string;
        referenceId?: string | null;
    }

  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;
                  }
                  | { accountId?: string; masterAccountId: string; provider: "ZENUS" }
                  | null;
              deletedAt: Date | null;
              id: string;
              name: string | null;
              providerId: string;
              providerName: string;
              providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "ZENUS" | "MANUAL";
              providerTypeDescription: string;
              referenceId: string | null;
              routingNumber: string;
              rtpDepositInstructions: RtpDepositInstructions | null;
              status: "PENDING" | "ACTIVE" | "FAILED" | "INACTIVE";
              statusDescription: string;
              swiftDepositInstructions:
                  | (
                      | Omit<UsdSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                      | Omit<ForeignSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                  )[]
                  | null;
              type: "US_DEPOSIT"
              | "US_DDA";
              typeDescription: string;
              updatedAt: Date;
              walletAddress: Address;
              wireDepositInstructions: UsWireDepositInstructions | null;
          } & { customerId: string; entityId: string; ledgerAccountId: string };
      }
      | { error: ServiceError; ok: false },
  >

delete

• delete(
      args: { customerId: string; id: string },
  ): Promise<
      { error: ServiceError; ok: false }
      | { ok: true; value: undefined },
  >

  Parameters

  • args: { customerId: string; id: string }

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

update

• update(
      args: {
          customerId: string;
          id: string;
          name?: string | null;
          referenceId?: string | null;
      },
  ): 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;
                  }
                  | { accountId?: string; masterAccountId: string; provider: "ZENUS" }
                  | null;
              deletedAt: Date | null;
              id: string;
              name: string | null;
              providerId: string;
              providerName: string;
              providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "ZENUS" | "MANUAL";
              providerTypeDescription: string;
              referenceId: string | null;
              routingNumber: string;
              rtpDepositInstructions: RtpDepositInstructions | null;
              status: "PENDING" | "ACTIVE" | "FAILED" | "INACTIVE";
              statusDescription: string;
              swiftDepositInstructions:
                  | (
                      | Omit<UsdSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                      | Omit<ForeignSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                  )[]
                  | null;
              type: "US_DEPOSIT"
              | "US_DDA";
              typeDescription: string;
              updatedAt: Date;
              walletAddress: Address;
              wireDepositInstructions: UsWireDepositInstructions | null;
          } & { customerId: string; entityId: string; ledgerAccountId: string };
      }
      | { error: ServiceError; ok: false },
  >

  Parameters

  • args: {
        customerId: string;
        id: string;
        name?: string | null;
        referenceId?: string | null;
    }

  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;
                  }
                  | { accountId?: string; masterAccountId: string; provider: "ZENUS" }
                  | null;
              deletedAt: Date | null;
              id: string;
              name: string | null;
              providerId: string;
              providerName: string;
              providerType: "VICTOR" | "BIVO" | "ROUTE_FUSION" | "ZENUS" | "MANUAL";
              providerTypeDescription: string;
              referenceId: string | null;
              routingNumber: string;
              rtpDepositInstructions: RtpDepositInstructions | null;
              status: "PENDING" | "ACTIVE" | "FAILED" | "INACTIVE";
              statusDescription: string;
              swiftDepositInstructions:
                  | (
                      | Omit<UsdSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                      | Omit<ForeignSwiftWireInstructionData, "swiftField70Prefix"> & {
                          receivingEntityName: string;
                          swiftField70: SwiftField70Prefix;
                      }
                  )[]
                  | null;
              type: "US_DEPOSIT"
              | "US_DDA";
              typeDescription: string;
              updatedAt: Date;
              walletAddress: Address;
              wireDepositInstructions: UsWireDepositInstructions | null;
          } & { customerId: string; entityId: string; ledgerAccountId: string };
      }
      | { error: ServiceError; ok: false },
  >