foloosi_payment

pub package Say Thanks!

A Flutter plugin for making payments via Foloosi Payment Gateway. Fully supports Android and iOS.

πŸ’» Installation

In the dependencies: section of your pubspec.yaml, add the following line:

foloosi_payment: ^0.1.3+1

Import in your project:

import 'package:foloosi_payment/foloosi_payment.dart';

❔Basic Usage

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key}) : super(key: key);

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

class _MyHomePageState extends State<MyHomePage> {

final GlobalKey<ScaffoldState> _scaffoldKey = new GlobalKey<ScaffoldState>();

bool proceedToPayment = false;

  void _proceeedToPayment() {
    setState(() {
      proceedToPayment = true;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      key: _scaffoldKey,
      appBar: proceedToPayment
          ? null
          : AppBar(
              title: Text('Foloosi Payment Flutter'),
            ),
      body: proceedToPayment
          ? FoloosiPayment(
              headerText: 'Foloosi Payment',
              loaderText: 'Processing Request',
              merchantKey: 'YOUR_FOLOOSI_MERCHANT_KEY',
              secretKey: 'YOUR_FOLOOSI_SECRET_KEY',
              transactionAmount: 2000,
              currency: 'AED',
              customerName: 'Joshua Chinemezu',
              customerEmail: 'joshuachinemezu@gmail.com',
              customerMobile: '+971500000000',
              onError: (value) {
                print("Payment Error : $value");
                setState(() {
                  proceedToPayment = false;
                });
                _scaffoldKey.currentState.showSnackBar(SnackBar(
                  content: Text(value.toString()),
                  duration: Duration(seconds: 3),
                ));
              },
              onSuccess: (value) {
                print("Payment Success : $value");
                setState(() {
                  proceedToPayment = false;
                });
                _scaffoldKey.currentState.showSnackBar(SnackBar(
                  content: Text(value.toString()),
                  duration: Duration(seconds: 3),
                ));
              },
            )
          : Center(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: <Widget>[
                  RaisedButton(
                    onPressed: _proceeedToPayment,
                    child: new Text(
                      "Proceed to Payment",
                    ),
                  )
                ],
              ),
            ),
    );
  }
}

Note: If you're using the foloosi secret and merchant keys as a string in flutter, remember to escape the $ dollar signs although it is recommended to load these from your backend

merchantKey: 'test*\$2y\$10\$PQ8r...',
secretKey: 'test*\$2y\$10\$psrewC...',

Properties

Here is a list of properties available:

NameTypeRequiredDescription
headerTextStringfalsethe title of the widget's appbar
onErrorFunctiontruefunction to run on payment error
onSuccessFunctiontruefunction to run on payment success
loaderTextStringfalsetext to display under the loader
merchantKeyStringtrueyour foloosi merchant key
secretKeyStringtrueyour foloosi secret key
referenceTokenStringfalsethe reference token - generates automatically if null
transactionAmountString-transaction amount - required if referenceToken is null
currencyString-transaction currency - required if referenceToken is null
customerNameStringfalsecustomer name - auto render in payment popup if passed
customerEmailStringfalsecustomer email - auto render in payment popup if passed
customerMobileStringfalsecustomer mobile - auto render in payment popup if passed
customerAddressStringfalsecustomer address - auto render in payment popup if passed
customerCityStringfalsecustomer city - auto render in payment popup if passed
paymentCancellationMsgStringfalsemessage returned when user cancels the payment
debugModeboolfalseto enable or disable package logs
allowNavigationboolfalseto allow route navigation away from payment screen
onNavigateFunction-callback function that is triggered when navigation is attempted.

TODO

  • Add QR code Payment.
  • Add Transaction List.
  • Add Transaction Details

Show some :heart: and star the repo to support the project

GitHub followers Twitter Follow

Open Source Love

πŸ‘¨ Developed with :heart: by

Joshua Chinemezu

πŸ‘ How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

πŸ“ƒ License

Copyright (c) 2020 Joshua Chinemezu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Libraries

foloosi_payment