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

    Interface BalanceResult

    Optional, additive fields parsers layer onto a result when the code is catalogued. resultCode/resultDesc/success are never replaced — these only ADD a human meaning + retry/terminal hints.

    interface BalanceResult {
        balances: AccountBalanceEntry[];
        catalogued?: boolean;
        conversationId: string;
        meaning?: string;
        originatorConversationId: string;
        resultCode: number;
        resultDesc: string;
        retriable?: boolean;
        success: boolean;
        terminal?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    balances catalogued? conversationId meaning? originatorConversationId resultCode resultDesc retriable? success terminal?

    Properties

    balances: AccountBalanceEntry[]
    catalogued?: boolean

    True when the (scope, resultCode) pair is in the proven catalog.

    conversationId: string
    meaning?: string

    Catalogued, actionable meaning (or Safaricom's text); undefined if unproven.

    originatorConversationId: string
    resultCode: number
    resultDesc: string
    retriable?: boolean
    success: boolean
    terminal?: boolean

    Settings

    Member Visibility

    On This Page

    Properties