https://github.com/ezet/stripe-sdk
A simple and flexible Stripe library for Flutter with complete support for SCA and PSD2.
https://github.com/ezet/stripe-sdk
api dart dart2 flutter library psd2 stripe
Last synced: 4 months ago
JSON representation
A simple and flexible Stripe library for Flutter with complete support for SCA and PSD2.
- Host: GitHub
- URL: https://github.com/ezet/stripe-sdk
- Owner: ezet
- License: other
- Created: 2019-08-30T23:52:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T17:57:19.000Z (almost 3 years ago)
- Last Synced: 2026-02-15T12:41:33.683Z (4 months ago)
- Topics: api, dart, dart2, flutter, library, psd2, stripe
- Language: Dart
- Homepage: https://pub.dev/packages/stripe_sdk
- Size: 922 KB
- Stars: 139
- Watchers: 9
- Forks: 137
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/stripe_sdk)
# Flutter Stripe SDK
A native dart package for Stripe. There are various other flutter plugins that wrap existing Stripe libraries,
but this package uses a different approach.
It does not wrap existing Stripe libraries, but instead accesses the Stripe API directly.
Flutter support:
* [x] iOS
* [x] Android
* [x] Web
See *example/main.dart* for additional short examples.
See for a complete demo application,
with a working example backend.
Demo backend:
## Features
* Supports all types of SCA, including 3DS, 3DS2, BankID and others.
* Handle payments with complete SCA support.
* Add, remove and update payment methods, sources and cards, optionally with SCA.
* Manage customer information.
* Create all types of Stripe tokens.
### Supported APIs
- PaymentIntent, with SCA
- SetupIntent, with SCA
- PaymentMethod
- Customer
- Cards
- Sources
- Tokens
## Demo application
There is a complete demo application available at .
## Overview
- The return type for each function is `Future>`, where the value depends on the stripe API version.
The library has three classes to access the Stripe API:
- `Stripe` for generic, non-customer specific APIs, using publishable keys.
- `CustomerSession` for customer-specific APIs, using stripe ephemeral keys.
- `StripeApi` enables raw REST calls against the Stripe API.
### Stripe
-
Aims to provide high-level functionality similar to the official mobile Stripe SDKs.
### CustomerSession
_Requires a Stripe ephemeral key._
-
-
Provides functionality similar to CustomerSession in the Stripe Android SDK.
### StripeApi
-
Provides basic low-level methods to access the Stripe REST API.
- Limited to the APIs that can be used with a public key or ephemeral key.
- Library methods map to a Stripe API call with the same name.
- Additional parameters can be provided as an optional argument.
_`Stripe` and `CustomerSession` use this internally._
## Initialization
All classes offer a singleton instance that can be initiated by calling the `init(...)` methods and then accessed through `.instance`.
Regular instances can also be created using the constructor, which allows them to be managed by e.g. dependency injection instead.
### Stripe
```dart
Stripe.init('pk_xxx');
// or, to manage your own instance, or multiple instances
final stripe = Stripe('pk_xxx');
```
### CustomerSession
The function that retrieves the ephemeral key must return the JSON response as a plain string.
```dart
CustomerSession.init((apiVersion) => server.getEphemeralKeyFromServer(apiVersion));
// or, to manage your own instances
final session = CustomerSession((apiVersion) => server.getEphemeralKeyFromServer(apiVersion));
```
### StripeApi
```dart
StripeApi.init('pk_xxx');
// or, to manage your own instances
final stripeApi = StripeApi('pk_xxx');
```
## SCA/PSD2
The library offers complete support for SCA on iOS and Android.
It handles all types of SCA, including 3DS, 3DS2, BankID and others.
It handles SCA by launching the authentication flow in a web browser, and returns the result to the app.
The `returnUrlForSca` parameter must match the configuration of your `AndroidManifest.xml` and `Info.plist` as shown in the next steps.
```dart
Stripe.init('pk_xxx', returnUrlForSca: 'stripesdk://3ds.stripesdk.io');
final clientSecret = await server.createPaymentIntent(Stripe.instance.getReturnUrlForSca());
final paymentIntent = await Stripe.instance.confirmPayment(clientSecret, paymentMethodId: 'pm_card_visa');
```
### Android
You need to declare the following intent filter in `android/app/src/main/AndroidManifest.xml`.
This example is for the url `stripesdk://3ds.stripesdk.io`:
```xml
android:launchMode="singleTop"
```
### IOS
For iOS you need to declare the scheme in `ios/Runner/Info.plist` (or through Xcode's Target Info editor,
under URL Types). This example is for the url `stripesdk://3ds.stripesdk.io`:
```xml
CFBundleURLTypes
CFBundleTypeRole
Editor
CFBundleURLName
3ds.stripesdk.io
CFBundleURLSchemes
stripesdk
```
## Experimental
Experimental features are marked as `deprecated` and the API is subject to change until it is deemed stable.
Feel free to use these features but be aware that breaking changes might be introduced in minor updates.