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

    Class UsAchPaymentInstrumentService

    Maintain the account details for sending payments via Automated Clearing House.

    Hierarchy (View Summary)

    Index
    constructor
    cache
    create delete invalidateCache searchTags update deserializePaymentInstrument serializePaymentInstrument
    cache: ServiceCache<CachedSearchPage<CachedPaymentInstrumentSearchItem>>

    • Parameters

      • input: Input

      Returns Promise<
          | {
              ok: true;
              value: {
                  accountHolderName: string;
                  accountName: string;
                  accountNumber: string;
                  accountType: "CHECKING"
                  | "SAVING";
                  bankName?: string;
                  beneficiaryAddress?: {
                      city: string;
                      countryCode: string;
                      line1: string;
                      line2?: string;
                      postalCode: string;
                      region?: string;
                  };
                  createdAt: Date;
                  deletedAt: Date
                  | null;
                  id: string;
                  provider: "CFX" | "QUILTT";
                  providerId: string;
                  quilttData?: QuilttAccountData & { quilttConnectionId: string };
                  referenceId?: string;
                  routeFusionBeneficiaryId?: string;
                  routingNumber: string;
                  status: "ACTIVE" | "BLOCKED" | "DELETED" | "PENDING_VERIFICATION";
                  type: "US_ACH";
                  updatedAt: Date;
                  victorCounterpartyId?: string;
              };
          }
          | {
              error: | ServiceError<"PAYMENT_INSTRUMENT_DUPLICATE">
              | UsAchPaymentInstrumentValidateError;
              ok: false;
          },
      >

    • Bust every cached page — consumer or admin — that a write touching customerIds could have affected.

      The collection tag is always cleared alongside, because an unscoped admin page carries only that tag and no customer id can reach it.

      keys deletes exact entries in addition to the tag surgery, passing the key arguments — this cache hashes and prefixes them. It exists because invalidateTag resolves keys through the FT index, which does not exist in memory mode (valkeyClient: null); there the tag bust is a total no-op, and an exact-key delete is the only thing that keeps read-after-write honest. Services that folded get onto search pass that get's arguments.

      These deletes only reach this instance's own key space, because the key space is partitioned per surface. That is sufficient, and a writer must not try to name the other surface's key:

      • With Valkey, the other surface's get entry is itself tagged (by customer id, or by the collection tag when unscoped), so the tag bust above already evicts it from the shared L2 and publishes the peer eviction.
      • Without Valkey, the two surfaces are separate instances with separate L1 maps, so deleting a key from this instance could never have affected the other one anyway.

      Parameters

      • __namedParameters: { customerIds: readonly string[]; keys?: readonly CacheKey[] }

      Returns Promise<void>

    • Tags to write on a page, derived from the scope the query searched — never from the customers present in the result.

      That distinction is load-bearing. An entry tagged with the customer ids in the page carries no tags when the page is empty, so nothing can ever bust it and a later create leaves it stale for the full L2 TTL. Tagging by scope means an empty page still carries the tag for what it searched.

      An unscoped read falls back to the collection tag, since no customer-id tag can reach a row whose owner did not exist when the entry was written.

      Parameters

      • __namedParameters: { customerIds: readonly string[] | undefined }

      Returns string[]

    • Merge data into an existing instrument. Every field is optional — an absent key is left untouched, so a caller wanting to change only the account holder's name sends only that.

      The owning entity is read off the row, not supplied: it is what the capability check and the derived providerId are built from, and an instrument cannot move between entities.

      Parameters

      • __namedParameters: {
            customerId: string;
            data: Partial<
                Pick<
                    UsAchPaymentInstrument,
                    | "accountName"
                    | "accountHolderName"
                    | "accountNumber"
                    | "routingNumber"
                    | "accountType"
                    | "beneficiaryAddress"
                    | "bankName"
                    | "quilttData",
                > & { referenceId: UsAchPaymentInstrument["referenceId"]
                | null },
            >;
            id: string;
        }

      Returns Promise<
          | {
              ok: true;
              value: {
                  accountHolderName: string;
                  accountName: string;
                  accountNumber: string;
                  accountType: "CHECKING"
                  | "SAVING";
                  bankName?: string;
                  beneficiaryAddress?: {
                      city: string;
                      countryCode: string;
                      line1: string;
                      line2?: string;
                      postalCode: string;
                      region?: string;
                  };
                  createdAt: Date;
                  deletedAt: Date
                  | null;
                  id: string;
                  provider: "CFX" | "QUILTT";
                  providerId: string;
                  quilttData?: QuilttAccountData & { quilttConnectionId: string };
                  referenceId?: string;
                  routeFusionBeneficiaryId?: string;
                  routingNumber: string;
                  status: "ACTIVE" | "BLOCKED" | "DELETED" | "PENDING_VERIFICATION";
                  type: "US_ACH";
                  updatedAt: Date;
                  victorCounterpartyId?: string;
              };
          }
          | {
              error: | UsAchPaymentInstrumentValidateError
              | ServiceError<
                  | "PAYMENT_INSTRUMENT_DUPLICATE"
                  | "NO_UPDATE"
                  | "PAYMENT_INSTRUMENT_NOT_FOUND",
              >;
              ok: false;
          },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods