B2C Payments

Send a payout

await mpesa.b2c.send({
  recipientPhone: "254712345678",
  amount: 500,
  resultUrl: "https://example.com/mpesa/b2c/result",
  queueTimeOutUrl: "https://example.com/mpesa/b2c/timeout",
  remarks: "Partner settlement",
  occasion: "March payout",
});

Notes

• commandId defaults to BusinessPayment.
• You can override it with SalaryPayment or PromotionPayment.
• Treat the synchronous API response as submission acknowledgment only. Final status arrives through the result URL.

Required config

• shortCode
• initiatorName
• securityCredential