flutter_bkash_plus 1.0.7

Flutter bKash Plus – A modern, seamless, and production-ready bKash payment gateway integration for Flutter, built and maintained by Shahed Oali Noor from CarbonCodes Limited.

example/lib/main.dart

import 'dart:developer' as dev;
import 'package:flutter/material.dart';
import 'package:flutter_bkash_plus/flutter_bkash.dart';

void main() {
  // it should be the first line in main method
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

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

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(
        primarySwatch: Colors.pink,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      debugShowCheckedModeBanner: false,
      home: const HomePage(title: 'bKash Demo'),
    );
  }
}

/// paymentType: payWithAgreement, payWithoutAgreement, createAgreement
/// enum values: as per your requirement
enum PaymentType { payWithAgreement, payWithoutAgreement, createAgreement }

class HomePage extends StatefulWidget {
  final String title;

  const HomePage({Key? key, required this.title}) : super(key: key);

  @override
  HomePageState createState() => HomePageState();
}

class HomePageState extends State<HomePage> {
  final GlobalKey<ScaffoldState> _scaffoldKey = GlobalKey<ScaffoldState>();
  final TextEditingController _amountController = TextEditingController();
  final TextEditingController _agreementIdController = TextEditingController();

  bool isLoading = false;

  PaymentType _paymentType = PaymentType.payWithoutAgreement;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      key: _scaffoldKey,
      appBar: AppBar(title: Text(widget.title)),
      body: Stack(
        children: [
          isLoading
              ? const Center(
            child: CircularProgressIndicator(
              color: Colors.pink,
            ),
          )
              : SingleChildScrollView(
            padding: const EdgeInsets.all(40),
            child: Column(
              crossAxisAlignment: CrossAxisAlignment.start,
              children: [
                if (_paymentType != PaymentType.createAgreement) ...[
                  const Text(
                    'Amount :',
                    style: TextStyle(fontWeight: FontWeight.bold),
                  ),
                  const SizedBox(
                    height: 10,
                  ),
                  TextFormField(
                    controller: _amountController,
                    decoration: const InputDecoration(
                      hintText: "1240",
                      hintStyle: TextStyle(color: Colors.grey),
                      contentPadding: EdgeInsets.symmetric(
                          horizontal: 10, vertical: 0),
                      border: OutlineInputBorder(
                          borderRadius:
                          BorderRadius.all(Radius.circular(5)),
                          borderSide: BorderSide(color: Colors.grey)),
                      focusedBorder: OutlineInputBorder(
                        borderSide:
                        BorderSide(color: Colors.pink, width: 2.0),
                      ),
                      // hintText: reviewTitle,
                    ),
                    keyboardType: TextInputType.number,
                    maxLines: 1,
                    minLines: 1,
                  ),
                  if (_paymentType == PaymentType.payWithAgreement) ...[
                    const SizedBox(
                      height: 20,
                    ),
                    const Text(
                      'AgreementID :',
                      style: TextStyle(fontWeight: FontWeight.bold),
                    ),
                    const SizedBox(
                      height: 10,
                    ),
                    TextFormField(
                      controller: _agreementIdController,
                      decoration: const InputDecoration(
                        hintText: "User Agreement Id",
                        contentPadding: EdgeInsets.symmetric(
                            horizontal: 10, vertical: 0),
                        border: OutlineInputBorder(
                            borderRadius:
                            BorderRadius.all(Radius.circular(5)),
                            borderSide: BorderSide(color: Colors.grey)),
                        focusedBorder: OutlineInputBorder(
                          borderSide:
                          BorderSide(color: Colors.pink, width: 2.0),
                        ),
                        // hintText: reviewTitle,
                      ),
                      keyboardType: TextInputType.text,
                      maxLines: 1,
                      minLines: 1,
                    ),
                  ],
                  const SizedBox(height: 20.0),
                ],
                const Divider(),
                ListTile(
                  title: const Text('Pay (without agreement)'),
                  leading: Radio(
                    value: PaymentType.payWithoutAgreement,
                    groupValue: _paymentType,
                    onChanged: (value) {
                      setState(() => _paymentType = value!);
                    },
                  ),
                  dense: true,
                ),
                ListTile(
                  title: const Text('Pay with Agreement'),
                  leading: Radio(
                    value: PaymentType.payWithAgreement,
                    groupValue: _paymentType,
                    onChanged: (value) {
                      setState(() => _paymentType = value!);
                    },
                  ),
                  dense: true,
                ),
                ListTile(
                  title: const Text('Create agreement'),
                  leading: Radio(
                    value: PaymentType.createAgreement,
                    groupValue: _paymentType,
                    onChanged: (value) {
                      setState(() => _paymentType = value!);
                    },
                  ),
                  dense: true,
                ),
                const Divider(),
                Center(
                  child: TextButton(
                    style: TextButton.styleFrom(
                        shape: RoundedRectangleBorder(
                          borderRadius: BorderRadius.circular(3.0),
                        ),
                        backgroundColor: Colors.pink),
                    child: const Text(
                      "Checkout",
                      style: TextStyle(color: Colors.white),
                    ),
                    onPressed: () async {
                      setState(() {
                        isLoading = true;
                      });

                      /// ✅ Create an instance of FlutterBkash

                      // ----------------------------
                      // 🧪 Sandbox Credentials (Default for Testing)
                      // ----------------------------
                      // No manual configuration is needed for sandbox testing.
                      // This mode uses built-in test credentials and logs API responses.
                      final flutterBkash = FlutterBkash(
                        logResponse: true, // Set to `false` in production to disable API logs
                      );

                      // ----------------------------
                      // 🚀 Live Credentials (Production Mode)
                      // ----------------------------
                      // Uncomment and configure the following to go live with your own credentials.
                      // ⚠️ NOTE: You must obtain valid production credentials from bKash directly.
                      //
                      // 💡 Tip: If you want to support the package developer, feel free to make a test payment using the live credentials below.

                      /*
                      final flutterBkash = FlutterBkash(
                        bkashCredentials: const BkashCredentials(
                          username: "01783680336", // Developer’s bKash merchant number
                          password: "nR8{^3j1Z@B", // Merchant password (provided by bKash)
                          appKey: "zuM020mk8M5BfXesMweZtiQMtc", // Live App Key
                          appSecret: "9afwkpN0tTJxIItoYwlJMlDbq8U2NMOHCFVKLTLIxtGKuNAVipzm", // Live App Secret
                          isSandbox: false, // Must be false for production/live environment
                        ),
                      );
                      */


                      /// if the payment type is createAgreement
                      if (_paymentType == PaymentType.createAgreement) {
                        try {
                          // remove focus from TextField to hide keyboard
                          FocusManager.instance.primaryFocus?.unfocus();

                          /// call createAgreement method to create an agreement as parameter pass the context
                          final result = await flutterBkash
                              .createAgreement(context: context);

                          /// show the log
                          dev.log(result.toString());

                          /// show the snack-bar
                          _showSnackbar(
                              "(Success) AgreementId: ${result.agreementId}");
                        } on BkashFailure catch (e, st) {
                          /// if any error occurred then show the log
                          dev.log(e.message, error: e, stackTrace: st);

                          /// show the snack-bar
                          _showSnackbar(e.message);
                        } catch (e, st) {
                          /// if any error occurred then show the log
                          dev.log("Something went wrong",
                              error: e, stackTrace: st);

                          /// show the snack-bar
                          _showSnackbar("Something went wrong");
                        }
                        setState(() {
                          isLoading = false;
                        });
                        return;
                      }

                      /// if the payment type is payWithoutAgreement
                      if (_paymentType ==
                          PaymentType.payWithoutAgreement) {
                        final amount = _amountController.text.trim();

                        if (amount.isEmpty) {
                          // if the amount is empty then show the snack-bar
                          ScaffoldMessenger.of(context).showSnackBar(
                              const SnackBar(
                                  content: Text(
                                      "Amount is empty. Without amount you can't pay. Try again")));
                          setState(() {
                            isLoading = false;
                          });
                          return;
                        }

                        /// remove focus from TextField to hide keyboard
                        FocusManager.instance.primaryFocus?.unfocus();

                        /// Goto BkashPayment page & pass the params
                        try {
                          /// call pay method to pay without agreement as parameter pass the context, amount, merchantInvoiceNumber
                          final result = await flutterBkash.pay(
                            context: context,
                            // need the context as BuildContext
                            amount: double.parse(amount),
                            // need it double type
                            merchantInvoiceNumber: "tranId",
                          );

                          /// if the payment is success then show the log
                          dev.log(result.toString());

                          /// if the payment is success then show the snack-bar
                          _showSnackbar(
                              "(Success) tranId: ${result.trxId}");
                        } on BkashFailure catch (e, st) {
                          /// if something went wrong then show the log
                          dev.log(e.message, error: e, stackTrace: st);

                          /// if something went wrong then show the snack-bar
                          _showSnackbar(e.message);
                        } catch (e, st) {
                          /// if something went wrong then show the log
                          dev.log("Something went wrong",
                              error: e, stackTrace: st);

                          /// if something went wrong then show the snack-bar
                          _showSnackbar("Something went wrong");
                        }
                        setState(() {
                          isLoading = false;
                        });
                        return;
                      }

                      /// if the payment type is payWithAgreement
                      if (_paymentType == PaymentType.payWithAgreement) {
                        /// amount & agreementId is required
                        final amount = _amountController.text.trim();
                        final agreementId =
                        _agreementIdController.text.trim();

                        /// if the amount is empty then show the snack-bar
                        if (amount.isEmpty) {
                          // if the amount is empty then show the snack-bar
                          ScaffoldMessenger.of(context).showSnackBar(
                              const SnackBar(
                                  content: Text(
                                      "Amount is empty. Without amount you can't pay. Try again")));
                          setState(() {
                            isLoading = false;
                          });
                          return;
                        }

                        /// is the agreementId is empty then show the snack-bar
                        if (agreementId.isEmpty) {
                          // if the agreementId is empty then show the snack-bar
                          ScaffoldMessenger.of(context).showSnackBar(
                              const SnackBar(
                                  content: Text(
                                      "AgreementId is empty. Without AgreementId you can't pay. Try again")));
                          setState(() {
                            isLoading = false;
                          });
                          return;
                        }

                        /// remove focus from TextField to hide keyboard
                        FocusManager.instance.primaryFocus?.unfocus();

                        /// Goto BkashPayment page & pass the params
                        try {
                          /// call payWithAgreement method to pay with agreement as parameter pass the context, amount, agreementId, marchentInvoiceNumber
                          final result =
                          await flutterBkash.payWithAgreement(
                            context: context,
                            amount: double.parse(amount),
                            agreementId: agreementId,
                            marchentInvoiceNumber:
                            "merchantInvoiceNumber",
                          );

                          /// print the result
                          dev.log(result.toString());

                          /// show the snack-bar with success message
                          _showSnackbar(
                              "(Success) tranId: ${result.trxId}");
                        } on BkashFailure catch (e, st) {
                          /// print the error message & stackTrace
                          dev.log(e.message, error: e, stackTrace: st);
                          _showSnackbar(e.message);
                        } catch (e, st) {
                          /// print the error message & stackTrace
                          dev.log("Something went wrong",
                              error: e, stackTrace: st);

                          /// show the snack-bar with error message
                          _showSnackbar("Something went wrong");
                        }
                        setState(() {
                          isLoading = false;
                        });
                        return;
                      }
                    },
                  ),
                )
              ],
            ),
          ),
        ],
      ),
    );
  }

  /// show snack-bar with message
  void _showSnackbar(String message) => ScaffoldMessenger.of(context)
    ..hideCurrentSnackBar()
    ..showSnackBar(SnackBar(content: Text(message)));
}