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

    Class PaymentInstrumentQueryService

    Query payment instruments across supported types

    Hierarchy (View Summary)

    Index
    constructor
    cache db instance
    get invalidateCache search searchTags
    cache: ServiceCache<CachedSearchPage<PaymentInstrumentSearchItem>>
    db: B2bDatabase
    instance: (...args: []) => PaymentInstrumentQueryService = ...

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

    • Get instrument by ID or reference ID

      It can be further narrowed down by type and entity ID.

      Parameters

      • __namedParameters: {
            customerId: string;
            deleted?: boolean;
            entityId?: string;
            type?:
                | "AF_BANK"
                | "AF_MOMO"
                | "EXTERNAL_US_ACH"
                | "MX_CLABE"
                | "NETWORK_WALLET"
                | "PHONE"
                | "SWIFT_WIRE"
                | "US_ACH"
                | "US_WIRE"
                | "US_INSTANT"
                | "WALLET";
        } & ({ id: string } | { referenceId: string })

      Returns Promise<{ ok: true; value: PaymentInstrumentSearchItem | null }>

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

    • Parameters

      • __namedParameters: {
            bankIds?: string[];
            createdAt?: DbTimestampCriteria;
            customerId: string;
            deleted?: boolean;
            entityIds?: string[];
            ids?: string[];
            linked?: boolean;
            nameLike?: string;
            nominisWalletScreenRequestIds?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                accountHolderName: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                accountName: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                beneficiaryName: PgBuildColumn<
                                    "payment_instrument",
                                    SetHasGenerated<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: true;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                createdAt: PgBuildColumn<
                                    "payment_instrument",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                customerExternalId: PgBuildColumn<
                                    "payment_instrument",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "payment_instrument",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                deletedAt: PgBuildColumn<
                                    "payment_instrument",
                                    PgTimestampBuilder,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "payment_instrument",
                                    SetHasRuntimeDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "payment_instrument",
                                    HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                identityExternalId: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                identityId: PgBuildColumn<
                                    "payment_instrument",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                instrumentData: PgBuildColumn<
                                    "payment_instrument",
                                    SetNotNull<PgJsonbBuilder>,
                                    {
                                        data: unknown;
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                linkedLedgerAccountId: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                organizationExternalId: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                organizationId: PgBuildColumn<
                                    "payment_instrument",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                provider: PgBuildColumn<
                                    "payment_instrument",
                                    SetNotNull<Set$Type<(...), (...)>>,
                                    {
                                        data:
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                providerId: PgBuildColumn<
                                    "payment_instrument",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                referenceId: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                searchDocument: PgBuildColumn<
                                    "payment_instrument",
                                    SetHasGenerated<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: true;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                searchDocumentAdmin: PgBuildColumn<
                                    "payment_instrument",
                                    SetHasGenerated<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: true;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                sendEnabled: PgBuildColumn<
                                    "payment_instrument",
                                    SetNotNull<PgBooleanBuilder>,
                                    {
                                        data: boolean;
                                        dataType: "boolean";
                                        driverParam: boolean;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                status: PgBuildColumn<
                                    "payment_instrument",
                                    Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...) | (...)>,
                                    {
                                        data: (...) | (...) | (...) | (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                type: PgBuildColumn<
                                    "payment_instrument",
                                    Set$Type<
                                        SetNotNull<(...)>,

                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...),
                                    >,
                                    {
                                        data:
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "payment_instrument",
                                    SetHasDefault<SetHasDefault<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                >;
                                verificationProfileId: PgBuildColumn<
                                    "payment_instrument",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                >;
                            };
                            dialect: "pg";
                            isAlias: false;
                            name: "payment_instrument";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            partialText?: string;
            providerIds?: string[];
            providers?: (
                | "MX_CLABE"
                | `chn_${string}`
                | "LEDGER_ACCOUNT"
                | "WIRE_DEPOSIT"
                | "ACH_PUSH_DEPOSIT"
                | "YELLOWCARD"
                | "QUILTT"
                | "VICTOR"
                | "CFX"
            )[];
            quilttConnectionIds?: string[];
            referenceIdLike?: string;
            referenceIds?: string[];
            statuses?: (
                | "DELETED"
                | "PENDING_VERIFICATION"
                | "ACTION_REQUIRED"
                | "APPROVED"
                | "BLOCKED"
            )[];
            types?: (
                | "AF_BANK"
                | "AF_MOMO"
                | "EXTERNAL_US_ACH"
                | "MX_CLABE"
                | "NETWORK_WALLET"
                | "PHONE"
                | "SWIFT_WIRE"
                | "US_ACH"
                | "US_WIRE"
                | "US_INSTANT"
                | "WALLET"
            )[];
            updatedAt?: DbTimestampCriteria;
            verificationProfileIds?: string[];
        }
        • OptionalbankIds?: string[]

          Instruments used in a deposit or withdrawal at one of these banks: a per-row check, so a search with it is not cached (no write to a transaction busts this cache).

        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • Optionaldeleted?: boolean
        • OptionalentityIds?: string[]
        • Optionalids?: string[]
        • Optionallinked?: boolean

          PHONE recipients with (true) or still without (false) a linked ledger account.

        • OptionalnameLike?: string

          Partial match over the requested types' name-ish fields. Requires types.

        • OptionalnominisWalletScreenRequestIds?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              accountHolderName: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              accountName: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              beneficiaryName: PgBuildColumn<
                                  "payment_instrument",
                                  SetHasGenerated<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: true;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "payment_instrument",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              customerExternalId: PgBuildColumn<
                                  "payment_instrument",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "payment_instrument",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              deletedAt: PgBuildColumn<
                                  "payment_instrument",
                                  PgTimestampBuilder,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "payment_instrument",
                                  SetHasRuntimeDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "payment_instrument",
                                  HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: "byDefault";
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              identityExternalId: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              identityId: PgBuildColumn<
                                  "payment_instrument",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              instrumentData: PgBuildColumn<
                                  "payment_instrument",
                                  SetNotNull<PgJsonbBuilder>,
                                  {
                                      data: unknown;
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              linkedLedgerAccountId: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              organizationExternalId: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              organizationId: PgBuildColumn<
                                  "payment_instrument",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              provider: PgBuildColumn<
                                  "payment_instrument",
                                  SetNotNull<Set$Type<(...), (...)>>,
                                  {
                                      data:
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              providerId: PgBuildColumn<
                                  "payment_instrument",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              referenceId: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              searchDocument: PgBuildColumn<
                                  "payment_instrument",
                                  SetHasGenerated<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: true;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              searchDocumentAdmin: PgBuildColumn<
                                  "payment_instrument",
                                  SetHasGenerated<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: true;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              sendEnabled: PgBuildColumn<
                                  "payment_instrument",
                                  SetNotNull<PgBooleanBuilder>,
                                  {
                                      data: boolean;
                                      dataType: "boolean";
                                      driverParam: boolean;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "payment_instrument",
                                  Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...) | (...)>,
                                  {
                                      data: (...) | (...) | (...) | (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              type: PgBuildColumn<
                                  "payment_instrument",
                                  Set$Type<
                                      SetNotNull<(...)>,

                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...),
                                  >,
                                  {
                                      data:
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "payment_instrument",
                                  SetHasDefault<SetHasDefault<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                              >;
                              verificationProfileId: PgBuildColumn<
                                  "payment_instrument",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                              >;
                          };
                          dialect: "pg";
                          isAlias: false;
                          name: "payment_instrument";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]

          Ties break on the row id, in the last criterion's direction.

        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 10

        • OptionalpartialText?: string

          Partial match over referenceId plus each requested type's searchable fields. Requires types — the per-type field map is what keeps the query indexable. Field map: internal/search.ts.

        • OptionalproviderIds?: string[]

          Provider-side account identifier. Kept in lockstep with the admin surface's filter of the same name (rules/service-pattern.md).

        • Optionalproviders?: (
              | "MX_CLABE"
              | `chn_${string}`
              | "LEDGER_ACCOUNT"
              | "WIRE_DEPOSIT"
              | "ACH_PUSH_DEPOSIT"
              | "YELLOWCARD"
              | "QUILTT"
              | "VICTOR"
              | "CFX"
          )[]
        • OptionalquilttConnectionIds?: string[]
        • OptionalreferenceIdLike?: string

          Partial match over the nickname: name on wallets, referenceId otherwise. Requires types.

        • OptionalreferenceIds?: string[]
        • Optionalstatuses?: (
              | "DELETED"
              | "PENDING_VERIFICATION"
              | "ACTION_REQUIRED"
              | "APPROVED"
              | "BLOCKED"
          )[]
        • Optionaltypes?: (
              | "AF_BANK"
              | "AF_MOMO"
              | "EXTERNAL_US_ACH"
              | "MX_CLABE"
              | "NETWORK_WALLET"
              | "PHONE"
              | "SWIFT_WIRE"
              | "US_ACH"
              | "US_WIRE"
              | "US_INSTANT"
              | "WALLET"
          )[]
        • OptionalupdatedAt?: DbTimestampCriteria
        • OptionalverificationProfileIds?: string[]

          Instruments holding one of these AiPrise profiles as their beneficiary's.

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: PaymentInstrumentSearchItem[];
                  total: number;
              };
          },
      >

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods