Mpesa

Defined in: src/clients/mpesa-client.ts:61

M-Pesa SDK client.

Single entry point for all Daraja API operations. OAuth is handled automatically; tokens are cached and refreshed before expiry.

Example

// With env vars (MPESA_CONSUMER_KEY, MPESA_CONSUMER_SECRET, etc. set):
const mpesa = new Mpesa({});

// Or with explicit config:
const mpesa = new Mpesa({
  consumerKey: "...",
  consumerSecret: "...",
  environment: "sandbox",
  shortCode: "174379",
  passKey: "...",
});

const res = await mpesa.stkPush({
  phoneNumber: "254708374149",
  amount: 10,
  callbackUrl: "https://example.com/callback",
  accountReference: "order-123",
  transactionDesc: "Payment",
});
console.log(res.CheckoutRequestID);

Constructors

Constructor

new Mpesa(config?): Mpesa

Defined in: src/clients/mpesa-client.ts:72

Parameters

config?

MpesaConfig = {}

Returns

Mpesa

Properties

account

readonly account: AccountModule

Defined in: src/clients/mpesa-client.ts:64

---

b2c

readonly b2c: B2CModule

Defined in: src/clients/mpesa-client.ts:63

---

c2b

readonly c2b: C2BModule

Defined in: src/clients/mpesa-client.ts:62

---

pull

readonly pull: PullModule

Defined in: src/clients/mpesa-client.ts:68

---

qr

readonly qr: QrModule

Defined in: src/clients/mpesa-client.ts:67

---

reversal

readonly reversal: ReversalModule

Defined in: src/clients/mpesa-client.ts:66

---

transaction

readonly transaction: TransactionModule

Defined in: src/clients/mpesa-client.ts:65

Methods

stkPush()

stkPush(input): Promise<StkPushResult>

Defined in: src/clients/mpesa-client.ts:130

Initiate STK Push (Lipa Na M-Pesa Online). Sends a prompt to the customer’s phone; use the returned CheckoutRequestID with stkQuery().

Parameters

input

StkPushInput

Returns

Promise<StkPushResult>

---

stkQuery()

stkQuery(input): Promise<StkQueryResponse>

Defined in: src/clients/mpesa-client.ts:137

Query STK Push status using CheckoutRequestID from stkPush() response.

Parameters

input

StkQueryInput

Returns

Promise<StkQueryResponse>