lpe_sdk 3.0.5
lpe_sdk: ^3.0.5 copied to clipboard
Learmond Pay Element (LPE) SDK – A reusable Flutter package for Stripe payment sheets, supporting card, bank, Apple Pay, and Google Pay in a single API.
LPE (Learmond Pay Element) SDK #
A reusable Flutter SDK that provides a unified UI and helpers for collecting payments via Stripe Elements, Apple Pay, and Google Pay.
This README documents the SDK's major features and how to integrate and inegrate the package.
Major features #
- Composite payment widget:
LearmondPayButtons(Card / Bank / Apple Pay / Google Pay) - Individual buttons:
LearmondCardButton,LearmondUSBankButton,LearmondEUBankButton,LearmondApplePayButton,LearmondGooglePayButton - Programmatic pay sheet:
LearmondPaySheet.show(...) - Native device pay bridge:
LearmondNativePay.showNativePay(...) - Merchant args helpers:
buildMerchantArgs,buildMerchantArgsFromAmount - Lightweight merchant-args editor:
Learmond.instance.presentMerchantArgs(...)(used by the example/test app)
Installation #
Add the package to your pubspec.yaml (use local path for development):
flutter pub add lpe_sdk
Install dependencies:
flutter pub get
Note: The plugin uses native functionality for Apple/Google Pay; follow platform-specific setup steps for iOS and Android when integrating into a real app.
Initialization #
Optionally set global defaults with LpeConfig before runApp(...):
void main() {
LpeConfig.init(
appleMerchantId: 'merchant.com.example',
googleGatewayMerchantId: 'yourGatewayMerchantId',
defaultMerchantName: 'My Shop',
defaultMerchantInfo: 'Order',
);
runApp(const MyApp());
}
Usage #
Composite Widget (recommended) #
Use LearmondPayButtons to show a compact set of payment options; it handles wiring to Stripe and native pay flows for you.
LearmondPayButtons(
publishableKey: 'pk_test_...',
clientSecret: 'pi_..._secret_...',
merchantId: 'merchant.com.example',
merchantName: 'My Shop',
merchantInfo: 'Order 1234',
summaryItems: [
SummaryLineItem(label: 'Subtotal', amountCents: 1000),
SummaryLineItem(label: 'Tax', amountCents: 80),
],
amount: '10.80',
onResult: (res) {
// handle result
},
)
Individual Buttons #
Use per-button widgets for custom layout and styling.
Programmatic: Payment sheet #
Show the full Stripe-based sheet (webview) programmatically:
final result = await LearmondPaySheet.show(
context: context,
publishableKey: 'pk_test...',
clientSecret: 'pi_..._secret_...',
amount: '10.00',
merchantArgs: buildMerchantArgs(...),
);
Programmatic: Native pay #
Call the native bridge to present Apple/Google Pay directly and receive a token/result:
final res = await LearmondNativePay.showNativePay({
'method': 'google_pay',
'amountCents': 1000,
'currency': 'USD',
'gatewayMerchantId': 'yourGatewayMerchantId',
});
Merchant args #
Use buildMerchantArgs or buildMerchantArgsFromAmount to construct the merchant arguments map. A SummaryLineItem is a simple model:
final item = SummaryLineItem(label: 'Subtotal', amountCents: 1000);
buildMerchantArgsFromAmount(amount: '10.00', ...) converts dollars to cents and can generate a default summary item.
Example app #
The example/ directory contains a working integration and a merchant-args editor. Run it to preview the SDK behavior:
cd example
flutter run
Development & testing #
Useful commands:
# Format
dart format .
# Static analysis
flutter analyze
# Tests
flutter test
Troubleshooting #
- Use
dart fix --applyto apply automatic suggestions. - If Android manifest/resource merge issues occur, check for duplicated dependencies (e.g.,
play-services-wallet) declared by both the app and the plugin. - If native pay buttons appear visually incorrect, check your app layout wrappers; the SDK provides consistent sizing but extra parent constraints can alter appearance.
Contributing #
Contributions and bug reports welcome. Please use the example/ app to reproduce UI issues and include steps in PRs.
License #
MIT
Author #
The Learmond Corporation