-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 93d780e
Showing
87 changed files
with
3,494 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Miscellaneous | ||
*.class | ||
*.log | ||
*.pyc | ||
*.swp | ||
.DS_Store | ||
.atom/ | ||
.buildlog/ | ||
.history | ||
.svn/ | ||
|
||
# IntelliJ related | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea/ | ||
|
||
# The .vscode folder contains launch configuration and tasks you configure in | ||
# VS Code which you may wish to be included in version control, so this line | ||
# is commented out by default. | ||
#.vscode/ | ||
|
||
# Flutter/Dart/Pub related | ||
**/doc/api/ | ||
.dart_tool/ | ||
.flutter-plugins | ||
.flutter-plugins-dependencies | ||
.packages | ||
.pub-cache/ | ||
.pub/ | ||
build/ | ||
|
||
# Android related | ||
**/android/**/gradle-wrapper.jar | ||
**/android/.gradle | ||
**/android/captures/ | ||
**/android/gradlew | ||
**/android/gradlew.bat | ||
**/android/local.properties | ||
**/android/**/GeneratedPluginRegistrant.java | ||
|
||
# iOS/XCode related | ||
**/ios/**/*.mode1v3 | ||
**/ios/**/*.mode2v3 | ||
**/ios/**/*.moved-aside | ||
**/ios/**/*.pbxuser | ||
**/ios/**/*.perspectivev3 | ||
**/ios/**/*sync/ | ||
**/ios/**/.sconsign.dblite | ||
**/ios/**/.tags* | ||
**/ios/**/.vagrant/ | ||
**/ios/**/DerivedData/ | ||
**/ios/**/Icon? | ||
**/ios/**/Pods/ | ||
**/ios/**/.symlinks/ | ||
**/ios/**/profile | ||
**/ios/**/xcuserdata | ||
**/ios/.generated/ | ||
**/ios/Flutter/App.framework | ||
**/ios/Flutter/Flutter.framework | ||
**/ios/Flutter/Flutter.podspec | ||
**/ios/Flutter/Generated.xcconfig | ||
**/ios/Flutter/app.flx | ||
**/ios/Flutter/app.zip | ||
**/ios/Flutter/flutter_assets/ | ||
**/ios/Flutter/flutter_export_environment.sh | ||
**/ios/ServiceDefinitions.json | ||
**/ios/Runner/GeneratedPluginRegistrant.* | ||
|
||
# Exceptions to above rules. | ||
!**/ios/**/default.mode1v3 | ||
!**/ios/**/default.mode2v3 | ||
!**/ios/**/default.pbxuser | ||
!**/ios/**/default.perspectivev3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# This file tracks properties of this Flutter project. | ||
# Used by Flutter tool to assess capabilities and perform upgrades etc. | ||
# | ||
# This file should be version controlled and should not be manually edited. | ||
|
||
version: | ||
revision: c5a4b4029c0798f37c4a39b479d7cb75daa7b05c | ||
channel: stable | ||
|
||
project_type: package |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## [1.0.0] - September 9, 2021. | ||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
``` | ||
|
||
Flutterwave's Flutter SDK | ||
|
||
MIT License | ||
|
||
|
||
|
||
Copyright (c) 2021 | ||
|
||
|
||
|
||
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. | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
<p align="center"> | ||
<img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo-colored.svg" width="50%"/> | ||
</p> | ||
|
||
# Flutterwave Flutter Standard SDK | ||
|
||
## Table of Contents | ||
|
||
- [About](#about) | ||
- [Getting Started](#getting-started) | ||
- [Usage](#usage) | ||
- [Deployment](#deployment) | ||
- [Built Using](#build-tools) | ||
- [References](#references) | ||
- [Support](#support) | ||
|
||
<a id="about"></a> | ||
## About | ||
Flutterwave's Flutter SDK is Flutterwave's offical flutter sdk to integrate Flutterwave's [Standard](https://developer.flutterwave.com/docs/flutterwave-standard) payment into your flutter app. It comes with a ready made Drop In UI. | ||
|
||
|
||
|
||
<a id="getting-started"></a> | ||
|
||
## Getting Started | ||
|
||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. | ||
See [references](#references) for links to dashboard and API documentation. | ||
|
||
### Prerequisite | ||
|
||
- Ensure you have your test (and live) [API keys](https://developer.flutterwave.com/docs/api-keys). | ||
``` | ||
Flutter version >= 1.17.0 | ||
Flutterwave version 3 API keys | ||
``` | ||
|
||
### Installing | ||
|
||
**Step 1.** Add the dependency | ||
|
||
In your `pubspec.yaml` file add: | ||
|
||
1. `flutterwave_standard: 1.0.0` | ||
2. run `flutter pub get` | ||
|
||
<a id="usage"></a> | ||
## Usage | ||
|
||
### 1. Create a `Flutterwave` instance | ||
|
||
Create a `Flutterwave` instance by calling the constructor `Flutterwave` The constructor accepts a mandatory instance of the following: | ||
the calling `Context` , `publicKey`, `Customer`, `amount`, `currency`, `email`, `fullName`, `txRef`, `isDebug`, `paymentOptions`, and `Customization` . It returns an instance of `Flutterwave` which we then call the `async` method `.charge()` on. | ||
|
||
_handlePaymentInitialization() async { | ||
final style = FlutterwaveStyle( | ||
appBarText: "My Standard Blue", | ||
buttonColor: Color(0xffd0ebff), | ||
appBarIcon: Icon(Icons.message, color: Color(0xffd0ebff)), | ||
buttonTextStyle: TextStyle( | ||
color: Colors.black, | ||
fontWeight: FontWeight.bold, | ||
fontSize: 18, | ||
), | ||
appBarColor: Color(0xffd0ebff), | ||
dialogCancelTextStyle: TextStyle( | ||
color: Colors.redAccent, | ||
fontSize: 18, | ||
), | ||
dialogContinueTextStyle: TextStyle( | ||
color: Colors.blue, | ||
fontSize: 18, | ||
) | ||
); | ||
final Customer customer = Customer( | ||
name: "FLW Developer", | ||
phoneNumber: "1234566677777", | ||
email: "[email protected]"); | ||
|
||
final Flutterwave flutterwave = Flutterwave( | ||
context: context, | ||
style: style, | ||
publicKey: "Public Key, | ||
currency: "RWF", | ||
txRef: "unique_transaction_reference", | ||
amount: "3000", | ||
customer: customer, | ||
paymentOptions: "ussd, card, barter, payattitude", | ||
customization: Customization(title: "Test Payment"), | ||
isDebug: true); | ||
} | ||
|
||
|
||
### 2. Handle the response | ||
|
||
Calling the `.charge()` method returns a `Future` | ||
of `ChargeResponse` which we await for the actual response as seen above. | ||
|
||
``` | ||
final ChargeResponse response = await flutterwave.charge(); | ||
if (response != null) { | ||
print(response.toJson()); | ||
if(response.success) { | ||
Call the verify transaction endpoint with the transactionID returned in `response.transactionId` to verify transaction before offering value to customer | ||
} else { | ||
// Transaction not successful | ||
} | ||
} else { | ||
// User cancelled | ||
} | ||
``` | ||
|
||
|
||
|
||
#### Please note that: | ||
- `ChargeResponse` can be null, depending on if the user cancels | ||
the transaction by pressing back. | ||
- You need to check the status of the transaction from the instance of `ChargeResponse` returned from calling `.charge()`, the `status`, `success` and `txRef` are successful and correct before providing value to the customer | ||
|
||
> **PLEASE NOTE** | ||
> We advise you to do a further verification of transaction's details on your server to be sure everything checks out before providing service. | ||
<a id="deployment"></a> | ||
## Deployment | ||
|
||
- Switch to Live Mode on the Dashboard settings page | ||
- Use the Live Public API key from the API tab, see [here](https://developer.flutterwave.com/docs/api-keys) for more details. | ||
|
||
<a id="build-tools"></a> | ||
## Built Using | ||
- [flutter](https://flutter.dev/) | ||
- [http](https://pub.dev/packages/http) | ||
- [webview_flutter](https://pub.dev/packages/webview_flutter) | ||
- [fluttertoast](https://pub.dev/packages/fluttertoast) | ||
|
||
<a id="references"></a> | ||
## Flutterwave API References | ||
|
||
- [Flutterwave API Doc](https://developer.flutterwave.com/docs) | ||
- [Flutterwave Inline Payment Doc](https://developer.flutterwave.com/docs/flutterwave-inline) | ||
- [Flutterwave Dashboard](https://dashboard.flutterwave.com/login) | ||
|
||
<a id="support"></a> | ||
## Support | ||
* Have issues integrating? Reach out via [our Developer forum](https://developer.flutterwave.com/discuss) for support | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Miscellaneous | ||
*.class | ||
*.log | ||
*.pyc | ||
*.swp | ||
.DS_Store | ||
.atom/ | ||
.buildlog/ | ||
.history | ||
.svn/ | ||
|
||
# IntelliJ related | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea/ | ||
|
||
# The .vscode folder contains launch configuration and tasks you configure in | ||
# VS Code which you may wish to be included in version control, so this line | ||
# is commented out by default. | ||
#.vscode/ | ||
|
||
# Flutter/Dart/Pub related | ||
**/doc/api/ | ||
**/ios/Flutter/.last_build_id | ||
.dart_tool/ | ||
.flutter-plugins | ||
.flutter-plugins-dependencies | ||
.packages | ||
.pub-cache/ | ||
.pub/ | ||
/build/ | ||
|
||
# Web related | ||
lib/generated_plugin_registrant.dart | ||
|
||
# Symbolication related | ||
app.*.symbols | ||
|
||
# Obfuscation related | ||
app.*.map.json | ||
|
||
# Exceptions to above rules. | ||
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# This file tracks properties of this Flutter project. | ||
# Used by Flutter tool to assess capabilities and perform upgrades etc. | ||
# | ||
# This file should be version controlled and should not be manually edited. | ||
|
||
version: | ||
revision: fba99f6cf9a14512e461e3122c8ddfaa25394e89 | ||
channel: stable | ||
|
||
project_type: app |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# flutterwave_beta | ||
|
||
A new Flutter project. | ||
|
||
## Getting Started | ||
|
||
This project is a starting point for a Flutter application. | ||
|
||
A few resources to get you started if this is your first Flutter project: | ||
|
||
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) | ||
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) | ||
|
||
For help getting started with Flutter, view our | ||
[online documentation](https://flutter.dev/docs), which offers tutorials, | ||
samples, guidance on mobile development, and a full API reference. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
gradle-wrapper.jar | ||
/.gradle | ||
/captures/ | ||
/gradlew | ||
/gradlew.bat | ||
/local.properties | ||
GeneratedPluginRegistrant.java | ||
|
||
# Remember to never publicly share your keystore. | ||
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app | ||
key.properties |
Oops, something went wrong.