You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Flutter library helps you create seamless payment experiences in your dart mobile app. By connecting to our modal, you can start collecting payment in no time.
16
8
17
-
<aid="about"></a>
18
-
## About
19
-
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.
9
+
Available features include:
20
10
11
+
- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter.
12
+
- Recurring payments: Tokenization and Subscriptions.
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.
28
-
See [references](#references) for links to dashboard and API documentation.
29
24
30
-
### Prerequisite
25
+
##Requirements
31
26
32
-
- Ensure you have your test (and live) [API keys](https://developer.flutterwave.com/docs/api-keys).
33
-
```
34
-
Flutter version >= 1.17.0
35
-
Flutterwave version 3 API keys
36
-
```
27
+
1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
28
+
2. Supported Flutter version >= 1.17.0
37
29
38
-
### Installing
30
+
## Installation
39
31
40
-
**Step 1.** Add the dependency
32
+
1. Add the dependency to your project. In your `pubspec.yaml` file add: `flutterwave_standard: 1.0.2`
33
+
2. Run `flutter pub get`
41
34
42
-
In your `pubspec.yaml` file add:
35
+
## Usage
43
36
44
-
1.`flutterwave_standard: 1.0.2`
45
-
2. run `flutter pub get`
37
+
### Initializing a Flutterwave instance
46
38
47
-
<aid="usage"></a>
48
-
## Usage
39
+
To create an instance, you should call the Flutterwave constructor. This constructor accepts a mandatory instance of the following:
49
40
50
-
### 1. Create a `Flutterwave` instance
41
+
- The calling `Context`
42
+
-`publicKey`
43
+
-`Customer`
44
+
-`amount`
45
+
-`currency`
46
+
-`email`
47
+
-`fullName`
48
+
-`txRef`
49
+
-`isDebug`
50
+
-`paymentOptions`
51
+
-`Customization`
51
52
52
-
Create a `Flutterwave` instance by calling the constructor `Flutterwave` The constructor accepts a mandatory instance of the following:
53
-
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.
53
+
It returns an instance of Flutterwave which we then call the async method `.charge()` on.
54
54
55
-
_handlePaymentInitialization() async {
55
+
```dart
56
+
_handlePaymentInitialization() async {
56
57
final style = FlutterwaveStyle(
57
58
appBarText: "My Standard Blue",
58
59
buttonColor: Color(0xffd0ebff),
@@ -89,14 +90,14 @@ Create a `Flutterwave` instance by calling the constructor `Flutterwave` The con
of `ChargeResponse` which we await for the actual response as seen above.
98
+
Calling the `.charge()` method returns a Future of `ChargeResponse` which we await for the actual response as seen above.
98
99
99
-
```
100
+
```dart
100
101
final ChargeResponse response = await flutterwave.charge();
101
102
if (response != null) {
102
103
print(response.toJson());
@@ -110,37 +111,30 @@ Create a `Flutterwave` instance by calling the constructor `Flutterwave` The con
110
111
}
111
112
```
112
113
114
+
#### Note:
115
+
1.`ChargeResponse` can be null if a user cancels the transaction by pressing back.
116
+
2. You need to confirm the transaction is succesful. Ensure that the txRef, amount, and status are correct and successful. Be sure to [verify the transaction details](https://developer.flutterwave.com/docs/verifications/transaction) before providing value.
117
+
118
+
# Support
119
+
120
+
For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg).
121
+
122
+
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
113
123
124
+
# Contribution guidelines
114
125
115
-
#### Please note that:
116
-
-`ChargeResponse` can be null, depending on if the user cancels
117
-
the transaction by pressing back.
118
-
- 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
126
+
Read more about our community contribution guidelines [here](/CONTRIBUTING).
119
127
120
-
> **PLEASE NOTE**
128
+
# License
121
129
122
-
> We advise you to do a further verification of transaction's details on your server to be sure everything checks out before providing service.
123
-
<a id="deployment"></a>
124
-
## Deployment
130
+
By contributing to the {{language}} library, you agree that your contributions will be licensed under its [MIT license](/LICENSE).
125
131
126
-
- Switch to Live Mode on the Dashboard settings page
127
-
- Use the Live Public API key from the API tab, see [here](https://developer.flutterwave.com/docs/api-keys) for more details.
0 commit comments