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

    Interface ReversalResult

    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 ReversalResult {
        catalogued?: boolean;
        conversationId: string;
        meaning?: string;
        originatorConversationId: string;
        params: Record<string, unknown>;
        resultCode: number;
        resultDesc: string;
        retriable?: boolean;
        settledByRecipientSpend?: boolean;
        success: boolean;
        terminal?: boolean;
        transactionId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    catalogued? conversationId meaning? originatorConversationId params resultCode resultDesc retriable? settledByRecipientSpend? success terminal? transactionId

    Properties

    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
    params: Record<string, unknown>
    resultCode: number
    resultDesc: string
    retriable?: boolean
    settledByRecipientSpend?: boolean

    True when a failure's resultDesc indicates the recipient already spent the funds (no stable code — keyword heuristic). When set, the reversal won't succeed; treat the original as settled.

    success: boolean
    terminal?: boolean
    transactionId: string

    Settings

    Member Visibility

    On This Page

    Properties