Flutter Mpesa #

A Flutter package that provides easy integration with the M-Pesa Daraja API for handling money transactions.

Features #

• Secure and convenient integration with the M-Pesa Daraja API.

• Authorization - generate M-pesa daraja api token

• Dynamic QR

• Mpess Express (Lipa Na Mpesa)

• CustomerToBusiness (C2B)

• BusinessToCustomer (B2C)

• Transaction Status

• Account Balance

• Reversals

• Tax Remittance

• Error handling and response parsing for seamless API interactions.

• Supports both production and sandbox (testing) environments.

Installation #

dart pub add flutter_mpesa

Requirements #

Android #

See the required device permissions from the AndroidManifest.xml file.

<manifest>
  ...
  <uses-permission android:name="android.permission.INTERNET" />
  ...
</manifest>

Using #

initialization #

Initialize the M-Pesa Daraja API with your credentials:

void main() {

FlutterMpesa.passConsumerCredentials(
    consumerKey: "[CUSTOMER KEY IN M-PESA DARAJA]",
    consumerSecret: "[CUSTOMER SECRET IN M-PESA DARAJA]",
    securityCredential: "[SECURITY CREDENTIAL IN M-PESA DARAJA]",
  );

  runApp(const MyApp());
}

Access Token #

Generate access token using this method, make sure you have correctly specified and initialized customerKey, consumerSecret and securityCredential provided by M-pesa Daraja API otherwise an exception will be thrown.

NOTE : YOU DON'T HAVE TO CALL THIS METHOD EVERY TIME YOU USE OTHER METHODS, I ALREADY DID THAT FOR INDIVIDUAL METHODS.

ElevatedButton(
    onPressed: () {
        FlutterMpesa.accessToken().then((value) {
            print(value);
        });
    },
    child: const Text("ACCESS TOKEN"),
),

Dynamic QR #

When correctly impelemeted, this method will return the QR code's data which you will use any qr code viewer package to display it.

ElevatedButton(
    onPressed: () {
        FlutterMpesa.generateQR(
        merchantName: "[MERCHANT NAME]",
        amount: "[AMOUNT]",
        referenceNumber: "[RREFERENCE NUMBER]",
        creditPartyIdentifier: "[CPI]",
        qrTransactionType: ['QRTransactionType'],
        size: 300,
        ).then((value) {
            print(value);
            setState(() {
                qrText = value['qrcode'];
            });
        });
    },
    child: const Text("GENERATE QR CODE"),
),

QR Transaction Type

enum QRTransactionType {
  //Pay Merchant (Buy Goods)
  bg,
  //Withdraw Cash at Agent Till
  wa,
  //Paybill or Business number
  pb,
  //Send Money(Mobile number)
  sm,
  //Sent to Business. Business number CPI in MSISDN format
  sb,
}

M-PESA Express (Lipa Na M-pesa) #

Request Parameter Description

  ElevatedButton(
        onPressed: () {
            FlutterMpesa.lipaNaMpesa(
            businessShortCode: "174379",
            phoneNumber: "254706733999",
            amount: "1",
            callBackUrl: "https://mydomain.com/path",
            passKey: "YOUR PASS KEY",
            accountReference: "EIJI",
            transactionDescription: "transactionDescription",
            // accountNumber: '24356',
            ).then((value) => print(value));
        },
        child: const Text("MPESA EXPRESS (LIPA NA MPESA)"),
),

CustomerToBusiness (C2B) #

Request Parameter Description

ElevatedButton(
    onPressed: () {
        FlutterMpesa.customerToBusinessRegisterUrl(
        businessShortCode: "[BUSINESS SHORT CODE]",
        c2bRegisterUrlResponseType:
            ['C2BRegisterUrlResponseType'],
        confirmationUrl: "https://mydomain.com/confirmation",
        validationUrl: "https://mydomain.com/validation",
        ).then((value) => print(value));
    },
    child: const Text("CUSTOMER TO BUSINESS REGISTER URL"),
),

C2B RegisterUrl Response Type

C2BRegisterUrlResponseType.compeleted,
C2BRegisterUrlResponseType.cancelled,

BusinessToCustomer (B2C) #

ElevatedButton(
    onPressed: () {
        FlutterMpesa.businessToCustomer(
        businessShortCode: "[BUSINESS SHORT CODE]",
        recipientPhoneNumber: "[RECEIPENT PHONE NUMBER]",
        amount: "1",
        b2cPaymentType: B2CPaymentType.salaryPayment,
        initiatorName: "[INITIATOR NAME]",
        queueTimeOutUrl: "https://mydomain.com/b2c/queue",
        resultUrl: "https://mydomain.com/b2c/result",
        remarks: "remarks",
        occassion: "occassion",
        ).then((value) => print(value));
    },
    child: const Text("BUSINESS TO CUSTOMER"),
),

Transaction Status #

  ElevatedButton(
    onPressed: () {
        FlutterMpesa.transactionStatus(
        initiator: "[INITIATOR]",
        transactionId: "[TRANSACTION ID]",
        partyA: "[PARTY Q]",
        transactionStatusIdentifierType:
            ['TransactionStatusIdentifierType'],
        queueTimeOutUrl:
            'https://mydomain.com/TransactionStatus/queue/',
        resultUrl: 'https://mydomain.com/TransactionStatus/result/',
        occassion: 'occassion',
        remarks: 'OK',
        ).then((value) => print(value));
    },
    child: const Text("TRANSACTION STATUS"),
),

READ MORE HERE

Contributing #

Contributions are welcome! If you find any bugs or want to add new features, feel free to submit issues or pull requests.

Acknowledgements #

This package is inspired by the M-PESA DARAJA API API provided by Safaricom Limited.