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

    Type Alias TransactionSearchArgs

    Args for TransactionQueryService.search.

    type TransactionSearchArgs = {
        amount?: { operator: "EQ" | "LTE" | "GTE"; value: BigNumber };
        anyOf?: TransactionSearchFilters["anyOf"];
        bankIds?: Transaction["bankId"][];
        bankTransactionIds?: Transaction["bankTransactionId"][];
        cardIds?: string[];
        createdAt?: DbTimestampCriteria;
        customerId: Customer["id"];
        dataSources?: Transaction["dataSource"][];
        entityIds?: Transaction["entityId"][];
        entityTypes?: NonNullable<Transaction["entityType"]>[];
        ids?: Transaction["id"][];
        inBalance?: TransactionSearchFilters["inBalance"];
        keys?: string[];
        ledgerAccountIds?: TransactionSearchFilters["ledgerAccountIds"];
        methods?: Transaction["method"][];
        orderBy?: TransactionOrderBy[];
        page?: number;
        pageSize?: number;
        paymentInstrumentIds?: Transaction["paymentInstrumentId"][];
        query?: string;
        signatures?: string[];
        statuses?: Transaction["status"][];
        subtypes?: Transaction["subType"][] | null;
        subtypesExclude?: NonNullable<Transaction["subType"]>[];
        types?: Transaction["type"][];
        updatedAt?: DbTimestampCriteria;
        walletAddresses?: Transaction["walletAddress"][];
        window?: { after?: number; before?: number; key: string };
    }
    Index
    amount? anyOf? bankIds? bankTransactionIds? cardIds? createdAt? customerId dataSources? entityIds? entityTypes? ids? inBalance? keys? ledgerAccountIds? methods? orderBy? page? pageSize? paymentInstrumentIds? query? signatures? statuses? subtypes? subtypesExclude? types? updatedAt? walletAddresses? window?
    amount?: { operator: "EQ" | "LTE" | "GTE"; value: BigNumber }
    anyOf?: TransactionSearchFilters["anyOf"]

    See TransactionSearchFilters.anyOf.

    bankIds?: Transaction["bankId"][]
    bankTransactionIds?: Transaction["bankTransactionId"][]
    cardIds?: string[]
    createdAt?: DbTimestampCriteria
    customerId: Customer["id"]
    dataSources?: Transaction["dataSource"][]

    Filter by the producing arm. Prunes the UNION exactly, where methods only narrows it — a BLOCKCHAIN filter keeps four arms.

    entityIds?: Transaction["entityId"][]
    entityTypes?: NonNullable<Transaction["entityType"]>[]
    ids?: Transaction["id"][]
    inBalance?: TransactionSearchFilters["inBalance"]

    See TransactionSearchFilters.inBalance.

    keys?: string[]

    Filter by the computed unique-identity Transaction.key (id-type-subType). Matches raw_rows.key. Kept in lockstep with TransactionAdminSearchArgs.keys.

    ledgerAccountIds?: TransactionSearchFilters["ledgerAccountIds"]

    See TransactionSearchFilters.ledgerAccountIds.

    methods?: Transaction["method"][]
    orderBy?: TransactionOrderBy[]

    Defaults to createdAt DESC. Ties break on key, in the last criterion's direction.

    Optionalpage

    page?: number

    Defaults to 1

    pageSize?: number

    Defaults to 10

    paymentInstrumentIds?: Transaction["paymentInstrumentId"][]
    query?: string

    Unified free-text search: case-insensitive substring match across transaction id, signature, bank transaction id, payment instrument id, card id, customer id/name, entity id/name/email, organization id, wallet address, account name/id, counterparty name, description, and other-wallet fields. Whitespace-only values are a no-op.

    signatures?: string[]
    statuses?: Transaction["status"][]
    subtypes?: Transaction["subType"][] | null

    Pass values to include only those subtypes; pass null to exclude transactions with a subtype

    subtypesExclude?: NonNullable<Transaction["subType"]>[]

    Drops rows with these subtypes; main legs (no subtype) stay.

    types?: Transaction["type"][]
    updatedAt?: DbTimestampCriteria
    walletAddresses?: Transaction["walletAddress"][]
    window?: { after?: number; before?: number; key: string }

    Cursor window around a specific row. When set, SUPERSEDES page/ pageSize and returns the contiguous slice of THIS query's result set (same filters/conditions AND same orderBy): before rows preceding the anchor + the anchor row + after rows following it. The anchor is the row whose computed Transaction.key equals window.key. Works for any orderBy (a key tiebreak makes the order total). Unknown key → empty result. hasNext is always false on the window path. before/after default to 10.

    Settings
    Member Visibility

    On This Page
    Properties