mek_stripe_terminal

Description:

mek stripe terminal

mek_stripe_terminal #
A flutter plugin to scan stripe readers and connect to the them and get the payment methods.
Docs #
This plugin tries to faithfully follow the signature of classes and methods.
Most of the classes in dart have the same name as the native classes.
There may be some differences between this sdk and the native one to expose an API
more simply by supporting streams instead of callbacks for listeners
Features #
All features of android and ios sdk are supported (Also the TapToPay feature)

Android sdk version: 3.7.1
IOS sdk version: 3.7.0


Offline mode is not supported

Installation #
Android #

If you are using this plugin along with Stripe Terminal SDK see this section
[Issue #349][https://github.com/stripe/stripe-terminal-android/issues/349]
android {
// TODO: remove this two directives once stripe_terminal fixes its plugin
// these two snippets are excluding a dup dependency that is probably not transitive
// https://github.com/stripe/stripe-terminal-android/issues/349
configurations {
all*.exclude module: 'bcprov-jdk15to18'
}
packagingOptions {
pickFirst 'org/bouncycastle/x509/CertPathReviewerMessages.properties'
pickFirst 'org/bouncycastle/x509/CertPathReviewerMessages_de.properties'
}
}
copied to clipboard

iOS #
You need to provide permission request strings to your Info.plist file. A sample content can be
<key>NSLocationWhenInUseUsageDescription</key>
<string>Location access is required in order to accept payments.</string>
<key>NSBluetoothPeripheralUsageDescription</key>
<string>Bluetooth access is required in order to connect to supported bluetooth card readers.</string>
<key>NSBluetoothAlwaysUsageDescription</key>
<string>This app uses Bluetooth to connect to supported card readers.</string>
copied to clipboard
You also need to authorize background modes authorization for bluetooth-central. Paste the following to your Info.plist file
<key>UIBackgroundModes</key>
<array>
<string>bluetooth-central</string>
</array>
copied to clipboard
Known bugs #

Android: https://github.com/stripe/stripe-terminal-android/issues/433

Usage #
You can see the usage example in the example folder
Initialization #


Request the permissions
import 'package:permission_handler/permission_handler.dart';

final permissions = [
Permission.locationWhenInUse,
Permission.bluetooth,
if (Platform.isAndroid) ...[
Permission.bluetoothScan,
Permission.bluetoothConnect,
],
];
await permissions.request();
copied to clipboard


Initialize the SDK
stripeTerminal = StripeTerminal.getInstance(
fetchToken: () async {
// Call your backend to get the connection token and return to this function
// Example token can be.
const token = "pst_test_XXXXXXXXXX....";

return token;
},
);
copied to clipboard
Example backend code to get the connection token written on node.js:
import Stripe from "stripe";
import express from "express";

const stripe = new Stripe("sk_test_XXXXXXXXXXXXXXXXXX", {
apiVersion: "2020-08-27"
})

const app = express();

app.get("/connectionToken", async (req, res) => {
const token = await stripe.terminal.connectionTokens.create();
res.send({
success: true,
data: token.secret
});
});

app.listen(8000, () => {
console.log("Server started")
});
copied to clipboard


Discover and Connect Reader #

Discover the devices nearby and show it to the user. Stripe Docs
stripeTerminal
.discoverReaders(BluetoothProximityDiscoveryConfiguration(isSimulated: true))
.listen((List<StripeReader> readers) {
setState(() => _readers = readers);
});
copied to clipboard

Connect to a reader

Bluetooth reader
await stripeTerminal.connectBluetoothReader(readers[0].serialNumber, locationId: locationId);
print("Connected to a device");
copied to clipboard

TapToPay
await stripeTerminal.connectMobileReader(readers[0].serialNumber, locationId: locationId);
print("Connected to a device");
copied to clipboard




Process a Payment #

Create a payment intent on backend side
// Get this from your backend by creating a new payment intent
final backendPaymentIntent = await backend.createPaymentIntent();
copied to clipboard

Retrieve payment intent
final paymentIntent = await stripeTerminal.retrievePaymentIntent(backendPaymentIntent.clientSecret);
copied to clipboard

Collect payment method
final processablePaymentIntent = await stripeTerminal.collectPaymentMethod(paymentIntent);
copied to clipboard

Collect payment method
final capturablePaymentIntent = await stripeTerminal.confirmPaymentIntent(processablePaymentIntent)
print("A payment intent has captured a payment method, send this payment intent to you backend to capture the payment");
copied to clipboard


Contributing #
The code is formatted with a line/page length of 100 characters.
Use conventional commits for your commits.
Much code in this plugin is auto generated:

one_for_all is used to generate the code for communication between platforms.
Run this script
index_generator is used to generate library exports

Android #
Format code with ./gradlew spotlessApply