Flutter移动支付插件flutter_mpesa_stk的使用

一个Flutter插件，允许你通过daraja API轻松执行Lipa Na M-Pesa STK推送。

功能

Mpesa STK推送（目前仅支持通过PayBill进行）

开始使用

你可以从以下链接获取特定变量：

• Safaricom Daraja开发者门户
• 在"MyApp页面"创建一个开发者账户，并创建一个应用。
  • 消费者密钥
  • 消费者密钥

然后在Mpesa模拟页面获取MpesaExpress密码以用于STK推送。

• STK密码

这些值用于使用Mpesa STK服务。

• 消费者密钥
• 消费者密钥
• STK密码
• 短代码
• 回调URL

要了解更多关于Daraja的信息以及如何准备生产就绪的应用，请阅读此文档。

使用示例

安装最新版本的包：

flutter pub get flutter_mpesa_stk

以下是一个使用mpesa stk的示例：

import 'package:flutter_mpesa_stk/flutter_mpesa_stk.dart';
import 'package:flutter_mpesa_stk/models/Mpesa.dart';
import 'package:flutter_mpesa_stk/models/MpesaResponse.dart';

// 这里替换为你的实际参数
String consumerKey = "your_consumer_key";
String consumerSecret = "your_consumer_secret";
String stkPassword = "your_stk_password";
String shortCode = "174379"; // 这个是测试用的PayBill
String callbackURL = "https://94f9-41-90-65-205.ngrok-free.app/api/secret-url/callback";

MpesaResponse response = await FlutterMpesaSTK(
  consumerKey,
  consumerSecret,
  stkPassword,
  shortCode,
  callbackURL,
  "default Message", // 可选参数
  env: "production" // 可选参数
).stkPush(
  Mpesa(
    100, // 金额
    "2547XXXXXXXXX", // 手机号码
    accountReference: "reference", // 可选参数
    transactionDesc: "description" // 可选参数
);

if (response.status) {
  // 响应体包含成功或失败的信息
  print(response.body);
  notify("成功的STK推送。请输入PIN");
} else {
  // 根据响应处理错误
  print(response.body);
  notify("失败。请重试");
}

完整示例代码

以下是完整的示例代码，展示了如何在Flutter应用中集成M-Pesa STK插件：

import 'package:flutter/material.dart';
import 'package:flutter_mpesa_stk/flutter_mpesa_stk.dart';
import 'package:flutter_mpesa_stk/models/Mpesa.dart';
import 'package:flutter_mpesa_stk/models/MpesaResponse.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Mpesa STK 插件演示',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Mpesa STK 插件演示'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final amountController = TextEditingController();
  final phoneNumberController = TextEditingController();

  [@override](/user/override)
  void dispose() {
    amountController.dispose();
    phoneNumberController.dispose();
  }

  bool loading = false;
  void setLoading(bool value) {
    setState(() {
      loading = value;
    });
  }

  void notify(String message) {
    ScaffoldMessenger.of(context)
        .showSnackBar(SnackBar(content: Text(message)));
  }

  processSTK() async {
    if (loading) {
      return;
    }
    setLoading(true);
    int amount = 0;
    try {
      amount = int.parse(amountController.value.text);
    } catch (e) {
      setLoading(false);
      notify("输入有效的金额");
      return;
    }

    if (amount < 0) {
      notify("输入有效的金额");
      setLoading(false);
      return;
    }

    MpesaResponse response = await FlutterMpesaSTK(
      "your_consumer_key",
      "your_consumer_secret",
      "your_stk_password",
      "174379", // 短代码
      "https://94f9-41-90-65-205.ngrok-free.app/api/secret-url/callback",
      "默认消息"
    ).stkPush(
      Mpesa(
        amount,
        phoneNumberController.value.text,
        accountReference: "reference",
        transactionDesc: "description"
      )
    );

    if (response.status) {
      print(response.body);
      notify("成功的STK推送。请输入PIN");
    } else {
      print(response.body);
      notify("失败。请重试");
    }
    setLoading(false);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Container(
        padding: const EdgeInsets.all(12),
        child: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              const Text(
                '点击按钮触发STK推送',
                style: TextStyle(fontWeight: FontWeight.w600, fontSize: 22),
              ),
              const SizedBox(
                height: 12,
              ),
              TextField(
                controller: amountController,
                decoration: const InputDecoration(
                  border: OutlineInputBorder(),
                  labelText: '输入M-Pesa金额 *',
                  hintText: '金额',
                ),
              ),
              const SizedBox(
                height: 12,
              ),
              TextField(
                controller: phoneNumberController,
                decoration: const InputDecoration(
                  border: OutlineInputBorder(),
                  labelText: '输入电话号码 *',
                  hintText: '电话号码',
                ),
              ),
              TextButton(
                onPressed: () async {
                  if (loading) {
                    notify("正在处理");
                    return;
                  }
                  await processSTK();
                },
                child: Container(
                  padding: const EdgeInsets.all(12),
                  decoration: const BoxDecoration(
                    color: Colors.red,
                    borderRadius: BorderRadius.all(Radius.circular(8)),
                  ),
                  child: const Text(
                    "触发STK推送",
                    style: TextStyle(color: Colors.white, fontSize: 18),
                  ),
                ),
              )
            ],
          ),
        ),
      ),
    );
  }
}