@kepas/daraja-js
    Preparing search index...

    Interface DarajaConfig

    interface DarajaConfig {
        billManagerAppKey?: string;
        consumerKey: string;
        consumerSecret: string;
        environment: "sandbox" | "production";
        fetchImpl?: (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Promise<Response>;
        initiator?: string;
        maxNetworkRetries?: number;
        passkey: string;
        securityCredential?: string;
        shortcode: string;
        tokenStore?: TokenStore;
        transactionType?: "CustomerPayBillOnline" | "CustomerBuyGoodsOnline";
    }
    Index

    Properties

    billManagerAppKey? consumerKey consumerSecret environment fetchImpl? initiator? maxNetworkRetries? passkey securityCredential? shortcode tokenStore? transactionType?

    Properties

    billManagerAppKey?: string

    Bill Manager app_key (from billManager.optIn) — fallback for invoicing calls.

    consumerKey: string
    consumerSecret: string
    environment: "sandbox" | "production"
    fetchImpl?: (
        input: string | URL | Request,
        init?: RequestInit,
    ) => Promise<Response>

    fetch override, for tests or custom runtimes.

    initiator?: string

    Initiator name — required for B2C/B2B/balance/status/reversal.

    maxNetworkRetries?: number

    Retries on 5xx. Default 2.

    passkey: string

    Passkey for STK password derivation.

    securityCredential?: string

    RSA-encrypted initiator password (see generateSecurityCredential).

    shortcode: string

    PayBill or Till shortcode.

    tokenStore?: TokenStore

    Cross-process OAuth token cache (e.g. Redis). Defaults to per-process.

    transactionType?: "CustomerPayBillOnline" | "CustomerBuyGoodsOnline"

    STK transaction type. Defaults to PayBill.

    Settings

    Member Visibility

    On This Page

    Properties