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.
9
9
10
-
-[About](#about)
11
-
-[Getting Started](#getting-started)
12
-
-[Usage](#usage)
13
-
-[Deployment](#deployment)
14
-
-[Built Using](#build-tools)
15
-
-[References](#references)
16
-
-[Support](#support)
17
10
18
-
<aid="about"></a>
19
-
## About
20
-
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.
11
+
Available features include:
21
12
13
+
- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter.
14
+
- 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.
29
-
See [references](#references) for links to dashboard and API documentation.
30
27
31
28
## Requirements
32
-
- Ensure you have your test (and live) [API keys](https://developer.flutterwave.com/docs/api-keys).
33
-
``` Flutter version >= 1.17.0 Flutterwave version 3 API keys ```
34
29
35
-
## Installation Add the dependency
30
+
1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
31
+
2. Supported Flutter version >= 1.17.0
32
+
33
+
34
+
## Installation
36
35
37
-
In your `pubspec.yaml` file add:
36
+
1. Add the dependency to your project. In your `pubspec.yaml` file add: `flutterwave_standard: 1.0.2`
37
+
2. Run `flutter pub get`
38
38
39
-
1.`flutterwave_standard: ^1.0.4`
40
-
2. run `flutter pub get`
41
-
<aid="usage"></a>
42
39
43
40
## Usage
44
41
45
-
Create a `Flutterwave` instance by calling the constructor `Flutterwave` The constructor accepts a mandatory instance of the following:
46
-
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.
42
+
### Initializing a Flutterwave instance
43
+
44
+
To create an instance, you should call the Flutterwave constructor. This constructor accepts a mandatory instance of the following:
45
+
46
+
- The calling `Context`
47
+
-`publicKey`
48
+
-`Customer`
49
+
-`amount`
50
+
-`currency`
51
+
-`email`
52
+
-`fullName`
53
+
-`txRef`
54
+
-`isDebug`
55
+
-`paymentOptions`
56
+
-`Customization`
57
+
58
+
It returns an instance of Flutterwave which we then call the async method `.charge()` on.
of `ChargeResponse` which we await for the actual response as seen above.
103
+
Calling the `.charge()` method returns a Future of `ChargeResponse` which we await for the actual response as seen above.
93
104
94
105
95
106
@@ -105,45 +116,34 @@ of `ChargeResponse` which we await for the actual response as seen above.
105
116
// User cancelled
106
117
}
107
118
108
-
#### Please note that:
109
-
-`ChargeResponse` can be null, depending on if the user cancels
110
-
the transaction by pressing back.
111
-
- 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
119
+
#### Note
112
120
113
-
> **PLEASE NOTE**
121
+
1.`ChargeResponse` can be null if a user cancels the transaction by pressing back.
122
+
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.
114
123
115
-
> We advise you to do a further verification of transaction's details on your server to be sure everything checks out before providing service.
116
-
<a id="deployment"></a>
117
124
125
+
## Support
118
126
119
-
##Testing
120
-
`pub run test`
127
+
For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).
121
128
122
-
## Debugging Errors
123
-
We understand that you may run into some errors while integrating our library. You can read more about our error messages [here](https://developer.flutterwave.com/docs/integration-guides/errors).
129
+
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
124
130
125
-
For `authorization` and `validation` error responses, double-check your API keys and request. If you get a `server` error, kindly engage the team for support.
126
131
127
-
<aid="support"></a>
128
-
## Support For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).
132
+
## Contribution guidelines
129
133
130
-
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊
134
+
Read more about our community contribution guidelines [here](/CONTRIBUTING).
131
135
132
-
## Contribution guidelines
133
-
Read more about our community contribution guidelines [here](https://www.notion.so/flutterwavego/Community-contribution-guide-ca1d8a876ba04d45ab4b663c758ae42a).
134
136
135
137
## License
136
-
By contributing to the Flutter library, you agree that your contributions will be licensed under its [MIT license](https://opensource.org/licenses/MIT).
138
+
139
+
By contributing to the Flutter library, you agree that your contributions will be licensed under its [MIT license](/LICENSE).
0 commit comments