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

    Class PhonePaymentInstrumentService

    A phone number a customer sends MOVEUSD to. APPROVED on create: the money only lands in a CFX ledger account, so there is nothing to verify.

    Hierarchy (View Summary)

    Index
    constructor
    cache db entityService instance
    create delete invalidateCache link oldestLedgerAccount searchTags update
    cache: ServiceCache<CachedSearchPage<PaymentInstrumentSearchItem>>
    db: B2bDatabase
    entityService: EntityService
    instance: (...args: []) => PhonePaymentInstrumentService = ...

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

    • Parameters

      • __namedParameters: Pick<
            {
                beneficiaryName: string
                | null;
                createdAt: Date;
                deletedAt: Date | null;
                id: string;
                linked: { entityId: string; name: string } | null;
                linkedLedgerAccountId: string | null;
                name: string;
                phone: E164Phone;
                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: "PHONE";
                typeDescription: string;
                updatedAt: Date;
            },
            "referenceId"
            | "name",
        > & { customerId: string; entityId: string; phone: string }
        • customerId: string
        • entityId: string
        • phone: string

          Any common format; one without a + is read in the owner's country.

      Returns Promise<
          | {
              ok: true;
              value: {
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  linked: { entityId: string; name: string } | null;
                  linkedLedgerAccountId: string | null;
                  name: string;
                  phone: E164Phone;
                  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: "PHONE";
                  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>

    • Links the sender's instrument for phone to the claimed ledger account. The id, owner, customer and phone must all match, so an id taken from a transfer's metadata can never link another sender's instrument.

      Parameters

      • __namedParameters: {
            customerId: string;
            entityId: string;
            id: string;
            ledgerAccountId: string;
            phone: string;
        }
        • customerId: string

          The sender's customer and owner entity, from the transfer itself.

        • entityId: string
        • id: string
        • ledgerAccountId: string
        • phone: string

          The transfer's recipient phone, E.164.

      Returns Promise<
          | {
              ok: true;
              value: {
                  beneficiaryName: string
                  | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  linked: { entityId: string; name: string } | null;
                  linkedLedgerAccountId: string | null;
                  name: string;
                  phone: E164Phone;
                  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: "PHONE";
                  typeDescription: string;
                  updatedAt: Date;
              };
          }
          | { error: ServiceError; ok: false },
      >

    • The one rule create and linkWaiting both link by.

      Parameters

      • __namedParameters: { cache?: "read" | "bypass"; customerId: string; identityId: string }
        • Optionalcache?: "read" | "bypass"

          bypass straight after an account's insert, which a cached search may predate.

        • customerId: string
        • identityId: string

      Returns Promise<string | null>

    • 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[]

    • Renames the recipient. The phone is immutable: a different number is a different instrument, so only name is read from data.

      Parameters

      Returns Promise<
          | { error: ServiceError; ok: false }
          | {
              ok: true;
              value: {
                  beneficiaryName: string | null;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  linked: { entityId: string; name: string } | null;
                  linkedLedgerAccountId: string | null;
                  name: string;
                  phone: E164Phone;
                  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: "PHONE";
                  typeDescription: string;
                  updatedAt: Date;
              };
          },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods