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

    Class NetworkWalletPaymentInstrumentService

    Maintains a reference to a public ledger account (belongs to another customer)

    Hierarchy (View Summary)

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

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

    • An operator's edit, whoever owns the row. A new ledger account is re-checked as on create (public, not the owner's own, blacklist) and the wallet's customer and address follow it. No consumer path writes this rail.

      Parameters

      Returns Promise<
          | {
              ok: true;
              value: {
                  address: Address;
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  name?: string;
                  provider:
                      | "MX_CLABE"
                      | `chn_${string}`
                      | "LEDGER_ACCOUNT"
                      | "WIRE_DEPOSIT"
                      | "ACH_PUSH_DEPOSIT"
                      | "YELLOWCARD"
                      | "QUILTT"
                      | "VICTOR"
                      | "CFX";
                  providerId: string;
                  referenceId?: string;
                  sendEnabled: boolean;
                  status: | "DELETED"
                  | "PENDING_VERIFICATION"
                  | "ACTION_REQUIRED"
                  | "APPROVED"
                  | "BLOCKED";
                  statusDescription: string;
                  type: "NETWORK_WALLET";
                  typeDescription: string;
                  updatedAt: Date;
                  walletCustomerId: string;
              };
          }
          | { error: ServiceError; ok: false },
      >

    • Parameters

      • __namedParameters: Pick<
            {
                address: Address;
                beneficiaryName: string
                | null;
                createdAt: Date;
                deletedAt: Date | null;
                id: string;
                name?: string;
                provider:
                    | "MX_CLABE"
                    | `chn_${string}`
                    | "LEDGER_ACCOUNT"
                    | "WIRE_DEPOSIT"
                    | "ACH_PUSH_DEPOSIT"
                    | "YELLOWCARD"
                    | "QUILTT"
                    | "VICTOR"
                    | "CFX";
                providerId: string;
                referenceId?: string;
                sendEnabled: boolean;
                status: | "DELETED"
                | "PENDING_VERIFICATION"
                | "ACTION_REQUIRED"
                | "APPROVED"
                | "BLOCKED";
                statusDescription: string;
                type: "NETWORK_WALLET";
                typeDescription: string;
                updatedAt: Date;
                walletCustomerId: string;
            },
            "referenceId"
            | "name",
        > & { customerId: string; entityId: string; ledgerAccountId: string }

      Returns Promise<
          | {
              ok: true;
              value: {
                  address: Address;
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  name?: string;
                  provider:
                      | "MX_CLABE"
                      | `chn_${string}`
                      | "LEDGER_ACCOUNT"
                      | "WIRE_DEPOSIT"
                      | "ACH_PUSH_DEPOSIT"
                      | "YELLOWCARD"
                      | "QUILTT"
                      | "VICTOR"
                      | "CFX";
                  providerId: string;
                  referenceId?: string;
                  sendEnabled: boolean;
                  status: | "DELETED"
                  | "PENDING_VERIFICATION"
                  | "ACTION_REQUIRED"
                  | "APPROVED"
                  | "BLOCKED";
                  statusDescription: string;
                  type: "NETWORK_WALLET";
                  typeDescription: string;
                  updatedAt: Date;
                  walletCustomerId: string;
              };
          }
          | { 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[]

    • The customer's edit: display name and reference only. The target ledger account is fixed once created; an operator moves it with adminUpdate.

      Parameters

      Returns Promise<
          | {
              ok: true;
              value: {
                  address: Address;
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  name?: string;
                  provider:
                      | "MX_CLABE"
                      | `chn_${string}`
                      | "LEDGER_ACCOUNT"
                      | "WIRE_DEPOSIT"
                      | "ACH_PUSH_DEPOSIT"
                      | "YELLOWCARD"
                      | "QUILTT"
                      | "VICTOR"
                      | "CFX";
                  providerId: string;
                  referenceId?: string;
                  sendEnabled: boolean;
                  status: | "DELETED"
                  | "PENDING_VERIFICATION"
                  | "ACTION_REQUIRED"
                  | "APPROVED"
                  | "BLOCKED";
                  statusDescription: string;
                  type: "NETWORK_WALLET";
                  typeDescription: string;
                  updatedAt: Date;
                  walletCustomerId: string;
              };
          }
          | { error: WalletUpdateError; ok: false },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods