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

    Type Alias ResolvedRoute

    type ResolvedRoute = {
        activation:
            | {
                customerId: SelectCustomer["externalId"]
                | null;
                id: string;
                type: "ADMIN" | "CUSTOMER";
                value: "APPROVE" | "DENY";
            }
            | null;
        bankAccountId: string
        | null;
        bankId: BankId | null;
        bankName: string | null;
        criteria: PinnedMatcherCriteria;
        data: ProductRouteVersionData;
        fee:
            | {
                fixedFeeAmount: BigNumber
                | null;
                id: string;
                type: "ADMIN" | "CUSTOMER";
                variableFeeBps: BigNumber | null;
            }
            | null;
        feeVisible: boolean
        | null;
        fixedFeeAmount: BigNumber | null;
        limit:
            | {
                id: string;
                limit24hMaxCount: BigNumber
                | null;
                limit24hMaxUsd: BigNumber | null;
                limit30dMaxCount: BigNumber | null;
                limit30dMaxUsd: BigNumber | null;
                limit7dMaxCount: BigNumber | null;
                limit7dMaxUsd: BigNumber | null;
                limitCalendarMonthMaxCount: BigNumber | null;
                limitCalendarMonthMaxUsd: BigNumber | null;
                transactionMaxUsd: BigNumber | null;
                transactionMinUsd: BigNumber | null;
            }
            | null;
        limit24hMaxCount: BigNumber
        | null;
        limit24hMaxUsd: BigNumber | null;
        limit30dMaxCount: BigNumber | null;
        limit30dMaxUsd: BigNumber | null;
        limit7dMaxCount: BigNumber | null;
        limit7dMaxUsd: BigNumber | null;
        limitTransactionMaxUsd: BigNumber | null;
        limitTransactionMinUsd: BigNumber | null;
        priority: number;
        productId: Product["id"];
        programId: string | null;
        reason:
            | "NO_MATCHING_RULES"
            | `SET_BY_CUSTOMER:${string}`
            | `SET_BY_ADMIN_FOR_CUSTOMER:${string}`
            | `SET_BY_ADMIN_GLOBALLY:${string}`;
        routeId: ProductRoute["id"];
        status: "ACTIVE"
        | "INACTIVE";
        variableFeeBps: BigNumber | null;
        vendorId: Vendor;
    }
    Index
    activation bankAccountId bankId bankName criteria data fee feeVisible fixedFeeAmount limit limit24hMaxCount limit24hMaxUsd limit30dMaxCount limit30dMaxUsd limit7dMaxCount limit7dMaxUsd limitTransactionMaxUsd limitTransactionMinUsd priority productId programId reason routeId status variableFeeBps vendorId
    activation:
        | {
            customerId: SelectCustomer["externalId"]
            | null;
            id: string;
            type: "ADMIN" | "CUSTOMER";
            value: "APPROVE" | "DENY";
        }
        | null
    bankAccountId: string | null

    bank_account.external_id the route version moves money through; null when it names none.

    bankId: BankId | null
    bankName: string | null

    Display name of the route's bank, resolved off the vendor's bank FK; null when the route has no bank.

    criteria: PinnedMatcherCriteria

    What the activation / fee / limit matchers saw: caller criteria, every SQL-derived field and bankId (no clock fields). JSON form — numerics are decimal strings.

    data: ProductRouteVersionData

    Per-route operational knobs (timezone, quote TTL) snapshotted from product_route_version.data. See ProductRouteVersionData.

    fee:
        | {
            fixedFeeAmount: BigNumber
            | null;
            id: string;
            type: "ADMIN" | "CUSTOMER";
            variableFeeBps: BigNumber | null;
        }
        | null

    Type Declaration

    • {
          fixedFeeAmount: BigNumber | null;
          id: string;
          type: "ADMIN" | "CUSTOMER";
          variableFeeBps: BigNumber | null;
      }
      • fixedFeeAmount: BigNumber | null
      • id: string
      • type: "ADMIN" | "CUSTOMER"

        Tier the picked fee rule lives on.

      • variableFeeBps: BigNumber | null
    • null
    feeVisible: boolean | null
    fixedFeeAmount: BigNumber | null
    limit:
        | {
            id: string;
            limit24hMaxCount: BigNumber
            | null;
            limit24hMaxUsd: BigNumber | null;
            limit30dMaxCount: BigNumber | null;
            limit30dMaxUsd: BigNumber | null;
            limit7dMaxCount: BigNumber | null;
            limit7dMaxUsd: BigNumber | null;
            limitCalendarMonthMaxCount: BigNumber | null;
            limitCalendarMonthMaxUsd: BigNumber | null;
            transactionMaxUsd: BigNumber | null;
            transactionMinUsd: BigNumber | null;
        }
        | null

    Type Declaration

    • {
          id: string;
          limit24hMaxCount: BigNumber | null;
          limit24hMaxUsd: BigNumber | null;
          limit30dMaxCount: BigNumber | null;
          limit30dMaxUsd: BigNumber | null;
          limit7dMaxCount: BigNumber | null;
          limit7dMaxUsd: BigNumber | null;
          limitCalendarMonthMaxCount: BigNumber | null;
          limitCalendarMonthMaxUsd: BigNumber | null;
          transactionMaxUsd: BigNumber | null;
          transactionMinUsd: BigNumber | null;
      }
      • id: string
      • limit24hMaxCount: BigNumber | null
      • limit24hMaxUsd: BigNumber | null
      • limit30dMaxCount: BigNumber | null
      • limit30dMaxUsd: BigNumber | null
      • limit7dMaxCount: BigNumber | null
      • limit7dMaxUsd: BigNumber | null
      • limitCalendarMonthMaxCount: BigNumber | null

        Calendar-month max transaction count.

      • limitCalendarMonthMaxUsd: BigNumber | null

        Calendar-month max in USD; resets at local midnight on the 1st of each month in the product's cutoffTimezone.

      • transactionMaxUsd: BigNumber | null
      • transactionMinUsd: BigNumber | null
    • null
    limit24hMaxCount: BigNumber | null
    limit24hMaxUsd: BigNumber | null
    limit30dMaxCount: BigNumber | null
    limit30dMaxUsd: BigNumber | null
    limit7dMaxCount: BigNumber | null
    limit7dMaxUsd: BigNumber | null
    limitTransactionMaxUsd: BigNumber | null
    limitTransactionMinUsd: BigNumber | null
    priority: number
    productId: Product["id"]
    programId: string | null

    program.external_id of the route version: the account's program, or a sub-account provider's. The version's matcher carries a programIds clause on it, so a placement resolved here holds a grant on it.

    reason:
        | "NO_MATCHING_RULES"
        | `SET_BY_CUSTOMER:${string}`
        | `SET_BY_ADMIN_FOR_CUSTOMER:${string}`
        | `SET_BY_ADMIN_GLOBALLY:${string}`
    routeId: ProductRoute["id"]
    status: "ACTIVE" | "INACTIVE"
    variableFeeBps: BigNumber | null
    vendorId: Vendor

    External id of the vendor that produced this resolution (product_vendor.external_id) — dart, route_fusion, metcap, cfx.

    This is the dispatch key for anything downstream that must act on which vendor won, and bankId is not a substitute: bank_id is NULL on every vendor that fronts banks rather than being one, so a bankId-only branch cannot separate route_fusion from cfx from self_custody and silently treats all of them as its default case.

    Never null — the vendor join is INNER, because a route without a vendor cannot be resolved at all.

    Settings
    Member Visibility

    On This Page
    Properties