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

    Class Daraja

    Index

    Constructors

    constructor

    Properties

    b2b b2c balance billManager bonga c2b collect config express orgInfo pull qr ratiba reversal status

    Constructors

    Properties

    b2b: {
        pay: (input: B2bPayInput) => Promise<B2bAck>;
        remitTax: (input: RemitTaxInput) => Promise<B2bAck>;
        topUp: (input: B2bTopUpInput) => Promise<B2bAck>;
        transferFloat: (input: FloatTransferInput) => Promise<B2bAck>;
    }

    B2B — pay another business, move float, top up a B2C shortcode, or remit tax.

    b2c: {
        send: (input: B2cSendInput) => Promise<B2cSendResult>;
        toPochi: (input: B2cToPochiInput) => Promise<B2cSendResult>;
    }

    B2C — disburse money to a customer phone, or to a business wallet (pochi).

    balance: { query: (input: BalanceQueryInput) => Promise<BalanceQueryResult> }

    Account balance query (read-only).

    billManager: {
        acknowledgePayment: (
            input: AcknowledgePaymentInput,
        ) => Promise<BillManagerResult>;
        cancelBulkInvoices: (
            input: CancelBulkInvoicesInput,
        ) => Promise<BillManagerResult>;
        cancelInvoice: (input: CancelInvoiceInput) => Promise<BillManagerResult>;
        optIn: (input: BillManagerOptInInput) => Promise<BillManagerOptInResult>;
        sendBulkInvoices: (
            input: SendBulkInvoicesInput,
        ) => Promise<BillManagerResult>;
        sendInvoice: (input: SendInvoiceInput) => Promise<BillManagerResult>;
        updateOptIn: (input: BillManagerOptInInput) => Promise<BillManagerResult>;
    }

    Bill Manager — invoicing + reconciliation (rescode "200", app_key header).

    bonga: {
        calculatePoints: (
            input: CalculatePointsInput,
        ) => Promise<CalculatePointsResult>;
        redeem: (input: RedeemInput) => Promise<RedeemAck>;
    }

    Lipa na Bonga — points→KES conversion (read) + redeem points as payment.

    c2b: { registerUrls: (input: RegisterUrlsInput) => Promise<RegisterUrlsResult> }

    C2B — register callback URLs for direct PayBill/Till payments.

    collect: { stkPush: (input: StkPushInput) => Promise<StkPushResult> }

    Money-in collection (STK Push, C2B).

    config: DarajaConfig
    express: {
        checkout: (input: ExpressCheckoutInput) => Promise<ExpressCheckoutAck>;
    }

    B2B Express Checkout — USSD push to a merchant's till to pay a vendor paybill.

    orgInfo: { query: (input: OrgInfoQueryInput) => Promise<OrgInfoResult> }

    Query Organization Info — validate a shortcode's name + tariff (read-only).

    pull: {
        query: (input: PullQueryInput) => Promise<PullQueryResult>;
        registerUrl: (input: PullRegisterInput) => Promise<PullRegisterResult>;
    }

    Pull Transaction API — backfill missed C2B payments (Daraja 3.0).

    qr: { generate: (input: QrGenerateInput) => Promise<QrGenerateResult> }

    Dynamic QR code generation.

    ratiba: { create: (input: RatibaCreateInput) => Promise<RatibaAck> }

    M-Pesa Ratiba — create a customer standing order (recurring collection).

    reversal: { request: (input: ReversalInput) => Promise<ReversalAck> }

    Reverse a transaction back to the payer.

    status: {
        stkPush: (input: StkStatusInput) => Promise<StkStatusResult>;
        transaction: (input: TransactionStatusInput) => Promise<StatusAck>;
    }

    Transaction status — STK Push (sync) and any transaction (async).

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties