flutter_fawry_pay

Description:

flutter fawry pay

Flutter FawryPay #

Explain #
This plugin is for FawryPay. It's implemented the native SDKs of Mobile, and Web to work on Flutter environment.

It works for Android fine. iOS works fine on Real Device only (FawryPay Requirements).

Contribution: Eng. Ahmed Mahmoud

Getting Started #
Add this to your package's pubspec.yaml file:
dependencies:
flutter_fawry_pay: ^0.0.6
copied to clipboard
Android #
You have to edit AndroidManifest.xml file with following.
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools" />
<application
tools:replace="android:theme,android:label,android:name">
</appliaction>
</manifest>
copied to clipboard
And download this file, and put it in app/libs folder (If not exist, create it).
In Release Mode
Please add these two lines in app/gradle
buildTypes {
release {
// ....
shrinkResources false
minifyEnabled false
}
}
copied to clipboard
iOS #
No actions needed, just work on Real Device only. Need xCode 12.x and SWIFT 5.3.x.
Web #
No actions needed, just go ahead.
Usage #
You just have to import the package with
import 'package:flutter_fawry_pay/flutter_fawry_pay.dart';
copied to clipboard
Then, you need to initialize the SDK.
FlutterFawryPay.instance.init(
// Set the merchant ID here for one time only.
merchantID: Keys.merchantID,
style: Style.STYLE1,
// If set to true, you must set username and email.
skipCustomerInput: true,
// Must be a phone number.
username: "01234567890",
email: "[email protected]",
// For web how you show the Fawry screen.
webDisplayMode: DisplayMode.SIDE_PAGE,
// You should set environment here.
environment: Environment.TEST,
);
copied to clipboard
And when you are ready for production you have to set the environment to LIVE.
Now, you can stream the result data that from SDK.
FlutterFawryPay.instance.callbackResultStream().listen((event) {
FawryResponse response = FawryResponse.fromMap(data);
print(response);
});
copied to clipboard
Let's now make our first payment initialize, you must set your merchantID that token from FawryPay system, and set your FawryItems that the user will pay for.

Note that: there's error in native FawryPay SDK for Android and iOS to retrieve again customParam.

FlutterFawryPay.instance.initialize(
returnUrl: "test.com", // For Web use only.
items: [
FawryItem(sku: "1", description: "Item 1", qty: 1, price: 20.0),
],
customParam: {
"order_id": "123213",
"price": 231.0,
},
);
copied to clipboard
You can set some parameters like: merchantRefNumber, customParam.
So now, it was initialized well, how to start payment? You have TWO ways.
First way: Native Fawry Button #
You can use the native button for FawryPay SDK. through this only widget.
FawryButton()
copied to clipboard
Second way: Your custom widget #
You can use your own widget with a function to call with FlutterFawryPay.instance.startProcess().
RaisedButton(
onPressed: () async {
FawryResponse response = await FlutterFawryPay.instance.startProcess();
},
child: Text("Start Payment"),
)
copied to clipboard
There's a function in FawryPay is CardTokenizer (Android & iOS only, not for Web), you can use it like this way:

Note that: there's error in native FawryPay SDK for android to retrieve again customParam.

FlutterFawryPay.instance.initializeCardTokenizer(
customerMobile: "01234567890",
customerEmail: "[email protected]",
customParam: {
"order_id": "123213",
"price": 231.0,
},
);
copied to clipboard
Last function you can use is reset the initialization (Android & Web only), doing that:
FlutterFawryPay.instance.reset();
copied to clipboard
Objects #
class FawryItem {
String sku;
String description;
int qty;
double price;
double? originalPrice;
int? height;
int? length;
double? weight;
int? width;
String? variantCode;
List<String>? reservationCodes;
String? earningRuleID;
String? imageUrl; // For Web only.
}

class FawryResponse {
/// Parameters for payment process.
String transactionID;
DateTime expiryDate;

/// Parameters for card tokenizer process.
String cardToken;
DateTime creationDate;
String lastFourDigits;

/// Common parameters for all process.
Map<String, dynamic> customParam;
String errorMessage;
}
copied to clipboard
Enums #
/// Enums for DisplayMode configuration.
///
/// [POPUP] show a popup dialog.
/// [SIDE_PAGE] show side screen dialog.
enum DisplayMode { POPUP, SIDE_PAGE }

/// Enums for Environment configuration.
///
/// [TEST] for test stage atfawry.fawrystaging endpoint.
/// [LIVE] for production stage atfawry endpoint.
enum Environment { TEST, LIVE }

/// Enums for Environment configuration.
///
/// [EN] for English language.
/// [AR] for Arabic language.
enum Language { EN, AR }

/// Enums for Environment configuration.
///
/// [STYLE1] for first styling.
/// [STYLE2] for second styling.
enum Style { STYLE1, STYLE2 }
copied to clipboard
Links #
FawryPay Android SDK: https://developer.fawrystaging.com/docs/sdks/android-sdk
FawryPay iOS SDK: https://developer.fawrystaging.com/docs/sdks/ios-sdk
FawryPay Web: https://developer.fawrystaging.com/docs/express-checkout/checkout-integration-overview
Supported By ❤ #
Eng. Ahmed Mahmoud (Works on iOS development)
Eng. Ahmed Hamouda
Eng. Mohamed Ghoneim
Issues or Contributions #
This is a beta version of plugin, so I am very appreciated for any issues or contribution you can help me with.
Find me on Stackoverflow #

License #
MIT: https://mit-license.org.
Copyright (c) 2021 Shady Boshra. All rights reserved.
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.