quick_payment 1.4.0

Flutter SDK for accepting Bangladeshi manual mobile banking payments like bKash, Nagad, Rocket, and Upay.

quick_payment

Flutter SDK for accepting Bangladeshi manual mobile banking payments like bKash, Nagad, Rocket, and Upay.

Easily integrate mobile payment options into your Flutter app with ready-to-use classes, assets, and UI components.

---

Features

• Supports multiple payment methods: bKash, Nagad, Rocket, Upay
• Simple PaymentMethod class for easy integration
• Includes payment logos in assets
• Lightweight and well-documented
• Works with Flutter >=3.10.0
• Provides PaymentData callback on submission for DB storage or manual approval
• Optional support section with phone, email, and ticket links

---

Installation

Add the package to your pubspec.yaml:

dependencies:
  quick_payment: ^1.4.0

Then run:

flutter pub get

---

Integration Guide

Follow these steps to integrate quick_payment into your Flutter app:

1️⃣ Import the package

import 'package:quick_payment/quick_payment.dart';

2️⃣ Prepare Customer Details

Use CustomerDetails to provide customer name and email.
This will be included in PaymentData for your DB storage.

final customer = CustomerDetails(
  fullName: 'Khalid LikhOn',
  email: '[e-mail]',
);

3️⃣ Setup Payment Credentials

Use QuickPayCredentials to configure mobile banking numbers and optional fee percentage.

final credentials = QuickPayCredentials(
  feePercentage: 1.8, // optional
  methods: [
    PaymentMethod.bkash("016xxxxxxxx"),
    PaymentMethod.nagad("017xxxxxxxx"),
    PaymentMethod.rocket("018xxxxxxxx"),
    // PaymentMethod.upay("019xxxxxxxx"), // optional
  ],
);

Replace the numbers with your personal mobile banking numbers to receive payments.

4️⃣ Optional: Add Support Credentials

If you want to provide a support section inside the payment flow, use QuickPaySupportCredentials. The email is required, while phone number and ticket URL are optional.

final support = QuickPaySupportCredentials(
  phoneNumber: '[phone]',      // Optional
  email: '[e-mail]',    // Required
  ticketUrl: 'https://support.khalidlikhon.me', // Optional
);

Pass it to QuickPay.createPayment:

  supportCredentials: support, 

5️⃣ Trigger Payment Flow

Call QuickPay.createPayment() on button press or action.

QuickPay.createPayment(
  context: context,
  amount: 200, // Payment amount
  customer: customer,
  credentials: credentials,
  supportCredentials: support, // Optional
  onPaymentSubmitted: (data) {
    // PaymentData returned after user submits
    // Save to your database manually
    print(data.toMap());
  },
);

onPaymentSubmitted returns a PaymentData object with:

Field	Description
customer	CustomerDetails object (name & email)
amount	Payment amount
method	Payment method type (e.g., bKash)
transactionId	User-entered transaction ID
time	DateTime when payment submitted
status	Default "pending" – approve manually in DB

⚠️ Payment status is "pending" by default. You must manually verify and approve in your system.

---

Usage Example

This example demonstrates how to use QuickPayment with multiple payment methods in your Flutter app. Clicking the Pay Now button opens the payment dialog and handles submission callbacks.

import 'package:flutter/material.dart';
import 'package:quick_payment/quick_payment.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: const HomePage(),
      debugShowCheckedModeBanner: false,
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text("Quick Payment Example")),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            
            // Customer Details
            final customer = CustomerDetails(
              fullName: 'Khalid LikhOn',
              email: '[e-mail]',
            );

            // Payment Credentials & Methods
            final credentials = QuickPayCredentials(
              feePercentage: 1.8,
              methods: [
                PaymentMethod.bkash("016xxxxxxxx"),
                PaymentMethod.nagad("017xxxxxxxx"),
                PaymentMethod.rocket("018xxxxxxxx"),
                // PaymentMethod.upay("019xxxxxxxx"), // optional
              ],
            );

            // Optional Support Credentials
            final support = QuickPaySupportCredentials(
              phoneNumber: '[phone]',      // Optional
              email: '[e-mail]',    // Required
              ticketUrl: 'https://khalidlikhon.me', // Optional
            );

            // Trigger Payment Flow
            QuickPay.createPayment(
              context: context,
              amount: 200,
              customer: customer,
              credentials: credentials,
              supportCredentials: support, // Optional
              onPaymentSubmitted: (data) {
                // PaymentData returned after submission
                print(data.toMap());
              },
            );
          },
          child: const Text("Pay Now"),
        ),
      ),
    );
  }
}

---

License

This project is licensed under the MIT License – see the LICENSE file for details.

---

Links

• Homepage: GitHub Repository
• Issue Tracker: Report Issues