Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flutter-stripe/flutter_stripe
Flutter SDK for Stripe.
https://github.com/flutter-stripe/flutter_stripe
dart flutter stripe
Last synced: 5 days ago
JSON representation
Flutter SDK for Stripe.
- Host: GitHub
- URL: https://github.com/flutter-stripe/flutter_stripe
- Owner: flutter-stripe
- Created: 2021-03-09T08:08:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T20:31:30.000Z (about 2 months ago)
- Last Synced: 2024-10-29T17:13:25.645Z (about 2 months ago)
- Topics: dart, flutter, stripe
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_stripe
- Size: 6.25 MB
- Stars: 947
- Watchers: 23
- Forks: 522
- Open Issues: 82
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Flutter Stripe
[](https://pub.dev/packages/flutter_stripe) 
The Stripe Flutter SDK allows you to build delightful payment experiences in your native Android and iOS apps using Flutter. We provide powerful and customizable UI screens and elements that can be used out-of-the-box to collect your users' payment details.
## Features
**Simplified Security**: We make it simple for you to collect sensitive data such as credit card numbers and remain [PCI compliant](https://stripe.com/docs/security#pci-dss-guidelines). This means the sensitive data is sent directly to Stripe instead of passing through your server. For more information, see our [Integration Security Guide](https://stripe.com/docs/security).
**Apple Pay**: We provide a [seamless integration with Apple Pay](https://stripe.com/docs/apple-pay).
**Google Pay**: The plugin can easily act as payment provider for the [Pay plugin](#Pay-Plugin-support) that enables you to seamlessly integrate Google Pay or Apple Pay. All you need to do is add your stripe publishable key to the payment profile.
**Payment methods**: Accepting more [payment methods](https://stripe.com/docs/payments/payment-methods/overview) helps your business expand its global reach and improve checkout conversion.
**SCA-Ready**: The SDK automatically performs native [3D Secure authentication](https://stripe.com/docs/payments/3d-secure) if needed to comply with [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) regulation in Europe.
**Native UI**: We provide native screens and elements to securely collect payment details on Android and iOS.
**Pre-built payments UI**: Learn how to integrate Payment Sheet, the new pre-built payments UI for mobile apps. This pre-built UI lets you accept cards, Apple Pay, and Google Pay out of the box, and includes support for saving & reusing cards.
#### Recommended usage
If you're selling digital products or services within your app, (e.g. subscriptions, in-game currencies, game levels, access to premium content, or unlocking a full version), you must use the app store's in-app purchase APIs. See [Apple's](https://developer.apple.com/app-store/review/guidelines/#payments) and [Google's](https://support.google.com/googleplay/android-developer/answer/9858738?hl=en&ref_topic=9857752) guidelines for more information. For all other scenarios you can use this SDK to process payments via Stripe.
## Installation
```sh
dart pub add flutter_stripe
```
### Requirements
#### Android
This plugin requires several changes to be able to work on Android devices. Please make sure you follow all these steps:
1. Use Android 5.0 (API level 21) and above.
2. Use Kotlin version 1.8.0 and above: [example](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/android/settings.gradle#L22)
3. Requires Android Gradle plugin 8 and higher
4. Using a descendant of `Theme.AppCompat` for your activity: [example](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/android/app/src/main/res/values/styles.xml#L15), [example night theme](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/android/app/src/main/res/values-night/styles.xml#L16)
5. Using an up-to-date Android gradle build tools version: [example](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/android/build.gradle#L9) and an up-to-date gradle version accordingly: [example](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/android/gradle/wrapper/gradle-wrapper.properties#L6)
6. Using `FlutterFragmentActivity` instead of `FlutterActivity` in `MainActivity.kt`: [example](https://github.com/flutter-stripe/flutter_stripe/blob/79b201a2e9b827196d6a97bb41e1d0e526632a5a/example/android/app/src/main/kotlin/com/flutter/stripe/example/MainActivity.kt#L6)
7. Add the following rules to your `proguard-rules.pro` file: [example](https://github.com/flutter-stripe/flutter_stripe/blob/master/example/android/app/proguard-rules.pro)
```proguard
-dontwarn com.stripe.android.pushProvisioning.PushProvisioningActivity$g
-dontwarn com.stripe.android.pushProvisioning.PushProvisioningActivityStarter$Args
-dontwarn com.stripe.android.pushProvisioning.PushProvisioningActivityStarter$Error
-dontwarn com.stripe.android.pushProvisioning.PushProvisioningActivityStarter
-dontwarn com.stripe.android.pushProvisioning.PushProvisioningEphemeralKeyProvider
```
8. Add the following line to your `gradle.properties` file: [example](https://github.com/flutter-stripe/flutter_stripe/blob/master/example/android/gradle.properties)
```properties
android.enableR8.fullMode=false
```
This will prevent crashes with the Stripe SDK on Android (see [issue](https://github.com/flutter-stripe/flutter_stripe/issues/1909)).
9. Rebuild the app, as the above changes don't update with hot reload
These changes are needed because the Android Stripe SDK requires the use of the AppCompat theme for their UI components and the Support Fragment Manager for the Payment Sheets
If you are having troubles to make this package to work on Android, join [this discussion](https://github.com/flutter-stripe/flutter_stripe/discussions/538) to get some support.
#### iOS
Compatible with apps targeting iOS 13 or above.
To upgrade your iOS deployment target to 13.0, you can either do so in Xcode under your Build Settings, or by modifying IPHONEOS_DEPLOYMENT_TARGET in your project.pbxproj directly.
You will also need to update in your Podfile:
`platform :ios, '13.0'`
For card scanning add the following to your Info.plist:
```xml
NSCameraUsageDescription
Scan your card to add it automatically
NSCameraUsageDescription
To scan cards
```
#### Web
Now you can use Stripe with Flutter web! Notice right now it is highly experimental and only a subset of features is implemented. Namely:
- Create paymentmethod
- Confirm payment intent
- Confirm setup intent
- Create token
### Supported widgets
- [Confirm payment element](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/lib/screens/payment_sheet/payment_element/platforms/payment_element_web.dart) (recommended way of handling payments on web)
- [Express checkout](https://github.com/flutter-stripe/flutter_stripe/blob/main/example/lib/screens/payment_sheet/express_checkout/platforms/express_checkout_element_web.dart)
To use Stripe on web, it is required to add `flutter_stripe_web` in your pubspec file
## Usage
### Card payments
There are 3 ways of handling card payments
Method | Ease of use | description | Implementation docs |
------------- | ------------- |----------------------------------------------------------------------------------------------------------------- | ------------------- |
Payment sheet | Easy | Our recommended way of handling payments. It offers localization, animations and error handling out of the box. | [docs](https://docs.page/flutter-stripe/flutter_stripe/sheet) |
Cardfield | Medium | Single line cardfield. Offers more flexibility but has less built-in functionality. | [docs](https://docs.page/flutter-stripe/flutter_stripe/card_field) |
Card form | Medium | Similar as the cardfield but the entry fields are spread across multi lines | [docs](https://docs.page/flutter-stripe/flutter_stripe/card_field) |
### Wallets
This library fully supports native Apple Pay and [Google pay](https://docs.page/flutter-stripe/flutter_stripe/google_pay) integration.
### Mobile elements [BETA]
We also support the customer sheet mobile element. Check out the [docs](https://docs.page/flutter-stripe/flutter_stripe/customer_sheet) to learn more on how to set it up.
### Financial connections
We also support Financial connections in our latest sdk. Check out the [docs](https://docs.page/flutter-stripe/flutter_stripe/financial_connections) to learn more on how to set it up.
## Stripe initialization
To initialize Stripe in your Flutter app, use the `Stripe` base class.
`Stripe` offers `publishableKey`, `stripeAccountId`, `threeDSecureParams` and `merchantIdentifier`. Only `publishableKey` is required.
## Dart API
The library offers several methods to handle stripe related actions:
```dart
Future createPaymentMethod(...);
Future handleNextAction(...);
Future confirmPayment(...);
Future configure3dSecure(...);
Future isApplePaySupported();
Future presentApplePay(...);
Future confirmApplePayPayment(...);
Future confirmSetupIntent(...);
Future retrievePaymentIntent(...);
Future createTokenForCVCUpdate(...);
Future initPaymentSheet(...);
Future presentPaymentSheet(...);
Future confirmPaymentSheetPayment()
```
The example app offers examples on how to use these methods.
## Pay Plugin support
flutter_stripe fully supports the [Pay plugin](https://pub.dev/packages/pay) from the Google Pay team. By including a few lines you can integrate Stripe as a payment processor for Google / Apple Pay:
```dart
Future onGooglePayResult(paymentResult) async {
final response = await fetchPaymentIntentClientSecret();
final clientSecret = response['clientSecret'];
final token = paymentResult['paymentMethodData']['tokenizationData']['token'];
final tokenJson = Map.castFrom(json.decode(token));
final params = PaymentMethodParams.cardFromToken(
token: tokenJson['id'],
);
// Confirm Google pay payment method
await Stripe.instance.confirmPayment(
clientSecret,
params,
);
}
```
## Run the example app
- Navigate to the example folder `cd example`
- Install the dependencies
- `flutter pub get`
- Set up env vars for the flutter app and a local backend.
- [Get your test Stripe API keys](https://stripe.com/docs/keys)
- `cp lib/.env.example.dart lib/.env.dart` and set your Stripe publishable key.
- `cp server/.env.example server/.env` and set the variable values in your newly created `.env` file.
- Install the server dependencies in the `server` directory:
* `cd server`
* `npm install` or `yarn --cwd "server"`
- Start the example
- Terminal 1:
* Move to the `server` directory: `cd server`
* Run npm or yarn: `npm start` or `yarn --cwd "server" start`
- Terminal 2:
* Move to the `lib` directory: `cd lib`
* Run flutter: `flutter run`
##### Additional steps for webhook forwarding
- [Install the `stripe-cli`](https://stripe.com/docs/stripe-cli)
- Run `stripe listen --forward-to localhost:4242/webhook`
## Contributing
You can help us make this project better, feel free to open an new issue or a pull request.
##### Setup
This project uses [melos](https://github.com/invertase/melos) to manage all the packages inside this repo.
- Install melos: `dart pub global activate melos`
- Setup melos in your local folder: `melos bootstrap`
##### Useful commands
- Format `melos run format`
- Analyze `melos run analyze`
- Test `melos run unittest`
- Pub get `melos run get`
##### Publishing
- Use `melos version` and `melos publish` to keep all the repositories in sync