PayFanout API reference
    Preparing search index...

    Interface CredentialFieldDescriptor

    interface CredentialFieldDescriptor {
        format?: { hint?: string; pattern?: string };
        key: string;
        kind: "secret" | "public";
        perCurrency?: boolean;
        required?: boolean;
        scope: "server" | "client";
    }
    Index
    format? key kind perCurrency? required? scope
    format?: { hint?: string; pattern?: string }

    Shape hints for input validation and help text.

    Type Declaration

    • Optionalhint?: string

      Human hint (e.g. "Base64 single-use-token key, not the raw key password").

    • Optionalpattern?: string

      Regex source a host can test the input against (e.g. "^pk_").

    key: string

    The credential a host collects — usually the adapter config key it maps to (e.g. "secretKey", "publishableKey"), but may be a descriptive name for a value the constructor takes differently (Paysafe's per-currency merchant account is a resolver function, surfaced here as "merchantAccount").

    kind: "secret" | "public"

    Storage/redaction guidance: a secret value must never be redisplayed.

    perCurrency?: boolean

    True for values that vary per currency/account (Paysafe merchant accounts).

    required?: boolean

    Absent means required; false marks an optional field (a webhook id, a pinned version).

    scope: "server" | "client"

    Where the value is consumed — a client field ships to the browser.

    Settings
    Member Visibility

    On This Page
    Properties