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

    Class ExternalUsAchPaymentInstrumentService

    Maintain external ACH debit payment instruments.

    These represent ACH debit originators where only the originator name is known (no account/routing number).

    Hierarchy (View Summary)

    Index
    constructor
    cache instance
    adminUpdate create delete invalidateCache searchTags upsert
    cache: ServiceCache<CachedSearchPage<PaymentInstrumentSearchItem>>
    instance: (...args: []) => ExternalUsAchPaymentInstrumentService = ...

    The process default: built from each dependency's own instance().

    • An operator's edit, whoever owns the row. A new originatorName moves the derived providerId and is re-checked against the blacklist. No consumer path writes this rail.

      Parameters

      Returns Promise<
          | {
              ok: true;
              value: {
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  originatorName: string;
                  provider: "CFX";
                  providerId: string;
                  referenceId?: string;
                  sendEnabled: boolean;
                  status:
                      | "DELETED"
                      | "PENDING_VERIFICATION"
                      | "ACTION_REQUIRED"
                      | "APPROVED"
                      | "BLOCKED";
                  statusDescription: string;
                  type: "EXTERNAL_US_ACH";
                  typeDescription: string;
                  updatedAt: Date;
              };
          }
          | { error: ServiceError; ok: false },
      >

    • Parameters

      • __namedParameters: {
            customerId: string;
            entityId: string;
            originatorName: string;
            referenceId?: string;
        }

      Returns Promise<
          | {
              ok: true;
              value: {
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  originatorName: string;
                  provider: "CFX";
                  providerId: string;
                  referenceId?: string;
                  sendEnabled: boolean;
                  status:
                      | "DELETED"
                      | "PENDING_VERIFICATION"
                      | "ACTION_REQUIRED"
                      | "APPROVED"
                      | "BLOCKED";
                  statusDescription: string;
                  type: "EXTERNAL_US_ACH";
                  typeDescription: string;
                  updatedAt: Date;
              };
          }
          | { error: ServiceError; ok: false },
      >

    • Also clears payment-instrument.text. Every writer busts by customer alone, which reaches no field tag, yet each write may change the text a cached transaction q page matched on.

      Parameters

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

      Returns Promise<void>

    • Tags for a page: the scope its query searched (each customer's membership tag, else the collection tag), so an empty page is bustable too, plus the records it projects and the fields that chose or ordered its rows.

      Parameters

      • __namedParameters: {
            customerIds: readonly string[] | undefined;
            fields?: readonly string[];
            records?: readonly string[];
        }

      Returns string[]

    • Create the instrument if it doesn't exist, otherwise return the existing one.

      Parameters

      • args: {
            customerId: string;
            entityId: string;
            originatorName: string;
            referenceId?: string;
        }

      Returns Promise<
          | {
              ok: true;
              value: {
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  originatorName: string;
                  provider: "CFX";
                  providerId: string;
                  referenceId?: string;
                  sendEnabled: boolean;
                  status:
                      | "DELETED"
                      | "PENDING_VERIFICATION"
                      | "ACTION_REQUIRED"
                      | "APPROVED"
                      | "BLOCKED";
                  statusDescription: string;
                  type: "EXTERNAL_US_ACH";
                  typeDescription: string;
                  updatedAt: Date;
              };
          }
          | { error: ServiceError; ok: false },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods